跨平台开发 / 系统课时
保留自定义方法与 getter
保留自定义方法与 getter
Freezed 擅长生成不可变字段、copyWith、相等比较和 JSON 代码,但模型仍可能需要派生 getter、轻量校验与格式化方法。本节用一个用户资料模型说明怎样保留这些手写行为,并划清数据模型与领域逻辑的边界。
学习目标
- 使用私有空构造函数,让 Freezed 生成类能够继承自定义 getter 与方法。
- 为模型加入只依赖自身字段的派生属性、轻量校验和格式化逻辑。
- 判断哪些行为适合留在数据模型,哪些应移动到领域服务或用例层。
为什么直接加方法可能失败
Freezed 的主构造器由 factory 声明,生成类默认更接近“实现接口”的方式工作。若模型里直接加入实例 getter 或方法,生成类可能没有继承这些成员,从而在生成或编译阶段出现缺少实现的错误。
解决关键只有一行:在 Freezed 类中加入无参数的私有构造函数 const UserProfile._();。这样生成实现会继承原类,自定义实例成员也会随对象一起可用。这个构造函数不承载业务参数,实际数据仍由 const factory UserProfile(...) 定义。
在模型中加入派生行为
下面是片段示例,文件为 lib/user_profile.dart。它依赖项目已经安装并配置 freezed_annotation、freezed、json_annotation、json_serializable 与 build_runner,生成文件由后续命令创建。
import 'package:freezed_annotation/freezed_annotation.dart';
part 'user_profile.freezed.dart';
part 'user_profile.g.dart';
@freezed
abstract class UserProfile with _$UserProfile {
// 让生成实现继承本类,从而保留下面的 getter 与方法。
const UserProfile._();
const factory UserProfile({
required String firstName,
required String lastName,
required String email,
@Default(false) bool suspended,
}) = _UserProfile;
factory UserProfile.fromJson(Map<String, dynamic> json) =>
_$UserProfileFromJson(json);
String get displayName {
final fullName = '$firstName $lastName'.trim();
return fullName.isEmpty ? email : fullName;
}
bool get hasUsableEmail {
final at = email.indexOf('@');
return at > 0 && at < email.length - 1;
}
String maskedEmail() {
final at = email.indexOf('@');
if (at <= 1) return email;
return '${email[0]}***${email.substring(at)}';
}
}这里的三个行为都有共同特征:只读取当前对象字段、执行结果确定、不访问网络或数据库。displayName 是派生属性,hasUsableEmail 是轻量结构检查,maskedEmail() 是展示格式化。它们不会成为新的 JSON 字段;序列化仍以工厂构造函数中的数据字段为准。
生成并验证行为没有丢失
先执行代码生成,再用一个测试确认 getter 和方法确实存在。测试文件 test/user_profile_test.dart 如下。
import 'package:flutter_test/flutter_test.dart';
import 'package:your_app/user_profile.dart';
void main() {
test('keeps custom getters and methods', () {
const profile = UserProfile(
firstName: 'Ada',
lastName: 'Lovelace',
email: 'ada@example.com',
);
expect(profile.displayName, 'Ada Lovelace');
expect(profile.hasUsableEmail, isTrue);
expect(profile.maskedEmail(), 'a***@example.com');
});
}把 your_app 改成当前项目的包名,然后执行:
dart run build_runner build --delete-conflicting-outputs
flutter test test/user_profile_test.dart预期结果
生成步骤正常结束,并创建或更新 user_profile.freezed.dart 与 user_profile.g.dart。
<TIME> +1: All tests passed!<TIME> 会随机器与项目规模变化。若生成阶段提示自定义成员缺少实现,优先检查私有构造函数是否写在同一个 Freezed 类中,以及是否误写成带业务参数的普通构造器。
哪些逻辑应该离开数据模型
把行为放进模型的判断标准不是“代码短不短”,而是它是否属于当前数据本身。字段组合、展示格式、无副作用的派生状态通常适合留在模型中;涉及外部依赖、跨对象规则或业务决策时,应交给领域层。
| 逻辑 | 更合适的位置 |
|---|---|
根据姓名字段得到 displayName |
数据模型 |
| 根据当前邮箱字符串做基本结构检查 | 数据模型 |
| 调用接口确认邮箱是否已注册 | 领域服务或用例层 |
| 根据会员等级、订单、活动规则决定折扣 | 领域层 |
| 从仓库读取其他实体后判断是否允许操作 | 领域服务或用例层 |
保持这条边界后,Freezed 模型既可以拥有有用的自定义行为,又不会逐渐变成同时负责网络、存储和业务流程的“万能对象”。