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

时间:2019-01-16 19:22:47

标签: sqlite dart flutter sqflite

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

我最近一直在努力学习这一点,因此,我在下面添加我的答案,作为帮助我学习的一种方法,并作为将来其他人的快速参考。

1 个答案:

答案 0 :(得分:7)

添加依赖项

打开pubspec.yaml,然后在“依赖项”部分中添加以下行:

sqflite: ^1.0.0
path_provider: ^0.4.1

sqflite当然是SQFlite插件,而path_provider将帮助我们在Android和iPhone上获取用户目录。您可以在此处查看最新的版本号:sqflitepath_provider

制作数据库助手类

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

创建一个名为 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 *并返回表中的所有内容,只需输入表名即可。

  _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参数传递一个参数,以选择满足我们条件的特定行。在此示例中,我们将查询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代码本身的熟悉性或灵活性,则可以执行原始查询。在此示例中,我们将选择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类和sqflite
  • SQFlite插件使用Map<String, dynamic>将列名映射到每一行中的数据。

补充代码

enter image description here

为方便复制和粘贴,以下是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));
  }
}

继续