Как сделать запрос к базе данных с помощью SQFlite во Flutter

Как вы запрашиваете данные из базы данных SQLite во Flutter с помощью плагина SQFlite?

Я работал над изучением этого недавно, поэтому я добавляю свой ответ ниже в качестве средства, которое поможет мне учиться, а также в качестве быстрого справочника для других в будущем.


person Suragch    schedule 16.01.2019    source источник


Ответы (1)


Добавьте зависимости

Откройте pubspec.yaml и в разделе зависимостей добавьте следующие строки:

sqflite: ^1.0.0
path_provider: ^0.4.1

sqflite - это, конечно, плагин SQFlite, а path_provider поможет нам получить каталог пользователей на Android и iPhone. Вы можете проверить самые последние номера версий здесь: sqflite и path_provider.

Создайте вспомогательный класс базы данных

Я сохраняю глобальную ссылку на базу данных в одноэлементном классе. Это предотвратит проблемы параллелизма и утечку данных. Вы также можете добавить сюда вспомогательные методы (например, query) для доступа к базе данных.

Создайте новый файл с именем 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, чтобы выбрать определенные строки, соответствующие нашим критериям. В этом примере мы запросим строку с идентификатором 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-инъекций.

Примечания

  • Вам нужно будет импортировать класс DatabaseHelper и sqflite, если вы находитесь в другом файле (например, main.dart).
  • Плагин 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));
  }
}

Продолжается

person Suragch    schedule 16.01.2019
comment
Вы публиковали это где-нибудь в блоге, например, в medium? Я уверен, что это будет полезно другим. - person Darren Cole; 20.10.2019
comment
@DarrenCole, Да, см. здесь раздел «Хранилище». - person Suragch; 21.10.2019
comment
но что, если вам нужна не карта, а предопределенная сущность, тогда вам нужно сопоставить каждую строку? - person desgraci; 05.12.2019
comment
@desgraci, вы можете использовать другой метод для преобразования карты в вашу предопределенную сущность. См. Класс модели в этом примере. - person Suragch; 05.12.2019
comment
@Suragch да, этого сопоставления я хотел избежать, надеялся, что какая-то библиотека сделает это автоматически 4 u, но спасибо за ссылку. - person desgraci; 05.12.2019
comment
@desgraci, тоже попробуйте Hive. Не пользовался, но хорошие вещи слышу. - person Suragch; 05.12.2019
comment
Привет, а как насчет закрытия базы данных после запроса? Разве это не нужно? - person S-Man; 05.03.2020
comment
@ S-Man, кто-то, кто знает больше меня, может меня поправить, но если вы поддерживаете только одно соединение с базой данных (обеспечиваемое синглтоном), вам не нужно закрывать соединение. По моему опыту, с управлением соединениями с базой данных гораздо проще справиться. Я не заметил утечек, но, как я уже сказал, возможно, я что-то упускаю. - person Suragch; 05.03.2020
comment
Любопытно, когда DatabaseHelper - singleton, почему нам нужно, чтобы _database была статической? - person Ashish Khurange; 29.07.2020
comment
@AshishKhurange, Хороший вопрос. Я не могу придумать ни одной причины, по которой это не могло быть переменной экземпляра. - person Suragch; 30.07.2020