使用 SQLite 持久化数据
如何使用 SQLite 存储和检索数据。
如果您正在编写需要在本地设备上持久化和查询大量数据的应用，请考虑使用数据库而不是本地文件或键值存储。通常，与其他本地持久化解决方案相比，数据库提供更快的插入、更新和查询速度。
Flutter 应用可以通过 pub.dev 上提供的 sqflite 插件使用 SQLite 数据库。本教程演示了使用 sqflite 插入、读取、更新和删除有关各种 Dog 的数据的基本知识。
如果您不熟悉 SQLite 和 SQL 语句，请查看 SQLite 教程，在完成本教程之前学习基础知识。
本示例将采取以下步骤
- 添加依赖项。
- 定义
Dog数据模型。 - 打开数据库。
- 创建
dogs表。 - 将
Dog插入数据库。 - 检索 dogs 列表。
- 更新数据库中的
Dog。 - 从数据库中删除
Dog。
1. 添加依赖项
#要使用 SQLite 数据库，请导入 sqflite 和 path 包。
sqflite包提供与 SQLite 数据库交互的类和函数。path包提供函数来定义在磁盘上存储数据库的位置。
要将包添加为依赖项，请运行 flutter pub add
flutter pub add sqflite path
请确保在您将要使用的文件中导入这些包。
dart
import 'dart:async';
import 'package:flutter/widgets.dart';
import 'package:path/path.dart';
import 'package:sqflite/sqflite.dart';
2. 定义 Dog 数据模型
#在创建用于存储 Dog 信息的表之前，花几分钟时间定义需要存储的数据。对于本示例，定义一个 Dog 类，其中包含三条数据：一个唯一的 id、name 和每个 Dog 的 age。
dart
class Dog {
final int id;
final String name;
final int age;
const Dog({required this.id, required this.name, required this.age});
}
3. 打开数据库
#在读取和写入数据库之前，打开到数据库的连接。这涉及两个步骤
- 使用
sqflite包中的getDatabasesPath()函数以及path包中的join函数定义数据库文件的路径。 - 使用
sqflite中的openDatabase()函数打开数据库。
dart
// Avoid errors caused by flutter upgrade.
// Importing 'package:flutter/widgets.dart' is required.
WidgetsFlutterBinding.ensureInitialized();
// Open the database and store the reference.
final database = openDatabase(
// Set the path to the database. Note: Using the `join` function from the
// `path` package is best practice to ensure the path is correctly
// constructed for each platform.
join(await getDatabasesPath(), 'doggie_database.db'),
);
4. 创建 dogs 表
#
接下来，创建一个表来存储有关各种 Dog 的信息。对于本示例，创建一个名为 dogs 的表，该表定义可以存储的数据。每个 Dog 包含一个 id、name 和 age。因此，这些在 dogs 表中表示为三个列。
id是一个 Dartint，并存储为 SQLite 数据类型INTEGER。将id作为表的唯一标识符也是一个好习惯，以提高查询和更新速度。name是一个 DartString，并存储为 SQLite 数据类型TEXT。age也是一个 Dartint，并存储为INTEGER数据类型。
有关可以在 SQLite 数据库中存储的可用数据类型的更多信息，请参阅 官方 SQLite 数据类型文档。
dart
final database = openDatabase(
// Set the path to the database. Note: Using the `join` function from the
// `path` package is best practice to ensure the path is correctly
// constructed for each platform.
join(await getDatabasesPath(), 'doggie_database.db'),
// When the database is first created, create a table to store dogs.
onCreate: (db, version) {
// Run the CREATE TABLE statement on the database.
return db.execute(
'CREATE TABLE dogs(id INTEGER PRIMARY KEY, name TEXT, age INTEGER)',
);
},
// Set the version. This executes the onCreate function and provides a
// path to perform database upgrades and downgrades.
version: 1,
);
5. 将 Dog 插入数据库
#现在您拥有一个具有适合存储有关各种 Dog 的信息的表的数据库，现在可以开始读取和写入数据了。
首先，将 Dog 插入 dogs 表。这涉及两个步骤
- 将
Dog转换为Map - 使用
insert()方法将Map存储在dogs表中。
dart
class Dog {
final int id;
final String name;
final int age;
Dog({required this.id, required this.name, required this.age});
// Convert a Dog into a Map. The keys must correspond to the names of the
// columns in the database.
Map<String, Object?> toMap() {
return {'id': id, 'name': name, 'age': age};
}
// Implement toString to make it easier to see information about
// each dog when using the print statement.
@override
String toString() {
return 'Dog{id: $id, name: $name, age: $age}';
}
}
dart
// Define a function that inserts dogs into the database
Future<void> insertDog(Dog dog) async {
// Get a reference to the database.
final db = await database;
// Insert the Dog into the correct table. You might also specify the
// `conflictAlgorithm` to use in case the same dog is inserted twice.
//
// In this case, replace any previous data.
await db.insert(
'dogs',
dog.toMap(),
conflictAlgorithm: ConflictAlgorithm.replace,
);
}
dart
// Create a Dog and add it to the dogs table
var fido = Dog(id: 0, name: 'Fido', age: 35);
await insertDog(fido);
6. 获取 Dog 列表
#现在将 Dog 存储在数据库中，查询数据库以获取特定的 Dog 或所有 Dog 的列表。这涉及两个步骤
- 对
dogs表运行query。这将返回一个List<Map>。 - 将
List<Map>转换为List<Dog>。
dart
// A method that retrieves all the dogs from the dogs table.
Future<List<Dog>> dogs() async {
// Get a reference to the database.
final db = await database;
// Query the table for all the dogs.
final List<Map<String, Object?>> dogMaps = await db.query('dogs');
// Convert the list of each dog's fields into a list of `Dog` objects.
return [
for (final {'id': id as int, 'name': name as String, 'age': age as int}
in dogMaps)
Dog(id: id, name: name, age: age),
];
}
dart
// Now, use the method above to retrieve all the dogs.
print(await dogs()); // Prints a list that include Fido.
7. 更新数据库中的 Dog
#
在将信息插入数据库后，您可能希望稍后更新该信息。您可以使用 sqflite 库中的 update() 方法来执行此操作。
这涉及两个步骤
- 将 Dog 转换为 Map。
- 使用
where子句以确保更新正确的 Dog。
dart
Future<void> updateDog(Dog dog) async {
// Get a reference to the database.
final db = await database;
// Update the given Dog.
await db.update(
'dogs',
dog.toMap(),
// Ensure that the Dog has a matching id.
where: 'id = ?',
// Pass the Dog's id as a whereArg to prevent SQL injection.
whereArgs: [dog.id],
);
}
dart
// Update Fido's age and save it to the database.
fido = Dog(id: fido.id, name: fido.name, age: fido.age + 7);
await updateDog(fido);
// Print the updated results.
print(await dogs()); // Prints Fido with age 42.
8. 从数据库中删除 Dog
#
除了插入和更新有关 Dog 的信息外，还可以从数据库中删除 Dog。要删除数据，请使用 sqflite 库中的 delete() 方法。
在本节中，创建一个函数，该函数接受一个 id 并从数据库中删除具有匹配 id 的 Dog。为了使这起作用，您必须提供一个 where 子句来限制被删除的记录。
dart
Future<void> deleteDog(int id) async {
// Get a reference to the database.
final db = await database;
// Remove the Dog from the database.
await db.delete(
'dogs',
// Use a `where` clause to delete a specific dog.
where: 'id = ?',
// Pass the Dog's id as a whereArg to prevent SQL injection.
whereArgs: [id],
);
}
示例
#要运行示例
- 创建一个新的 Flutter 项目。
- 将
sqflite和path包添加到您的pubspec.yaml。 - 将以下代码粘贴到名为
lib/db_test.dart的新文件中。 - 使用
flutter run lib/db_test.dart运行代码。
dart
import 'dart:async';
import 'package:flutter/widgets.dart';
import 'package:path/path.dart';
import 'package:sqflite/sqflite.dart';
void main() async {
// Avoid errors caused by flutter upgrade.
// Importing 'package:flutter/widgets.dart' is required.
WidgetsFlutterBinding.ensureInitialized();
// Open the database and store the reference.
final database = openDatabase(
// Set the path to the database. Note: Using the `join` function from the
// `path` package is best practice to ensure the path is correctly
// constructed for each platform.
join(await getDatabasesPath(), 'doggie_database.db'),
// When the database is first created, create a table to store dogs.
onCreate: (db, version) {
// Run the CREATE TABLE statement on the database.
return db.execute(
'CREATE TABLE dogs(id INTEGER PRIMARY KEY, name TEXT, age INTEGER)',
);
},
// Set the version. This executes the onCreate function and provides a
// path to perform database upgrades and downgrades.
version: 1,
);
// Define a function that inserts dogs into the database
Future<void> insertDog(Dog dog) async {
// Get a reference to the database.
final db = await database;
// Insert the Dog into the correct table. You might also specify the
// `conflictAlgorithm` to use in case the same dog is inserted twice.
//
// In this case, replace any previous data.
await db.insert(
'dogs',
dog.toMap(),
conflictAlgorithm: ConflictAlgorithm.replace,
);
}
// A method that retrieves all the dogs from the dogs table.
Future<List<Dog>> dogs() async {
// Get a reference to the database.
final db = await database;
// Query the table for all the dogs.
final List<Map<String, Object?>> dogMaps = await db.query('dogs');
// Convert the list of each dog's fields into a list of `Dog` objects.
return [
for (final {'id': id as int, 'name': name as String, 'age': age as int}
in dogMaps)
Dog(id: id, name: name, age: age),
];
}
Future<void> updateDog(Dog dog) async {
// Get a reference to the database.
final db = await database;
// Update the given Dog.
await db.update(
'dogs',
dog.toMap(),
// Ensure that the Dog has a matching id.
where: 'id = ?',
// Pass the Dog's id as a whereArg to prevent SQL injection.
whereArgs: [dog.id],
);
}
Future<void> deleteDog(int id) async {
// Get a reference to the database.
final db = await database;
// Remove the Dog from the database.
await db.delete(
'dogs',
// Use a `where` clause to delete a specific dog.
where: 'id = ?',
// Pass the Dog's id as a whereArg to prevent SQL injection.
whereArgs: [id],
);
}
// Create a Dog and add it to the dogs table
var fido = Dog(id: 0, name: 'Fido', age: 35);
await insertDog(fido);
// Now, use the method above to retrieve all the dogs.
print(await dogs()); // Prints a list that include Fido.
// Update Fido's age and save it to the database.
fido = Dog(id: fido.id, name: fido.name, age: fido.age + 7);
await updateDog(fido);
// Print the updated results.
print(await dogs()); // Prints Fido with age 42.
// Delete Fido from the database.
await deleteDog(fido.id);
// Print the list of dogs (empty).
print(await dogs());
}
class Dog {
final int id;
final String name;
final int age;
Dog({required this.id, required this.name, required this.age});
// Convert a Dog into a Map. The keys must correspond to the names of the
// columns in the database.
Map<String, Object?> toMap() {
return {'id': id, 'name': name, 'age': age};
}
// Implement toString to make it easier to see information about
// each dog when using the print statement.
@override
String toString() {
return 'Dog{id: $id, name: $name, age: $age}';
}
}