Dart中如何让UserModel实例同步同类型另一实例的全部字段？

针对你遇到的新增字段时忘记同步updateUser方法的问题，这里提供几个无需替换实例的优雅方案：

方案1：基于Map的序列化更新（手动/自动生成） #

通过将实例转为Map再反向映射到当前实例，新增字段时只需维护序列化方法即可，避免逐个赋值的繁琐。

手动实现 #

class UserModel {
  String name, surname;

  UserModel({required this.name, required this.surname});

  // 将实例转为Map
  Map<String, dynamic> toMap() {
    return {
      'name': name,
      'surname': surname,
      // 新增字段时只需要在这里添加对应键值对
    };
  }

  // 从Map更新当前实例
  void fromMap(Map<String, dynamic> map) {
    name = map['name'] as String;
    surname = map['surname'] as String;
    // 新增字段时同步添加赋值逻辑
  }

  void updateUser(final UserModel newInstance) {
    fromMap(newInstance.toMap());
  }
}

自动生成（使用json_serializable） #

如果项目已经使用json_serializable，可以直接利用自动生成的序列化方法，避免手动编写Map转换逻辑：

首先在pubspec.yaml添加依赖：

dependencies:
  json_annotation: ^4.8.1
dev_dependencies:
  build_runner: ^2.4.4
  json_serializable: ^6.7.0

修改UserModel：

import 'package:json_annotation/json_annotation.dart';

part 'user_model.g.dart';

@JsonSerializable()
class UserModel {
  String name, surname;

  UserModel({required this.name, required this.surname});

  // 自动生成的fromJson方法
  factory UserModel.fromJson(Map<String, dynamic> json) => _$UserModelFromJson(json);
  // 自动生成的toJson方法
  Map<String, dynamic> toJson() => _$UserModelToJson(this);

  void updateUser(final UserModel newInstance) {
    final json = newInstance.toJson();
    name = json['name'] as String;
    surname = json['surname'] as String;
    // 新增字段时，json_serializable会自动在toJson/fromJson中处理，这里只需同步添加赋值
  }
}

运行命令生成代码：

flutter pub run build_runner build

方案2：使用Reflectable反射库 #

通过反射自动遍历并更新所有实例字段，新增字段时无需修改updateUser方法，完全自动同步。

1. 添加依赖：

dependencies:
  reflectable: ^4.0.5
dev_dependencies:
  build_runner: ^2.4.4

2. 创建反射配置文件（user_reflectable.dart）：

import 'package:reflectable/reflectable.dart';

class UserReflectable extends Reflectable {
  const UserReflectable() : super(
    instanceInvokeCapability,
    declarationsCapability,
    fieldCapability,
  );
}

const userReflectable = UserReflectable();

3. 修改UserModel：

import 'user_reflectable.dart';

@userReflectable
class UserModel {
  String name, surname;

  UserModel({required this.name, required this.surname});

  void updateUser(final UserModel newInstance) {
    final currentMirror = userReflectable.reflect(this);
    final newMirror = userReflectable.reflect(newInstance);
    final classMirror = currentMirror.type;

    // 遍历所有非静态、非final的实例字段
    for (final decl in classMirror.declarations.values) {
      if (decl is VariableMirror && !decl.isStatic && !decl.isFinal) {
        final fieldName = decl.simpleName;
        currentMirror.setField(fieldName, newMirror.getField(fieldName));
      }
    }
  }
}

4. 运行命令生成反射代码：

flutter pub run build_runner build

优点：新增字段完全无需修改updateUser方法，自动同步；缺点：引入反射依赖，需要维护反射配置，性能略低于手动赋值（日常使用可忽略）。

方案3：自定义代码生成（适合大型项目） #

如果项目有大量类似需求，可以编写自定义的Build Runner生成器，自动为UserModel生成updateUser方法。这种方案完全自动化，但需要编写代码生成逻辑，适合团队协作的大型项目。

内容的提问来源于stack exchange，提问作者Emilio Dalla Torre