使用 SQLite 持久化数据

如果您正在开发需要持久化和查询大量本地设备数据的应用，请考虑使用数据库而不是本地文件或键值存储。通常，与其它本地持久化解决方案相比，数据库在插入、更新和查询方面速度更快。

Flutter 应用可以通过 pub.dev 上提供的 sqflite 插件来使用 SQLite 数据库。本示例演示了如何使用 sqflite 来插入、读取、更新和删除各种 Dog 的数据。

如果您不熟悉 SQLite 和 SQL 语句，请在完成本示例之前，先查看 SQLite 教程以了解基础知识。

本示例将采取以下步骤

添加依赖项。
定义 Dog 数据模型。
打开数据库。
创建 dogs 表。
向数据库中插入一条 Dog 记录。
检索 Dog 列表。
更新数据库中的 Dog 记录。
从数据库中删除 Dog 记录。

要使用 SQLite 数据库，请导入 sqflite 和 path 程序包。

sqflite 程序包提供了与 SQLite 数据库交互的类和函数。
path 程序包提供了用于定义数据库在磁盘上的存储位置的函数。

要将程序包添加为依赖项，请运行 flutter pub add

flutter pub add sqflite path

确保在您将要使用的文件中导入这些程序包。

dartimport 'dart:async';

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

在创建用于存储 Dog 信息的表之前，花点时间定义需要存储的数据。在此示例中，请定义一个 Dog 类，其中包含三项数据：每个 Dog 的唯一 id、name 和 age。

dartclass Dog {
  final int id;
  final String name;
  final int age;

  const Dog({required this.id, required this.name, required this.age});
}

在读取和写入数据库数据之前，请打开到数据库的连接。这涉及两个步骤：

使用 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'),
);

接下来，创建一个表来存储各种 Dog 的信息。在此示例中，创建一个名为 dogs 的表，该表定义了可以存储的数据。每个 Dog 包含一个 id、name 和 age。因此，这些在 dogs 表中表示为三个列。

id 是 Dart 的 int 类型，并存储为 INTEGER SQLite 数据类型。使用 id 作为表的主键也是一个好习惯，这可以提高查询和更新的速度。
name 是 Dart 的 String 类型，并存储为 TEXT SQLite 数据类型。
age 也是 Dart 的 int 类型，并存储为 INTEGER 数据类型。

有关可以在 SQLite 数据库中存储的可用数据类型的更多信息，请参阅 SQLite 官方数据类型文档。

dartfinal 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,
);

现在您已经拥有了一个包含适合存储各种 Dog 信息的表的数据库，是时候进行读写数据了。

首先，向 dogs 表插入一条 Dog 记录。这涉及两个步骤：

将 Dog 转换为 Map。
使用 insert() 方法将 Map 存储到 dogs 表中。

dartclass 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);

现在 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.

在向数据库插入信息后，您可能希望稍后更新该信息。您可以通过使用 sqflite 库中的 update() 方法来做到这一点。

这涉及两个步骤：

将 Dog 转换为 Map。
使用 where 子句来确保更新正确的 Dog。

dartFuture<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.

除了插入和更新 Dog 的信息外，您还可以从数据库中删除 Dog。要删除数据，请使用 sqflite 库中的 delete() 方法。

在此部分，创建一个函数，该函数接受一个 id 并从数据库中删除具有匹配 id 的 Dog。要使其正常工作，您必须提供一个 where 子句来限制要删除的记录。

dartFuture<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 运行代码。

dartimport '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}';
  }
}

此页面内容有帮助吗？

感谢你的反馈！

提供详情

感谢你的反馈！请告诉我们如何改进。

提供详情

除非另有说明，否则本网站上的文档反映了 Flutter 的最新稳定版本。页面最后更新日期：2025-09-04。查看源代码或报告问题。

使用 SQLite 持久化数据

1. 添加依赖项

2. 定义 Dog 数据模型

3. 打开数据库

4. 创建 `dogs` 表

5. 向数据库中插入一条 Dog 记录

6. 检索 Dog 列表

7. 更新数据库中的 `Dog` 记录

8. 从数据库中删除 `Dog` 记录

示例