Flutter插件beyond的使用方法详解

前置条件

Beyond 是一个依赖多个包的小型框架，用于实现多种功能。请注意，Beyond 1.0.0 版本在未安装依赖的情况下将无法正常工作。同时，可以通过 beyond_cli 快速初始化 Beyond 项目，但如果你希望将其添加到现有的 Dart 服务器中，请确保以下依赖已安装：

• PostgreSQL
• GetIt

快速开始

你可以直接使用 beyond_cli 初始化 Beyond 项目，创建 beyond_cli 包并完成配置！

添加到现有 Dart 服务器

如果你已经有一个 Dart 服务器，并且不想使用 beyond_cli，那么可以手动将 Beyond 集成到现有项目中。以下是具体步骤：

1. 在 pubspec.yaml 中添加 beyond

首先，在项目的 pubspec.yaml 文件中添加 beyond 依赖：

dependencies:
  beyond: ^1.0.0

保存文件后运行 flutter pub get 来安装依赖。

2. 打开 PostgreSQL 连接并初始化

接下来，打开 PostgreSQL 数据库连接并调用 DB.initialize() 方法进行初始化：

import 'package:beyond/beyond.dart';
import 'package:postgres/postgres.dart';

void main() async {
  // 创建 PostgreSQL 连接
  final postgresql = await PostgreSQLConnection.connect(
    "localhost", 5432, "your_database",
    username: "your_username",
    password: "your_password",
  );

  // 初始化 DB
  DB.initialize(postgresql);

  print("Beyond 初始化成功！");
}

3. 开始使用 Beyond 模型和查询构建器

现在你已经完成了初始化，可以开始使用 Beyond 提供的数据模型和查询构建器了！例如，插入一条记录：

// 插入数据
await DB.insert('users', {
  'name': 'John Doe',
  'email': 'john.doe@example.com',
});

print("用户已成功插入数据库！");

完整示例代码

以下是一个完整的示例代码，展示了如何将 Beyond 添加到现有的 Dart 服务器中：

import 'package:beyond/beyond.dart';
import 'package:postgres/postgres.dart';

void main() async {
  // 创建 PostgreSQL 连接
  final postgresql = await PostgreSQLConnection.connect(
    "localhost", 5432, "your_database",
    username: "your_username",
    password: "your_password",
  );

  // 初始化 DB
  DB.initialize(postgresql);

  print("Beyond 初始化成功！");

  // 插入数据
  await DB.insert('users', {
    'name': 'John Doe',
    'email': 'john.doe@example.com',
  });

  print("用户已成功插入数据库！");
}