如何在 Flutter 中使用 SQFlite 进行数据库查询

Question

如何使用SQFlite插件在Flutter中查询SQLite数据库中的数据？

我最近一直在学习这个，所以我在下面加上我的答案，作为帮助我学习的一种方式，也作为以后其他人的快速参考。

Answer 1

添加依赖项

打开 pubspec.yaml 并在依赖项部分添加以下行：

sqflite: ^1.0.0
path_provider: ^0.4.1

sqflite 是 SQFlite plugin of course and the path_provider will help us get the user directory on Android and iPhone. You can check the most up-to-date version numbers here: sqflite and path_provider。

制作数据库助手class

我在单例中保持对数据库的全局引用 class。这将防止并发问题和数据泄漏。您还可以在此处添加辅助方法（如查询）以访问数据库。

创建一个名为 database_helper.dart 的新文件并粘贴以下代码：

import 'dart:io' show Directory;
import 'package:path/path.dart' show join;
import 'package:sqflite/sqflite.dart';
import 'package:path_provider/path_provider.dart' show getApplicationDocumentsDirectory;

class DatabaseHelper {

  static final _databaseName = "MyDatabase.db";
  static final _databaseVersion = 1;

  static final table = 'my_table';

  static final columnId = '_id';
  static final columnName = 'name';
  static final columnAge = 'age';

  // make this a singleton class
  DatabaseHelper._privateConstructor();
  static final DatabaseHelper instance = DatabaseHelper._privateConstructor();

  // only have a single app-wide reference to the database
  static Database _database;
  Future<Database> get database async {
    if (_database != null) return _database;
    // lazily instantiate the db the first time it is accessed
    _database = await _initDatabase();
    return _database;
  }

  // this opens the database (and creates it if it doesn't exist)
  _initDatabase() async {
    Directory documentsDirectory = await getApplicationDocumentsDirectory();
    String path = join(documentsDirectory.path, _databaseName);
    return await openDatabase(path,
        version: _databaseVersion,
        onCreate: _onCreate);
  }

  // SQL code to create the database table
  Future _onCreate(Database db, int version) async {
    await db.execute('''
          CREATE TABLE $table (
            $columnId INTEGER PRIMARY KEY,
            $columnName TEXT NOT NULL,
            $columnAge INTEGER NOT NULL
          )
          ''');

    // prepopulate a few rows (consider using a transaction)
    await db.rawInsert('INSERT INTO $table ($columnName, $columnAge) VALUES("Bob", 23)');
    await db.rawInsert('INSERT INTO $table ($columnName, $columnAge) VALUES("Mary", 32)');
    await db.rawInsert('INSERT INTO $table ($columnName, $columnAge) VALUES("Susan", 12)');
  }
}

请注意，在创建数据库时，我预先填充了几行。这样我们就可以在下面的查询示例中使用一些东西。

查询数据

我们将使用异步方法进行查询，因为数据库操作的开销可能很大。

获取所有行

要执行 SELECT * 和 return table 中的所有操作，您只需传入 table 名称即可。

  _query() async {

    // get a reference to the database
    Database db = await DatabaseHelper.instance.database;

    // get all rows
    List<Map> result = await db.query(DatabaseHelper.table);

    // print the results
    result.forEach((row) => print(row));
    // {_id: 1, name: Bob, age: 23}
    // {_id: 2, name: Mary, age: 32}
    // {_id: 3, name: Susan, age: 12}
  }

获取单行

我们可以将 where 参数的参数传递给 select 符合我们条件的特定行。在此示例中，我们将查询 ID 为 1.

的行

  _query() async {

    // get a reference to the database
    Database db = await DatabaseHelper.instance.database;

    // get single row
    List<String> columnsToSelect = [
      DatabaseHelper.columnId,
      DatabaseHelper.columnName,
      DatabaseHelper.columnAge,
    ];
    String whereString = '${DatabaseHelper.columnId} = ?';
    int rowId = 1;
    List<dynamic> whereArguments = [rowId];
    List<Map> result = await db.query(
        DatabaseHelper.table,
        columns: columnsToSelect,
        where: whereString,
        whereArgs: whereArguments);

    // print the results
    result.forEach((row) => print(row));
    // {_id: 1, name: Bob, age: 23}
  }

whereArguments 列表中的项目取代了 whereString 中的 ?。在这种情况下只有一个 ? 所以 whereArguments 只有一个项目。如果有两个 ?（例如一个整数和一个字符串），那么您将在列表中有两个项目。

原始查询

如果您更喜欢 SQL 代码本身的熟悉度或灵活性，您可以进行原始查询。在此示例中，我们将 select 其 name 列为 'Mary'.

的任何行

  _query() async {

    // get a reference to the database
    Database db = await DatabaseHelper.instance.database;

    // raw query
    List<Map> result = await db.rawQuery('SELECT * FROM my_table WHERE name=?', ['Mary']);

    // print the results
    result.forEach((row) => print(row));
    // {_id: 2, name: Mary, age: 32}
  }

务必使用 ? 字符串替换来使用数据绑定。这将防止 SQL 注入攻击。

注释

如果您在另一个文件中（如 main.dart），则必须导入 DatabaseHelper class 和 sqflite。
SQFlite 插件使用 Map<String, dynamic> 将列名映射到每行中的数据。

补充代码

为了方便复制和粘贴，这里是 main.dart 的布局代码：

import 'package:flutter/material.dart';
// I called my project 'flutter_database_operations'. You can update for yours.
import 'package:flutter_database_operations/database_helper.dart';
import 'package:sqflite/sqflite.dart';

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

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

class MyHomePage extends StatelessWidget {

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('sqflite'),
      ),
      body: RaisedButton(
        child: Text('query', style: TextStyle(fontSize: 20),),
        onPressed: () {_query();},
      ),
    );
  }

  _query() async {

    // get a reference to the database
    Database db = await DatabaseHelper.instance.database;

    // get all rows
    List<Map> result = await db.query(DatabaseHelper.table);

    // get single row
    //List<Map> result = await db.query(DatabaseHelper.table,
    //    columns: [DatabaseHelper.columnId, DatabaseHelper.columnName, DatabaseHelper.columnAge],
    //    where: '${DatabaseHelper.columnId} = ?',
    //    whereArgs: [1]);


    // raw query
    //List<Map> result = await db.rawQuery('SELECT * FROM my_table WHERE name=?', ['Mary']);

    // get each row in the result list and print it
    result.forEach((row) => print(row));
  }
}

进行中

这个 post 是我之前 post 的发展：Simple SQFlite database example in Flutter。请参阅 post 了解其他 SQL 操作和建议。

如何在 Flutter 中使用 SQFlite 进行数据库查询

How to do a database query with SQFlite in Flutter

sqlite

dart

flutter

sqflite