内容

持久化存储架构：SQL

内容

示例应用：待办事项列表应用
使用 SQL 存储复杂数据
整合所有内容

大多数 Flutter 应用，无论大小，可能都需要在某个时刻将数据存储在用户的设备上。例如，API 密钥、用户偏好或应离线提供的数据。

在本菜谱中，您将学习如何使用 SQL 在 Flutter 应用中集成用于复杂数据的持久存储，遵循 Flutter 架构设计模式。

要了解如何存储更简单的键值数据，请查看菜谱：持久存储架构：键值数据。

要阅读此菜谱，您应该熟悉 SQL 和 SQLite。如果您需要帮助，可以在阅读此菜谱之前阅读使用 SQLite 持久化数据菜谱。

此示例使用sqflite 和sqflite_common_ffi 插件，这两个插件结合起来支持移动设备和桌面。Web 支持在实验性插件sqflite_common_ffi_web 中提供，但本示例中未包含。

示例应用包含一个单一屏幕，顶部有应用栏，中间是项目列表，底部是文本字段输入。

ToDo application in light mode

应用程序的主体包含TodoListScreen。此屏幕包含一个ListTile项的ListView，每个项代表一个待办事项。在底部，一个TextField允许用户通过编写任务描述，然后点击“添加”FilledButton来创建新的待办事项。

用户可以点击删除IconButton来删除待办事项。

待办事项列表使用数据库服务本地存储，并在用户启动应用程序时恢复。

此功能遵循推荐的Flutter 架构设计，包含 UI 层和数据层。此外，在领域层中，您将找到使用的数据模型。

UI 层，包含TodoListScreen和TodoListViewModel
领域层，包含Todo数据类
数据层，包含TodoRepository和DatabaseService

TodoListScreen是一个 Widget，包含负责显示和创建待办事项的 UI。它遵循MVVM 模式，并附带TodoListViewModel，其中包含待办事项列表和三个命令来加载、添加和删除待办事项。

此屏幕分为两部分，一部分包含使用ListView实现的待办事项列表，另一部分是TextField和Button，用于创建新的待办事项。

ListView被ListenableBuilder包装，后者监听TodoListViewModel的变化，并为每个待办事项显示一个ListTile。

dartListenableBuilder(
  listenable: widget.viewModel,
  builder: (context, child) {
    return ListView.builder(
      itemCount: widget.viewModel.todos.length,
      itemBuilder: (context, index) {
        final todo = widget.viewModel.todos[index];
        return ListTile(
          title: Text(todo.task),
          trailing: IconButton(
            icon: const Icon(Icons.delete),
            onPressed: () => widget.viewModel.delete.execute(todo.id),
          ),
        );
      },
    );
  },
)

待办事项列表在TodoListViewModel中定义，并由load命令加载。此方法调用TodoRepository并获取待办事项列表。

dartList<Todo> _todos = [];

List<Todo> get todos => _todos;

Future<Result<void>> _load() async {
  try {
    final result = await _todoRepository.fetchTodos();
    switch (result) {
      case Ok<List<Todo>>():
        _todos = result.value;
        return Result.ok(null);
      case Error():
        return Result.error(result.error);
    }
  } on Exception catch (e) {
    return Result.error(e);
  } finally {
    notifyListeners();
  }
}

按下FilledButton，执行add命令并将文本控制器值传递进去。

dartFilledButton.icon(
  onPressed: () =>
      widget.viewModel.add.execute(_controller.text),
  label: const Text('Add'),
  icon: const Icon(Icons.add),
)

然后，add命令使用任务描述文本调用TodoRepository.createTodo()方法，并创建一个新的待办事项。

createTodo()方法返回新创建的待办事项，然后将其添加到视图模型中的_todo列表中。

待办事项包含由数据库生成的唯一标识符。这就是为什么视图模型不创建待办事项，而是TodoRepository创建的原因。

dartFuture<Result<void>> _add(String task) async {
  try {
    final result = await _todoRepository.createTodo(task);
    switch (result) {
      case Ok<Todo>():
        _todos.add(result.value);
        return Result.ok(null);
      case Error():
        return Result.error(result.error);
    }
  } on Exception catch (e) {
    return Result.error(e);
  } finally {
    notifyListeners();
  }
}

最后，TodoListScreen还监听add命令的结果。操作完成后，TextEditingController将被清空。

dartvoid _onAdd() {
  // Clear the text field when the add command completes.
  if (widget.viewModel.add.completed) {
    widget.viewModel.add.clearResult();
    _controller.clear();
  }
}

当用户点击ListTile中的IconButton时，将执行删除命令。

dartIconButton(
  icon: const Icon(Icons.delete),
  onPressed: () => widget.viewModel.delete.execute(todo.id),
)

然后，视图模型调用TodoRepository.deleteTodo()方法，传递唯一的待办事项标识符。正确的结果会从视图模型和屏幕中删除待办事项。

dartFuture<Result<void>> _delete(int id) async {
  try {
    final result = await _todoRepository.deleteTodo(id);
    switch (result) {
      case Ok<void>():
        _todos.removeWhere((todo) => todo.id == id);
        return Result.ok(null);
      case Error():
        return Result.error(result.error);
    }
  } on Exception catch (e) {
    return Result.error(e);
  } finally {
    notifyListeners();
  }
}

此示例应用程序的领域层包含待办事项数据模型。

项目由不可变数据类表示。在本例中，应用程序使用freezed包来生成代码。

