Floor 开源项目使用教程

Floor 开源项目使用教程

【免费下载链接】floor 项目地址: https://gitcode.com/gh_mirrors/flo/floor

项目介绍

Floor 是一个用于 Dart 和 Flutter 应用程序的持久层框架，它结合了 SQL 编译检查和运行时安全特性。Floor 提供了一个简单的方式来访问 SQLite 数据库，并且支持使用注解处理器来生成代码，从而减少样板代码的编写。

项目快速启动

安装依赖

首先，在 pubspec.yaml 文件中添加 Floor 依赖：

dependencies:
  floor: ^1.0.0

dev_dependencies:
  floor_generator: ^1.0.0
  build_runner: ^2.0.0

定义实体

创建一个实体类，例如 Person：

import 'package:floor/floor.dart';

@entity
class Person {
  @primaryKey
  final int id;

  final String name;

  Person(this.id, this.name);
}

定义 DAO

创建一个数据访问对象（DAO）：

import 'package:floor/floor.dart';

@dao
abstract class PersonDao {
  @Query('SELECT * FROM Person')
  Future<List<Person>> findAllPersons();

  @insert
  Future<void> insertPerson(Person person);
}

创建数据库

定义数据库类：

import 'package:floor/floor.dart';
import 'package:sqflite/sqflite.dart' as sqflite;

part 'database.g.dart';

@Database(version: 1, entities: [Person])
abstract class AppDatabase extends FloorDatabase {
  PersonDao get personDao;
}

生成代码

运行 build_runner 生成必要的代码：

flutter pub run build_runner build

使用数据库

在应用中使用数据库：

import 'database.dart';

void main() async {
  final database = await $FloorAppDatabase.databaseBuilder('app_database.db').build();
  final personDao = database.personDao;

  await personDao.insertPerson(Person(1, 'Alice'));
  final persons = await personDao.findAllPersons();
  print(persons);
}

应用案例和最佳实践

应用案例

Floor 可以用于各种需要本地数据存储的 Flutter 应用，例如：

• 任务管理应用
• 笔记应用
• 健康追踪应用

最佳实践

• 使用注解处理器：利用注解处理器生成代码，减少手动编写样板代码的工作量。
• 数据库迁移：在数据库版本升级时，确保数据迁移逻辑正确处理。
• 单元测试：编写单元测试确保数据库操作的正确性。

典型生态项目

Floor 可以与其他 Flutter 生态项目结合使用，例如：

• Provider：用于状态管理，与 Floor 结合可以实现数据的双向绑定。
• Flutter Bloc：用于业务逻辑处理，与 Floor 结合可以实现复杂的数据流管理。
• Sqflite：Floor 底层依赖于 Sqflite，可以进一步扩展数据库操作功能。

通过结合这些生态项目，可以构建出功能强大且易于维护的 Flutter 应用。

【免费下载链接】floor 项目地址: https://gitcode.com/gh_mirrors/flo/floor