Flutter功能描述插件loquacious的使用

Flutter功能描述插件loquacious的使用

loquacious 是一个灵感来源于Laravel Eloquent的Flutter ORM。

该包建立在 sqflite 包之上。

特性：

• 数据库管理器（迁移）
• 查询构建器
• 基于生成模型的对象关系映射

安装

在 pubspec.yaml 文件中：

dependencies:
  ...
  loquacious: <last_version>

dev_dependencies:
  ...
  craftsman: <last_version>

flutter:
  ...
  assets:
  ... 
  - assets/loquacious/migrations/

文档索引

1. 使用craftsman
2. 生成第一个描述文件
3. 运行craftsman scaffold
4. 开始使用Loquacious
5. 使用Loquacious查询构建器
6. 使用Loquacious ORM

使用craftsman

craftsman 包是用于文件生成和脚手架的Loquacious工具。

虽然不是必需的，但强烈建议使用 craftsman，因为它可以帮助你生成复杂的生成文件。

例如，使用ORM功能需要生成模型类，这将是一个非常繁琐且容易出错的任务。但是，使用 craftsman 可以使其变得简单直接。

生成第一个描述文件

运行命令 flutter pub run craftsman:descriptor 并根据控制台指示生成描述文件。

描述文件定义了两种不同的脚手架描述类型：

• db 类型，用于生成迁移文件
• orm 类型，用于生成模型

生成描述文件后，你应该在 craftsman/descriptor 中有一个名为你输入版本的JSON文件，类似于以下模板：

{
  "db": {
    "version": 1,
    "migrations": [
      {
        "create_table": {
          "name": "TABLE_NAME",
          "columns": [
            {
              "name": "id",
              "type": "integer",
              "index": "primary"
            },
            "timestamps"
          ]
        }
      }
    ]
  },
  "orm": {
    "create_models": [
      {
        "entity": "MODEL_NAME",
        "from_migration_table": "TABLE_NAME"
      }
    ]
  }
}

然后你可以填充你的架构设置，例如：

{
  "db": {
    "version": 1,
    "migrations": [
      {
        "create_table": {
          "name": "users",
          "columns": [
            {
              "name": "id",
              "type": "integer",
              "index": "primary"
            },
            {
              "name": "username",
              "type": "text"
            },
            {
              "name": "password",
              "type": "text"
            },
            "timestamps"
          ]
        }
      }
    ]
  },
  "orm": {
    "create_models": [
      {
        "entity": "user",
        "from_migration_table": "users"
      }
    ]
  }
}

运行craftsman scaffold

填充描述文件后，你需要运行命令 flutter pub run craftsman:scaffold。

此命令会基于描述文件生成一些文件。

如果你在 db.migrations 数组中插入了一个或多个对象，将会在 assets/loquacious/migrations 文件夹中生成一个JSON文件，文件名为你在 db.version 属性中指定的版本。

对于插入到 orm.create_models 数组中的每个对象，在 lib/models 文件夹中会生成一个模型文件，文件名是你在 entity 属性中指定的名称。

开始使用Loquacious

现在你已经设置了所有文件，可以开始使用Loquacious。

在你的 main.dart 文件中导入Loquacious包：

import 'package:loquacious/loquacious.dart';

然后在 runApp(...) 方法之前插入Loquacious初始化方法。

确保你在 main() 方法的第一行调用 WidgetsFlutterBinding.ensureInitialized();。

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  Loquacious.init('db_name', 1, useMigrations: true).then((_) {
    runApp(MyApp());
  });
}

如果你想运行生成的迁移，请将 useMigrations 属性设置为 true。

确保你设置了数据库的正确版本（初始化方法的第二个参数）。

现在你可以使用 Loquacious 和它的所有功能。

使用Loquacious查询构建器

Loquacious 带有一个强大的查询构建器叫做 LQB。

这是一个简单的例子：

final result = await LQB.table('users').where('username', 'foo').get();

你可以在 这里 找到完整的API文档。

使用Loquacious ORM

Loquacious 的真正强大之处在于其 对象关系映射。

如果你是一位Laravel开发者，你肯定知道 Eloquent ORM。

Loquacious 非常受 Eloquent 启发，并试图成为适用于你的Flutter和Sqlite项目的轻量级ORM。

以下是使用 Loquacious ORM 的一些简单示例：

// 创建一个用户
final user = await User.create(username:'jDoe', password:'secret');

// 编辑创建的用户
user.username = 'johnDoe';
user.password = 'moreSecret';
await user.save();

// 获取所有用户
final users = await User.all();