Flutter数据库操作插件angel3_orm_mysql的使用

Angel3 ORM for MySQL 是一个用于在Flutter应用中操作MySQL或MariaDB数据库的插件。本文将详细介绍如何使用该插件进行数据库操作，并提供完整的示例代码。

支持的数据库

• MariaDB 10.2.x 或更高版本
• MySQL 8.x 或更高版本

注意: MySQL低于8.0和MariaDB低于10.2.0不支持，因为Angel3 ORM需要公共表表达式（CTE）来工作。

MySqlExecutor

MySqlExecutor 使用 mysql_client 驱动程序实现，适用于 MySQL 8.0+ 和 MariaDB 10.2+ 数据库。

连接到 MySQL 或 MariaDB

import 'package:mysql_client/mysql_client.dart';

var connection = await MySQLConnection.createConnection(
    host: "localhost",
    port: 3306,
    databaseName: "orm_test",
    userName: "test",
    password: "test123",
    secure: true);

var logger = Logger('orm_mysql');
await connection.connect(timeoutMs: 10000);
var executor = MySqlExecutor(connection, logger: logger);

已知限制

• 不支持 Blob 数据类型映射。
• 不支持 timestamp 数据类型映射，请使用 datetime。
• 不支持 UTC datetime。

MariaDBExecutor

MariaDBExecutor 使用 mysql1 驱动程序实现，仅适用于 MariaDB 10.2+ 数据库。

连接到 MariaDB

import 'package:mysql1/mysql1.dart';

var settings = ConnectionSettings(
    host: 'localhost',
    port: 3306,
    db: 'orm_test',
    user: 'test',
    password: 'test123');
var connection = await MySqlConnection.connect(settings);

var logger = Logger('orm_mariadb');
var executor = MariaDbExecutor(connection, logger: logger);

已知限制

• 不支持 Blob 类型映射。
• 不支持 timestamp 映射，请使用 datetime。
• 仅支持 UTC datetime，非UTC datetime将自动转换为UTC datetime。

创建新的数据库

1. 登录到 MariaDB/MySQL 数据库控制台：

mysql -u root -p

1. 创建新数据库并授予权限：

create database orm_test;

-- 授予本地访问权限
create user 'test'@'localhost' identified by 'test123';
grant all privileges on orm_test.* to 'test'@'localhost';

-- 授予本地和远程访问权限
create user 'test'@'%' identified by 'test123';
grant all privileges on orm_test.* to 'test'@'%';

示例代码

以下是完整的示例代码，演示如何使用 angel3_orm_mysql 插件进行数据库操作：

import 'dart:io';

import 'package:angel3_migration/angel3_migration.dart';
import 'package:angel3_orm/angel3_orm.dart';
import 'package:angel3_orm_mysql/angel3_orm_mysql.dart';
import 'package:angel3_serialize/angel3_serialize.dart';
import 'package:mysql_client/mysql_client.dart';
import 'package:mysql1/mysql1.dart';
import 'package:logging/logger.dart';
import 'package:optional/optional.dart';
part 'main.g.dart';

void main() async {
  //hierarchicalLoggingEnabled = true;

  //await mariaDBExample();
  await mysqlExample();

  exit(0);
}

Future<void> mariaDBExample() async {
  Logger.root
    ..level = Level.ALL
    ..onRecord.listen(print);

  var settings = ConnectionSettings(
      host: 'localhost',
      port: 3306,
      db: 'orm_test',
      user: 'test',
      password: 'test123');
  var connection = await MySqlConnection.connect(settings);

  print("Connected to MariaDb");
  var logger = Logger('orm_mysql');
  var executor = MariaDbExecutor(connection, logger: logger);

  var query = TodoQuery();
  query.values
    ..text = 'Clean your room!'
    ..updatedAt = DateTime.now().toUtc()
    ..isComplete = false;

  var todo = await query.insert(executor);
  print(todo.value.toJson());

  var query2 = TodoQuery()..where!.id.equals(todo.value.idAsInt);
  var todo2 = await query2.getOne(executor);
  print(todo2.value.toJson());
  print(todo == todo2);
}

Future<void> mysqlExample() async {
  Logger.root
    ..level = Level.ALL
    ..onRecord.listen(print);

  var connection = await MySQLConnection.createConnection(
      host: "localhost",
      port: 3306,
      databaseName: "orm_test",
      userName: "test",
      password: "test123",
      secure: true);

  print("Connected to MySQL");
  var logger = Logger('orm_mysql');
  await connection.connect(timeoutMs: 10000);
  var executor = MySqlExecutor(connection, logger: logger);

  var query = TodoQuery();
  query.values
    ..text = 'Clean your room!'
    ..updatedAt = DateTime.now().toUtc()
    ..isComplete = false;

  var todo = await query.insert(executor);
  print(todo.value.toJson());

  var query2 = TodoQuery()..where!.id.equals(todo.value.idAsInt);
  var todo2 = await query2.getOne(executor);
  print(todo2.value.toJson());
  print(todo == todo2);
}

@serializable
@orm
abstract class _Todo extends Model {
  String? get text;

  @DefaultsTo(false)
  bool? isComplete;
}

通过以上步骤和示例代码，您可以轻松地在Flutter应用中使用 angel3_orm_mysql 插件进行数据库操作。