Flutter中使用reflectable包获取类成员元数据构建动态表单

核心配置修正 #

首先确保反射器、注解类和目标类的配置符合reflectable的要求：

1. 完善Reflector类
   必须添加metadataCapability才能读取成员元数据，否则无法获取注解信息：

class Reflector extends Reflectable {
  const Reflector() : super(
    declarationsCapability,
    metadataCapability, // 关键：启用元数据读取能力
    typeRelationsCapability,
  );
}

const reflector = Reflector();

2. 注解类与表单类标记
   给DynamicFieldAttribute和FormDeclaration都加上@reflector注解，确保reflectable能扫描到它们：

@reflector
class DynamicFieldAttribute {
  final int order;
  final String label;

  const DynamicFieldAttribute({required this.order, required this.label});
}

@reflector
class FormDeclaration {
  @DynamicFieldAttribute(order: 2, label: "邮箱")
  String? email;

  @DynamicFieldAttribute(order: 1, label: "用户名")
  String? username;

  @DynamicFieldAttribute(order: 3, label: "密码")
  String? password;
}

读取元数据并排序 #

通过反射镜像遍历成员，提取元数据后按order字段排序：

void processFormFields() {
  // 获取FormDeclaration的类反射镜像
  final classMirror = reflector.reflectType(FormDeclaration) as ClassMirror;
  
  // 存储成员与对应元数据的列表
  final fieldList = <(VariableMirror, DynamicFieldAttribute)>[];

  // 遍历所有类声明，筛选实例变量并提取元数据
  for (final declaration in classMirror.declarations.values) {
    if (declaration is VariableMirror) {
      // 找到对应的DynamicFieldAttribute注解
      final meta = declaration.metadata.firstWhere(
        (m) => m is DynamicFieldAttribute,
        orElse: () => null,
      ) as DynamicFieldAttribute?;

      if (meta != null) {
        fieldList.add((declaration, meta));
      }
    }
  }

  // 按注解的order字段升序排序
  fieldList.sort((a, b) => a.$2.order.compareTo(b.$2.order));

  // 输出排序后的结果（可用于构建动态表单）
  for (final (field, meta) in fieldList) {
    print("排序${meta.order} - 字段名：${field.simpleName} - 标签：${meta.label}");
  }
}

常见问题排查 #

• 若无法读取元数据：检查是否给注解类加了@reflector，以及Reflector是否包含metadataCapability
• 若私有成员无法被扫描：在Reflector的super构造中添加privateMembersCapability
• 若排序失效：确认order参数是整数类型，且排序逻辑正确

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