该类有两个属性，一个由int表示的id，一个由String表示的任务描述。

dart@freezed
class Todo with _$Todo {
  const factory Todo({
    /// The unique identifier of the Todo item.
    required int id,

    /// The task description of the Todo item.
    required String task,
  }) = _Todo;
}

此功能的数据层由两个类组成，TodoRepository和DatabaseService。

TodoRepository充当所有待办事项的真相来源。视图模型必须使用此存储库来访问待办事项列表，并且不应公开有关它们如何存储的任何实现细节。

在内部，TodoRepository使用DatabaseService，后者使用sqflite包实现对 SQL 数据库的访问。您可以使用其他存储包（如sqlite3、drift）甚至云存储解决方案（如firebase_database）来实现相同的DatabaseService。

TodoRepository在每次请求之前检查数据库是否已打开，并在必要时打开它。

它实现了fetchTodos()、createTodo()和deleteTodo()方法。

dartclass TodoRepository {
  TodoRepository({
    required DatabaseService database,
  }) : _database = database;

  final DatabaseService _database;

  Future<Result<List<Todo>>> fetchTodos() async {
    if (!_database.isOpen()) {
      await _database.open();
    }
    return _database.getAll();
  }

  Future<Result<Todo>> createTodo(String task) async {
    if (!_database.isOpen()) {
      await _database.open();
    }
    return _database.insert(task);
  }

  Future<Result<void>> deleteTodo(int id) async {
    if (!_database.isOpen()) {
      await _database.open();
    }
    return _database.delete(id);
  }
}

DatabaseService使用sqflite包实现对 SQLite 数据库的访问。

最好将表和列名称定义为常量，以避免在编写 SQL 代码时出现拼写错误。

dartstatic const _kTableTodo = 'todo';
static const _kColumnId = '_id';
static const _kColumnTask = 'task';

open()方法打开现有数据库，如果不存在则创建一个新的数据库。

dartFuture<void> open() async {
  _database = await databaseFactory.openDatabase(
    join(await databaseFactory.getDatabasesPath(), 'app_database.db'),
    options: OpenDatabaseOptions(
      onCreate: (db, version) {
        return db.execute(
          'CREATE TABLE $_kTableTodo($_kColumnId INTEGER PRIMARY KEY AUTOINCREMENT, $_kColumnTask TEXT)',
        );
      },
      version: 1,
    ),
  );
}

请注意，列id被设置为primary key和autoincrement；这意味着每个新插入的项都会为id列分配一个新值。

insert()方法在数据库中创建一个新的待办事项，并返回一个新创建的 Todo 实例。id如前所述生成。

dartFuture<Result<Todo>> insert(String task) async {
  try {
    final id = await _database!.insert(_kTableTodo, {
      _kColumnTask: task,
    });
    return Result.ok(Todo(id: id, task: task));
  } on Exception catch (e) {
    return Result.error(e);
  }
}

所有DatabaseService操作都使用Result类返回值，这是Flutter 架构建议中推荐的。这有助于在应用程序代码的后续步骤中处理错误。

getAll()方法执行数据库查询，获取id和task列中的所有值。对于每个条目，它都会创建一个Todo类实例。

dartFuture<Result<List<Todo>>> getAll() async {
  try {
    final entries = await _database!.query(
      _kTableTodo,
      columns: [_kColumnId, _kColumnTask],
    );
    final list = entries
        .map(
          (element) => Todo(
            id: element[_kColumnId] as int,
            task: element[_kColumnTask] as String,
          ),
        )
        .toList();
    return Result.ok(list);
  } on Exception catch (e) {
    return Result.error(e);
  }
}

delete()方法根据待办事项id执行数据库删除操作。

在本例中，如果没有删除任何项，则会返回错误，表示某些操作出错。

dartFuture<Result<void>> delete(int id) async {
  try {
    final rowsDeleted = await _database!
        .delete(_kTableTodo, where: '$_kColumnId = ?', whereArgs: [id]);
    if (rowsDeleted == 0) {
      return Result.error(Exception('No todo found with id $id'));
    }
    return Result.ok(null);
  } on Exception catch (e) {
    return Result.error(e);
  }
}

在应用程序的main()方法中，首先初始化DatabaseService，这在不同平台上需要不同的初始化代码。然后，将新创建的DatabaseService传递给TodoRepository，后者本身作为构造函数参数依赖项传递给MainApp。

dartvoid main() {
  late DatabaseService databaseService;
  if (kIsWeb) {
    throw UnsupportedError('Platform not supported');
  } else if (Platform.isLinux || Platform.isWindows || Platform.isMacOS) {
    // Initialize FFI SQLite
    sqfliteFfiInit();
    databaseService = DatabaseService(
      databaseFactory: databaseFactoryFfi,
    );
  } else {
    // Use default native SQLite
    databaseService = DatabaseService(
      databaseFactory: databaseFactory,
    );
  }

  runApp(
    MainApp(
// ···
      todoRepository: TodoRepository(
        database: databaseService,
      ),
    ),
  );
}

然后，在创建TodoListScreen时，也创建TodoListViewModel并将TodoRepository作为依赖项传递给它。

dartTodoListScreen(
  viewModel: TodoListViewModel(
    todoRepository: widget.todoRepository,
  ),
)

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

持久化存储架构：SQL

示例应用：待办事项列表应用

使用 SQL 存储复杂数据

待办事项列表表示层

待办事项列表领域层

待办事项列表数据层

整合所有内容