Dart中如何获取类内所有已声明变量并检查是否为空？

当然可以啦！在Dart里我们有几种不同的方案来实现这个需求，我会根据不同的使用场景给你详细说明～

方案1：使用Dart反射库 dart:mirrors（适合非Flutter项目） #

如果你是在Dart CLI或者非Flutter的环境下开发，dart:mirrors反射库可以帮你轻松获取类的所有实例变量，进而逐一检查是否为null。

代码示例 #

import 'dart:mirrors';

// 定义一个示例类
class User {
  String? name;
  int? age;
  bool? isActive;
  String email = "default@example.com"; // 非nullable变量
}

// 检查实例所有变量是否为null的函数
void checkAllVariablesForNull(Object instance) {
  // 获取实例的镜像对象
  final instanceMirror = reflect(instance);
  // 获取类的镜像对象
  final classMirror = instanceMirror.type;

  // 遍历类的所有声明，筛选出实例变量
  for (final declaration in classMirror.declarations.values) {
    // 只处理非静态的实例变量
    if (declaration is VariableMirror && !declaration.isStatic) {
      final variableName = MirrorSystem.getName(declaration.simpleName);
      // 获取变量的实际值
      final variableValue = instanceMirror.getField(declaration.simpleName).reflectee;

      // 检查并输出结果
      if (variableValue == null) {
        print("变量 $variableName 的值为null");
      } else {
        print("变量 $variableName 的值为: $variableValue");
      }
    }
  }
}

void main() {
  final user = User();
  user.name = "Alice";
  checkAllVariablesForNull(user);
}

关键说明 #

• reflect(instance)：获取目标实例的镜像，通过它可以访问实例的所有属性和方法。
• classMirror.declarations：包含类的所有声明（变量、方法、静态成员等），我们需要筛选出VariableMirror类型且非静态的成员，也就是实例变量。
• getField()：通过变量的镜像获取实例中该变量的实际值。

注意事项 #

• Flutter项目慎用：dart:mirrors在Flutter的Release模式下是被禁用的，因为Flutter为了性能优化会移除反射相关的代码。
• 反射会带来一定的性能开销，如果是对性能要求极高的场景，建议考虑其他方案。

方案2：Flutter环境下的替代方案 #

由于Flutter不支持Release模式下的反射，这里给你两种实用的替代方案：

子方案A：手动维护变量列表（简单直接） #

如果你的类结构比较稳定，不会频繁新增变量，手动维护一个变量列表是最省心的方式：

class User {
  String? name;
  int? age;
  bool? isActive;
  String email = "default@example.com";

  // 手动定义需要检查的变量键值对
  Map<String, dynamic?> get variablesToCheck => {
        'name': name,
        'age': age,
        'isActive': isActive,
        'email': email,
      };
}

// 检查变量的函数
void checkVariables(User user) {
  for (final entry in user.variablesToCheck.entries) {
    if (entry.value == null) {
      print("变量 ${entry.key} 的值为null");
    } else {
      print("变量 ${entry.key} 的值为: ${entry.value}");
    }
  }
}

void main() {
  final user = User();
  user.name = "Bob";
  checkVariables(user);
}

优点：实现简单，性能无损耗；缺点：类新增变量时需要手动更新列表，容易遗漏。

子方案B：借助代码生成库（自动维护变量列表） #

如果你已经在使用json_serializable或者freezed这类代码生成库，可以利用它们自动生成的代码来获取所有变量，避免手动维护的麻烦。

这里以json_serializable为例：

1. 首先在pubspec.yaml中添加依赖：

dependencies:
  json_annotation: ^4.8.1

dev_dependencies:
  build_runner: ^2.4.4
  json_serializable: ^6.7.0

2. 定义类并添加注解：

import 'package:json_annotation/json_annotation.dart';

// 生成的代码会放在这个文件里
part 'user.g.dart';

@JsonSerializable()
class User {
  String? name;
  int? age;
  bool? isActive;
  String email = "default@example.com";

  User();

  // 自动生成的序列化/反序列化方法
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

3. 运行代码生成命令：

dart run build_runner build

4. 利用生成的toJson()方法检查变量：

void checkVariablesWithJson(User user) {
  final jsonMap = user.toJson();
  for (final entry in jsonMap.entries) {
    if (entry.value == null) {
      print("变量 ${entry.key} 的值为null");
    } else {
      print("变量 ${entry.key} 的值为: ${entry.value}");
    }
  }
}

void main() {
  final user = User();
  user.age = 30;
  checkVariablesWithJson(user);
}

优点：新增变量时只需重新生成代码，无需手动维护列表；缺点：需要引入额外的库，有一定的配置成本。

总结 #

• 非Flutter项目：优先使用dart:mirrors反射方案，便捷高效；
• Flutter项目：根据类结构的稳定性选择手动维护列表或代码生成方案，避免使用反射。

内容的提问来源于stack exchange，提问作者nivla360