Flutter功能扩展插件supertypes的使用

安装

要使用supertypes库及其生成器，你需要将其添加到你的pubspec.yaml文件中。以下是具体步骤：

对于Dart项目：

dart pub add supertypes dev:supertypes_generator dev:build_runner

对于Flutter项目：

flutter pub add supertypes dev:supertypes_generator dev:build_runner

接下来，运行build_runner来生成类型：

对于Dart项目：

dart run build_runner build # 构建一次
dart run build_runner watch # 持续构建

对于Flutter项目：

flutter pub run build_runner build # 构建一次
flutter pub run build_runner watch # 持续构建

使用

每个包含超类型的文件必须包含以下内容：

必须以part指令开始

import 'package:supertypes/supertypes.dart';

part 'example.supertypes.dart';

包含一个带有超类型名称的typedef，并以$或_$为前缀

// 生成一个名为`Example`的公共记录
[@superType](/user/superType)
typedef $Example = ();

// 生成一个名为`_Example`的私有记录
[@superType](/user/superType)
typedef _$Example = ();

索引

• 修饰类型

  • Partial
  • WithPartial
  • Required
  • WithRequired
  • Omit
    • 省略位置字段
  • Pick
    • 选择位置字段
  • Merge

• 在另一个超类型内使用超类型

修饰类型

修饰类型是接受一个或多个类型并返回新类型的类型。

Partial

Partial修饰类型接受一个类型，并使其所有字段可选。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String lastName,
  int age,
});

// 我们想让所有字段可选以支持部分更新
[@superType](/user/superType)
typedef $UpdatePerson = Partial<Person>;

// 这将生成：
typedef UpdatePerson = ({
  String? firstName,
  String? lastName,
  int? age,
});

WithPartial

WithPartial修饰类型接受一个类型和一个字段列表，使这些字段可选。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  int id,
  String firstName,
  String lastName,
  int age,
});

// 我们想让`id`字段可选
[@superType](/user/superType)
typedef $PersonWithNullableId = WithPartial<Person, ({Partial id})>;

// 这将生成：

/// 生成 `$PersonWithNullableId`
typedef PersonWithNullableId = ({
  int? id,
  String firstName,
  String lastName,
  int age,
});

Required

Required修饰类型接受一个类型，并使其所有字段必填。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

// 假设我们有一个`Person`类型，其中`lastName`字段可选，
// 并且我们不能轻松地更新该类型。
// 我们可以创建一个新的类型，使所有字段必填。
typedef Person = ({
  String firstName,
  String? lastName,
  int age,
});

// 我们想让所有字段可选以支持部分更新
[@superType](/user/superType)
typedef $CreatePerson = Required<Person>;

// 这将生成：
typedef CreatePerson = ({
  String firstName,
  String lastName,
  int age,
});

WithRequired

WithRequired修饰类型接受一个类型和一个字段列表，使这些字段必填。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String? lastName,
  int age,
});

// 我们想让`lastName`字段必填
[@superType](/user/superType)
typedef $PersonWithRequiredLastName = WithRequired<Person, ({Required lastName})>;

// 这将生成：
typedef PersonWithRequiredLastName = ({
  String firstName,
  String lastName,
  int age,
});

Omit

Omit修饰类型接受一个类型和一个字段列表，从类型中省略这些字段。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String lastName,
  int age,
});

// 我们想省略`age`字段
[@superType](/user/superType)
typedef $PersonWithoutAge = Omit<Person, ({Omit age})>;

// 这将生成：

/// 生成 `$PersonWithoutAge`
typedef PersonWithoutAge = ({
  String firstName,
  String lastName,
});

省略位置字段

还可以省略位置字段。例如：

typedef Person = (String name, int age);

// 我们想省略第一个位置字段
[@superType](/user/superType)
typedef $Age = Omit<Person, (Omit,)>;
// 这将省略第一个位置字段

// 这将省略第二个位置字段。
// 我们使用`Pick`作为第一个位置字段的占位符。
[@superType](/user/superType)
typedef $Name = Omit<Person, (Pick, Omit)>;

// 这将生成：

/// 生成 `$Age`
typedef Age = (int,);

/// 生成 `$Name`
typedef Name = (String,);

Pick

Pick修饰类型接受一个类型和一个字段列表，只保留这些字段，忽略其他字段。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String lastName,
  int age,
});

// 我们想省略`age`字段
[@superType](/user/superType)
typedef $PersonWithoutAge = Pick<Person, ({Pick firstName, Pick lastName})>;

// 这将生成：

/// 生成 `$PersonWithoutAge`
typedef PersonWithoutAge = ({
  String firstName,
  String lastName,
});

你也可以对所选字段应用修饰类型：

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String? firstName,
  String? lastName,
  int age,
});

// 让我们使`age`字段可选，并将`firstName`字段设置为必填
[@superType](/user/superType)
typedef $PersonWithNullableAge = Pick<Person, ({Required firstName, Partial age})>;

// 这将生成：

/// 生成 `$PersonWithNullableAge`
typedef PersonWithNullableAge = ({
  int? age,
  String firstName,
});

选择位置字段

还可以选择位置字段。例如：

typedef Person = (String name, int age);

// 我们想省略第一个位置字段
[@superType](/user/superType)
typedef $Name = Pick<Person, (Pick,)>;
// 这将省略第一个位置字段

// 这将省略第二个位置字段。
// 我们使用`Pick`作为第一个位置字段的占位符。
[@superType](/user/superType)
typedef $Age = Pick<Person, (Omit, Pick)>;

// 这将生成：

/// 生成 `$Name`
typedef Name = (String,);

/// 生成 `$Age`
typedef Age = (int,);

Merge

Merge修饰类型接受两个类型，并将它们合并为一个类型。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String lastName,
  int age,
});

typedef Address = ({
  String street,
  String city,
  String country,
});

// 我们想合并这两个类型
[@superType](/user/superType)
typedef $PersonWithAddress = Merge<Person, Address>;

// 这将生成：

/// 生成 `$PersonWithAddress`
typedef PersonWithAddress = ({
  String firstName,
  String lastName,
  int age,
  String street,
  String city,
  String country,
});

在另一个超类型内使用超类型

超类型可以在其他超类型内使用。这在创建可重用的复杂类型时非常有用。要在另一个超类型中使用超类型，只需使用原始类型，并以$或_$为前缀。

import 'package:supertypes/supertypes.dart';

part 'person.supertypes.dart';

typedef Person = ({
  String firstName,
  String lastName,
  int age,
});

[@superType](/user/superType)
typedef $CreatePerson = Required<Person>;

[@superType](/user/superType)
typedef $UpdatePerson = Partial<Person>;

[@superType](/user/superType)
typedef $PersonOperation = ({
  $CreatePerson create,
  $UpdatePerson update,
});

// 这将生成：

/// 生成 `$CreatePerson`
typedef CreatePerson = ({
  int age,
  String firstName,
  String lastName,
});

/// 生成 `$UpdatePerson`
typedef UpdatePerson = ({
  int? age,
  String? firstName,
  String? lastName,
});

/// 生成 `$PersonOperation`
typedef PersonOperation = ({
  ({
    int age,
    String firstName,
    String lastName,
  }) create,
  ({
    int? age,
    String? firstName,
    String? lastName,
  }) update,
});