Flutter内存注解插件dart_mem_annotation的使用

Dart Model Entity Mapper (MEM) 注解

Mem Annotation Generator 是一个代码生成插件，用于基于注解生成模型、实体和映射。此包旨在防止逐个添加额外的代码来创建模型、实体和映射。你可以将其用于模型、API 和 JSON。

目录

• 入门
• 使用
• 选项
  • 一些示例
• 文档
• 关于作者
• 包和依赖项
• 测试

入门

在 pubspec.yaml 文件中添加依赖：

dependencies:
  dart_mem_annotation: ^latest

  # 如果需要 Freezed 代码生成：
  freezed: ^2.5.7
  json_annotation: ^4.9.0

dev_dependencies:
  build_runner: ^latest
  dart_mem_annotation_generator: ^latest

  # 如果需要 Freezed 代码生成：
  freezed_annotation: ^2.4.4
  json_serializable: ^6.8.0

生成库链接在 pub.dev 上：

通过以下命令获取更改：

flutter pub get

或者

dart pub get

使用

导入注解：

import 'package:dart_mem_annotation/annotation.dart';

对于生成的代码，需要在 Dart 文件顶部提供 part 指令：

part 'some_file.mem.dart';

在所需类的顶部添加所需的注解，并设置所需的选项。内嵌类也是支持的。

例如：

part 'some_file.mem.dart';

[@Mem](/user/Mem).all()
class SomeClass {
  SampleEnum? sampleEnum;
  String? name;
  String? description;
  InnerSample? innerClass;
  List<String>? sampleList;
  List<InnerSample>? innerSampleList;
}

[@Mem](/user/Mem).all(withFreezed: true)
class SomeInnerClass {
  const InnerSample({this.name, this.description});
  final String? name;
  final String? description;
}

注意

重要的是，如果 Freezed 类包含内嵌类，则所有内嵌类都将生成模型、实体和映射；如果不这样设置，类本身将用于主类。

然后你需要运行 build_runner 来生成代码并创建相关文件。可以使用以下命令：

dart pub run build_runner build --delete-conflicting-outputs

所有文件将以 *.mem.dart 格式生成。

你可以在 /example 中检查更完整的示例，更多细节和进一步信息。

选项

你可以在 @Annotation 中设置一些注解及其选项。 可用的注解：

• [@Mem](/user/Mem).all：将生成所有选项，包括模式、实体和映射。

可用的选项：

• [@Mem](/user/Mem)
  • as：更改依赖项中的页面名称，并使用另一个名称。
  • withFreezed：所有生成的类将装饰 @freezed 注解，并且所有 Freezed 类将在 Mem 代码生成后生成。
  • extendsBaseClass：（不推荐） - 生成的类将扩展原始注解类，而没有此选项，所有类将是独立的。

注意

所有带有 Freezed 注解的类（如果标记 withFreezed 为真）应该提供自己的部分。

part '*filename*.mem.dart'; // For Meme Generator
part '*filename*.freezed.dart'; // For Freezed
part '*filename*.g.dart'; // For JsonSerializable with Freezed

文档

关于作者

Resam Taghipour

包和依赖项

许可证

该项目受 'BSD-3-Clause' 许可证保护 - 详情请参阅 LICENSE。

示例代码

import 'package:flutter/material.dart';

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:dart_mem_annotation/annotation.dart';
import 'package:json_annotation/json_annotation.dart';

part 'main.mem.dart';
part 'main.freezed.dart';
part 'main.g.dart';

void main() {
  runApp(const MainApp());
}

enum SampleEnum {
  isEnum,
  notEnum,
}

[@Mem](/user/Mem).all()
class Sample {
  SampleEnum? sampleEnum;
  String? name;
  String? description;
  InnerSample? innerClass;
  List<String>? sampleList;
  List<InnerSample>? innerSampleList;
}

[@Mem](/user/Mem).all(withFreezed: true)
class InnerSample {
  const InnerSample({this.name, this.description});
  final String? name;
  final String? description;
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'App Name',
    );
  }
}