在Dart中使用dart_mappable时如何正确处理私有字段？

核心方案 #

用公共构造参数映射私有字段，配合注解明确字段关联逻辑，既能保留自定义setter的业务规则，又能让dart_mappable正常生成序列化和copyWith代码。

正确代码示例 #

import 'package:dart_mappable/dart_mappable.dart';

@MappableClass()
class Person with PersonMappable {
  String _name;

  // 通过公共参数name初始化私有字段_name
  Person({required String name}) : _name = name;

  // 自定义setter，可加入校验或转换逻辑
  set name(String value) {
    if (value.trim().isEmpty) {
      throw ArgumentError('名称不能为空');
    }
    _name = value.trim();
  }

  // 配套getter暴露字段访问
  String get name => _name;

  // 固定的mapper生成入口
  static const fromJson = PersonMapper.fromJson;
}

为什么之前的写法会出错？ #

• 第一种（构造参数调用setter）：dart_mappable生成代码时会直接解析构造参数列表，setter不属于构造参数范畴，导致无法识别自定义参数名，进而引发序列化异常和copyWith功能失效。
• 第二种（this._name作为构造参数）：Dart语法禁止命名参数以下划线开头，生成的mapper代码会违反这一规则，所以抛出"Named parameters can't start with an underscore"错误。

进阶：兼容copyWith与序列化 #

dart_mappable会基于构造参数自动生成copyWith方法，通过公共参数间接修改私有字段，无需额外处理：

void main() {
  var person = Person(name: 'Alice');
  // 用copyWith更新字段，会触发构造函数初始化逻辑
  var updatedPerson = person.copyWith(name: '  Bob  ');
  print(updatedPerson.name); // 输出"Bob"（已被setter处理去空格）
}

特殊场景：私有字段直接关联JSON字段 #

如果私有字段需要直接对应JSON中的某个key，可通过@MappableField注解指定映射关系：

@MappableClass()
class Person with PersonMappable {
  @MappableField(key: 'user_name') // 指定JSON中的字段名为user_name
  String _name;

  Person({required String name}) : _name = name;

  // ... getter和setter逻辑
}

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