Flutter数据处理与功能封装插件functional_data的使用

functional_data 是一个简单的、非侵入式的代码生成器，用于为数据类型生成样板代码。该包为每个类生成一个简单的mixin，其中包含 operator==、hashCode、copyWith、toString 以及lenses。

Boiler plate（样板代码）

由于样板代码是作为一个mixin生成的，因此对类的接口影响最小。你只需要提供一个带有所有字段命名参数的构造函数，并扩展生成的mixin即可。

@FunctionalData()
class Person extends _$Person {
  final String name;
  final int age;

  const Person({this.name, this.age});

  const Person.anonymous() : this(name: "John Doe", age: null);

  int get ageInDays => 356 * age;
}

这种设计使你完全控制类。例如，你可以像平时一样添加命名构造函数或方法。

使用

要使用 functional_data，请将以下依赖项添加到你的包中：

dependencies:
  functional_data:

dev_dependencies:
  build_runner:
  functional_data_generator:

然后运行 flutter packages pub run build_runner build lib 来生成代码。

Lenses（透镜）

对于每个类，都会为所有字段生成透镜，允许查看字段或创建具有某种方式修改的字段的新实例。例如，Person 的 name 的透镜是 Person$.name。要将透镜聚焦于特定实例，请使用其 of 方法：

final teacher = Person(name: "Arthur", age: 53);

print(Person$.name.of(teacher).value);
// -> "Arthur"

print(Person$.age.of(teacher).update(60));
// -> Person(name: "Arthur", age: 60)

print(Person$.name.of(teacher).map((name) => name.toUpperCase()));
// -> Person(name: "ARTHUR", age: 53)

当组合透镜时，它的强大之处就显现出来了。它允许你轻松地创建一个大型嵌套数据结构的副本，并修改其中一个叶节点的字段。两个透镜可以使用 then 进行链式调用。

class Course extends _$Course {
  final String name;
  final List<Person> students;

  const Course({this.students});
}

final programming = Course(
  name: "Programming 101",
  students: [
    Person(name: "Jane", age: 21),
    Person(name: "Tom", age: 20)
  ]
);

final firstStudentsName = Course$.students.then(List$.first<Person>()).then(Person$.name);

print(firstStudentsName.of(programming).update("Marcy"));
// -> Course(students: [Person(name: "Marcy", age: 21), Person(name: "Tom", age: 20)])

相比之下，不使用透镜的方式如下：

final firstStudent = programming.students.first;
final updatedFirstStudent = Person(name: "Marcy", age: firstStudent.age);
final updatedStudents = [updatedFirstStudent] + programming.students.skip(1);
final updatedCourse = Course(name: programming.name, students: updatedStudents);

这种方式更难以阅读且容易出错。想象一下当其中一个类增加了一个字段时会发生什么。

完整示例

// lens.dart
import 'package:collection/collection.dart';
import 'package:functional_data/functional_data.dart';

part 'lens.g.dart';

@FunctionalData()
class Foo extends _$Foo {
  final int number;
  final String name;

  const Foo({this.number, this.name});
}

@FunctionalData()
class Bar extends _$Bar {
  final Foo foo;

  @CustomEquality(DeepCollectionEquality())
  final List<Foo> foos;

  final String driver;

  const Bar({this.foo, this.foos, this.driver});
}

void main() {
  final foo = Foo(number: 42, name: "Marvin");
  final bar = Bar(
    foo: foo,
    foos: [
      Foo(number: 101, name: "One"),
      Foo(number: 102, name: "Two")
    ],
    driver: "One"
  );

  final fooName = Bar$.foo.then(Foo$.name);
  print(fooName.of(bar).map((name) => name.toUpperCase()));
  // Bar(foo: Foo(number: 42, name: MARVIN), foos: [Foo(number: 101, name: One), Foo(number: 102, name: Two)], driver: One)

  final firstFooName = Bar$.foos.then(List$.atIndex<Foo>(0)).then(Foo$.name);
  print(firstFooName.of(bar).update("Twee"));
  // Bar(foo: Foo(number: 42, name: Marvin), foos: [Foo(number: 101, name: Twee), Foo(number: 102, name: Two)], driver: One)

  final nameOfFooNamedTwo = Bar$.foos.then(List$.where<Foo>((foo) => foo.name == "Two")).then(Foo$.name);
  print(nameOfFooNamedTwo.update(bar, "Due"));
  // Bar(foo: Foo(number: 42, name: Marvin), foos: [Foo(number: 101, name: One), Foo(number: 102, name: Due)], driver: One)

  final driversNumber = Bar$.foos.thenWithContext((bar) => List$.where<Foo>((foo) => foo.name == bar.driver).then(Foo$.number));
  print(driversNumber.of(bar).value);
  // 101
}

代码生成配置

类级别配置

可以通过向 @FunctionalData 发送参数来指定应为类生成哪些功能。

@FunctionalData(
  generateCopy: false,
  generateLenses: false,
)
class Foo extends _$Foo {}

项目级别配置

可以通过在项目的根目录下创建一个名为 functional_data_options.yaml 的文件来指定应为整个项目生成哪些功能。类级别的参数将覆盖项目级别的配置。

generateCopyWith: false
generateCopyUsing: false
generateLenses: false

通过这些配置，你可以灵活地控制生成的代码，以满足项目的需求。