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

简介

mysql_utils 是一个帮助Flutter项目连接和操作MySQL数据库的插件。自2.0.0版本以来，该插件采用了更为稳定的 mysql_client 扩展库，并尽量保持与2.0.0之前版本方法的兼容性。

如果你在寻找SQLite的支持，可以尝试 sqlite_utils 插件。

简体中文文档

Pub安装

可以通过 Pub安装页面 获取详细的安装步骤。

使用APIs

初始化连接

初始化参数相较于1.0有所变化，建议使用单例模式，并在使用后调用 close() 方法关闭数据库连接。

var db = MysqlUtils(
  settings: {
    'host': '127.0.0.1',
    'port': 3306,
    'user': 'root',
    'password': 'root',
    'db': 'test',
    'maxConnections': 10,
    'secure': false,
    'prefix': 'prefix_',
    'pool': true,
    'collation': 'utf8mb4_general_ci',
    'sqlEscape': true,
  },
  errorLog: (error) {
    print(error);
  },
  sqlLog: (sql) {
    print(sql);
  },
  connectInit: (db1) async {
    print('whenComplete');
  }
);

查询操作

原生查询

注意这里的方法不同于1.0版本，2.0继承了 mysql_client 的方法。

var row = await db.query('select id from Product where id=:id or description like :description',{
  'id':1,
  'description':'%ce%'
});
print(row.toMap());

单条记录查询

var row = await db.getOne(
  table: 'table',
  fields: '*',
  where: {'email': 'xxx@google.com'},
);
print(row);

多条记录查询

var row = await db.getAll(
  table: 'table',
  fields: '*',
  where: {'id': ['>', 1]},
);
print(row);

数据操作

插入单条数据

await db.insert(
  table: 'table',
  insertData: {
    'telphone': '+113888888888',
    'create_time': 1620577162252,
    'update_time': 1620577162252,
  },
);

插入多条数据

await db.insertAll(
  table: 'table',
  insertData: [
    {
      'telphone': '13888888888',
      'create_time': 1111111,
      'update_time': 12121212,
      'email': 'teenagex@dd.com'
    },
    {
      'telphone': '13881231238',
      'create_time': 324234,
      'update_time': 898981,
      'email': 'xxx@dd.com'
    }
  ]
);

更新数据

await db.update(
  table: 'table',
  updateData: {
    'telphone': '1231',
    'create_time': 12,
    'update_time': 12121212,
    'email': 'teenagex@dd.com'
  },
  where: {'id':1},
);

删除数据

await db.delete(
  table:'table',
  where: {'id':1}
);

统计操作

计数

await db.count(
  table: 'table',
  fields: '*',
);

平均值

await db.avg(
  table: 'table',
  fields: 'price',
);

最小值

await db.min(
  table: 'table',
  fields: 'price',
);

最大值

await db.max(
  table: 'table',
  fields: 'price',
);

事务支持

遇到异常时，事务会自动回滚。

await db.startTrans();
await db.delete(table: 'user', where: {'id': 25}, debug: true);
//await db.delete(table: 'user1', where: {'id': 26}, debug: true);
await db.commit();
await db.close();

连接状态检查

var isAlive = await db.isConnectionAlive();
if (isAlive) print('mysql is isAlive');

示例Demo

以下是一个完整的示例demo，包含了插入、查询等基本操作：

import 'dart:async';
import 'dart:math';

import 'package:mysql_utils/mysql_utils.dart';

Future main() async {
  var rng = new Random();
  final db = MysqlUtils(
    settings: {
      'host': '127.0.0.1',
      'port': 3306,
      'user': 'root',
      'password': 'root',
      'db': 'test',
      'maxConnections': 10,
      'secure': false,
      'prefix': 'su_',
      'pool': false,
      'collation': 'utf8mb4_general_ci',
    },
    errorLog: (error) {
      print(error);
    },
    sqlLog: (sql) {
      print(sql);
    },
    connectInit: (db1) async {
      print('whenComplete');
    },
  );

  // 插入数据
  var res3 = await db.insert(
    table: 'user',
    insertData: {
      'nickname': '中文测试-${rng.nextInt(100)}',
      'telphone': '+113888888888',
      'createTime': 1620577162252,
      'updateTime': 1620577162252,
    },
  );
  print(res3); // lastInsertID

  // 查询单条数据
  var row1 = await db.getOne(
    table: 'user',
    fields: '*',
    where: {'id': 2},
  );
  print(row1);

  // 查询多条数据
  var row2 = await db.getAll(
    table: 'user',
    fields: '*',
    where: {'id': ['>', 1]},
  );
  print(row2);

  // 聚合函数操作
  var count = await db.count(
    table: 'user',
    fields: '*',
  );
  print(count);

  var avg = await db.avg(
    table: 'user',
    fields: 'id',
  );
  print(avg);

  var min = await db.min(
    table: 'user',
    fields: 'id',
  );
  print(min);

  var max = await db.max(
    table: 'user',
    fields: 'id',
  );
  print(max);

  // 删除数据
  var deleteCount = await db.delete(
    table: 'user',
    where: {'id': 3},
  );
  print(deleteCount);

  // 更新数据
  var updateCount = await db.update(
    table: 'user',
    updateData: {
      'nickname': '更新测试-${rng.nextInt(100)}',
    },
    where: {'id': 4},
  );
  print(updateCount);

  // 插入多条数据
  var insertAllCount = await db.insertAll(
    table: 'user',
    insertData: [
      {
        'nickname': '批量插入测试-${rng.nextInt(100)}',
        'telphone': '+113888888888',
        'createTime': 1620577162252,
        'updateTime': 1620577162252,
      },
      {
        'nickname': '批量插入测试-${rng.nextInt(100)}',
        'telphone': '+113888888888',
        'createTime': 1620577162252,
        'updateTime': 1620577162252,
      }
    ],
  );
  print(insertAllCount);

  // 关闭连接
  await db.close();
}

希望以上内容能帮助你更好地理解和使用 mysql_utils 插件进行Flutter中的MySQL数据库操作。如果有任何问题或需要进一步的帮助，请随时提问！