Flutter插件eyflutter_gen的使用方法

eyflutter_gen 介绍

eyflutter_gen 是一个用于生成数据库模型的工具。它可以帮助开发者快速生成与数据库相关的模型类，从而简化开发流程并减少手动编码的工作量。

Getting Started

这个项目是一个起点，为 Flutter 提供了一个插件包，该插件包包括针对 Android 和/或 iOS 的平台特定实现代码。通过使用 eyflutter_gen，开发者可以轻松地从现有的数据库表结构生成对应的 Dart 模型类。

如何开始

要开始使用 eyflutter_gen，首先需要确保你已经安装了 Flutter 和 Dart 环境，并且有一个支持的数据库（例如 SQLite 或其他数据库）。接下来，你需要配置插件并运行生成命令。

示例代码

以下是一个完整的示例，展示如何使用 eyflutter_gen 来生成数据库模型。

1. 添加依赖

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

dependencies:
  eyflutter_gen: ^1.0.0

dev_dependencies:
  build_runner: ^2.0.0

然后执行以下命令以安装依赖：

flutter pub get

2. 创建数据库表定义文件

假设我们有一个 SQLite 数据库，包含以下表结构：

CREATE TABLE user (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    name TEXT NOT NULL,
    age INTEGER NOT NULL
);

我们需要将此表结构描述为 Dart 对象。创建一个名为 database_schema.dart 的文件：

// database_schema.dart
class User {
  final int id;
  final String name;
  final int age;

  User({required this.id, required this.name, required this.age});
}

3. 配置生成器

创建一个配置文件 gen_config.json，用于指定生成规则：

{
  "outputDir": "lib/models",
  "models": [
    {
      "tableName": "user",
      "modelClass": "User"
    }
  ]
}

• outputDir：指定生成的模型文件存放的目录。
• models：定义需要生成的表及其对应的模型类。

4. 运行生成命令

在终端中运行以下命令以生成模型类：

flutter packages pub run build_runner build

这将在 lib/models 目录下生成对应的模型类文件。

5. 查看生成的模型类

生成的模型类类似于以下内容：

// lib/models/user.g.dart
import 'package:json_annotation/json_annotation.dart';

part of 'user.dart';

[@JsonSerializable](/user/JsonSerializable)()
class User {
  final int id;
  final String name;
  final int age;

  User({required this.id, required this.name, required this.age});

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}