Flutter数据库管理插件database的使用

Flutter数据库管理插件database的使用

什么是这个？

我们希望有一个与供应商无关的API来访问类似SQL的数据库。我们几年前就弃用了之前的草案，现在希望设计一个更简单、更好的方案。

API的设计还在进行中。我们鼓励大家讨论这个API应该是什么样子，并欢迎提出拉取请求。:)

由于提供的内容和示例代码比较有限，我将基于Flutter常见的数据库插件sqflite（一个常用的SQLite数据库插件）来创建一个完整的示例demo，以帮助您理解如何在Flutter中使用数据库管理插件。

示例Demo

以下是一个简单的Flutter应用程序示例，它展示了如何使用sqflite插件来创建数据库、插入数据和查询数据。

首先，在您的pubspec.yaml文件中添加sqflite依赖：

dependencies:
  flutter:
    sdk: flutter
  sqflite: ^2.0.0+3

接下来，创建一个数据库帮助类DatabaseHelper.dart，用于管理数据库连接和操作：

import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart';

class DatabaseHelper {
  static final _databaseName = "MyDatabase.db";
  static final _databaseVersion = 1;

  // 表名
  static final table = 'my_table';

  // 列名
  static final columnId = '_id';
  static final columnName = 'name';

  // 单例模式
  DatabaseHelper._privateConstructor();
  static final DatabaseHelper instance = DatabaseHelper._privateConstructor();

  static Database? _database;
  
  // 获取数据库实例
  Future<Database> get database async {
    if (_database != null) return _database!;
    _database = await _initDatabase();
    return _database!;
  }

  // 初始化数据库
  _initDatabase() async {
    String path = join(await getDatabasesPath(), _databaseName);
    return await openDatabase(
      path,
      version: _databaseVersion,
      onCreate: _onCreate,
    );
  }

  // 创建表
  Future _onCreate(Database db, int version) async {
    await db.execute('''
          CREATE TABLE $table (
            $columnId INTEGER PRIMARY KEY AUTOINCREMENT,
            $columnName TEXT NOT NULL
          )
          ''');
  }

  // 插入数据
  Future<int> insert(Map<String, dynamic> row) async {
    Database db = await instance.database;
    return await db.insert(table, row);
  }

  // 查询所有数据
  Future<List<Map<String, dynamic>>> queryAllRows() async {
    Database db = await instance.database;
    return await db.query(table);
  }

  // 根据ID查询数据
  Future<List<Map<String, dynamic>>> queryById(int id) async {
    Database db = await instance.database;
    return await db.query(table, where: '$columnId = ?', whereArgs: [id]);
  }

  // 更新数据
  Future<int> update(Map<String, dynamic> row) async {
    Database db = await instance.database;
    int id = row[columnId];
    return await db.update(
      table,
      row,
      where: '$columnId = ?',
      whereArgs: [id],
    );
  }

  // 删除数据
  Future<int> delete(int id) async {
    Database db = await instance.database;
    return await db.delete(
      table,
      where: '$columnId = ?',
      whereArgs: [id],
    );
  }
}

然后，在主应用程序文件main.dart中使用该数据库帮助类：

import 'package:flutter/material.dart';
import 'DatabaseHelper.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Database Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _insertData() async {
    Map<String, dynamic> row = {DatabaseHelper.columnName: 'Item $_counter'};
    final id = await DatabaseHelper.instance.insert(row);
    print('Inserted row id: $id');
    setState(() {
      _counter++;
    });
  }

  void _queryData() async {
    final allRows = await DatabaseHelper.instance.queryAllRows();
    print('Query all rows:');
    allRows.forEach((row) => print(row));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: _insertData,
              child: Text('Insert Data'),
            ),
            ElevatedButton(
              onPressed: _queryData,
              child: Text('Query Data'),
            ),
          ],
        ),
      ),
    );
  }
}