Flutter数据类生成插件dataclass的使用

Flutter数据类生成插件dataclass的使用

欢迎使用Freezed的宏版本！这个工具已经重命名为dataclass，以便用户可以同时使用build_runner和宏。

这是一个工具，它会自动生成toString、copyWith（包括copyWith(field: null)）、hashCode、==等方法。

请注意，这是关于当宏在Dart中落地时Freezed会是什么样子的一个非常早期的概念验证。由于许多宏特性缺失，很多Freezed特性都缺失或损坏。请自行承担风险使用 ：)

安装

要开始使用Freezed的宏版本：

1. 确保你使用的Dart版本 >= 3.5.0-dev
2. 在你的analysis_options.yaml中启用macros如下所示：

   # analysis_options.yaml
   analyzer:
     enable-experiment:
       - macros
   

3. 安装Freezed >= 3.0.0：

   name: your_app
   environment:
     sdk: ">=3.5.0-0.0-dev <4.0.0"
   
   dependencies:
     # Freezed现在是一个"dependencies"。
     # freezed_annotation不再需要
     dataclass: ^3.0.0-0.0.dev
   

使用

支持两种可能的语法：

1. 构造函数优先。你定义一个带有构造函数的类，而宏会为你生成字段。这让你对位置参数与命名参数有精细控制。它可以使用断言、super等。虽然宏还有很多与此相关的问题尚未解决。所以尽管语法非常灵活，但很多东西还不支持。
2. 字段优先。你定义一个带有字段的类，而宏会为你生成构造函数。这是最稳定的语法，但它不太灵活，也不太符合Dart风格。如果你想要完全控制构造函数，则必须使用构造函数优先的语法。

构造函数优先用法

要使用构造函数优先的语法，定义一个带有构造函数但没有字段的类：

[@Data](/user/Data)()
class Example {
  Example({required int foo, required String bar});
}

宏会为你生成字段以及各种方法。

void main() {
  final example = Example(foo: 42, bar: '42');
  print(example.foo); // 42
}

使用命名构造函数

当然，宏期望你使用默认构造函数。如果你想根据命名构造函数生成字段，请指定[@Data](/user/Data)(constructor: '<constructor name>')。

[@Data](/user/Data)(constructor: 'custom')
class Example {
 Example.custom({required int foo, required String bar});
}

字段优先用法

要使用字段优先的语法，定义一个带有字段但默认构造函数的类。宏会为你生成构造函数以及各种方法。

[@Data](/user/Data)()
class Example {
 final int foo;
 final String bar;
}

目前，所有字段都是“命名”参数，并且如果它们是可空的，则是可选的。

void main() {
 final example = Example(foo: 42, bar: '42');
 print(example.foo); // 42
}

指定构造函数名称

如果你想生成非默认构造函数，可以指定[@Data](/user/Data)(constructor: '<constructor name>')。

[@Data](/user/Data)(constructor: 'custom')
class Example {
  final int foo;
}

void main() {
  final example = Example.custom(foo: 42);
}

特性

示例代码

// ignore_for_file: avoid_unused_constructor_parameters

import 'package:dataclass/dataclass.dart';

// 常规语法，基于构造函数。
// 我们不再使用"factory"构造函数。
[@Data](/user/Data)()
class Person {
  Person(
    String name, {
    required int age,
  });
}

// 另外，你可以通过字段定义类：

[@Data](/user/Data)()
class Person2 {
  final String name;
  final int age;
}

void main() {
  var person = Person('John', age: 30);
  person = person.copyWith(age: 31);

  print(person.name); // John
  print(person.age); // 31

  // Person2的工作方式相同！
  var person2 = Person2(name: 'John', age: 30);
  person2 = person2.copyWith(age: 31);
}

// ---- 高级用法：联合 ----

class Engine {}

[@Data](/user/Data)()
sealed class Vehicle {
  final Engine engine;
}

[@Data](/user/Data)()
class Plane implements Vehicle {
  final Wing wing;

  // 目前由于增强库尚未完全实现，这是必要的。
  // 这在未来将不需要。
  [@override](/user/override)
  final Engine engine;
}

class Wing {}

[@Data](/user/Data)()
class Car implements Vehicle {
  final Wheel wheel;

  [@override](/user/override)
  final Engine engine;
}

class Wheel {}