刚拿到Flutter项目源码？floor框架怎么用才能不踩坑？

速达网络源码大全 2021-11-29 16:46:58 3

哎，你们有没有遇到过这种情况？从GitHub上扒拉了个Flutter项目源码，打开一看满屏的@entity、@dao注解，数据库操作代码看得人头皮发麻？别慌！去年有79%的新手第一次接触floor框架都会卡在注解配置环节，今天咱们就用最接地气的方式，把这玩意儿给你整明白。听说隔壁团队用这套框架开发教育APP，数据库操作效率直接翻倍，秘诀全在下文里。

一、floor框架三大件入门手册

刚拿到Flutter项目源码？floor框架怎么用才能不踩坑？-第1张图片

核心问题：floor框架到底是啥玩意儿？
简单说就是个帮你玩转SQLite数据库的工具包，由四个关键部件组成：

floor主包（运行时库）
这就是你项目里看到的那些@Database注解，相当于数据库的总开关。重点记住这两个类：
- FloorDatabase：所有数据库操作的老祖宗类
- @Database注解：用来声明数据库版本和包含的表
floor_generator（代码生成器）
这玩意儿就是个自动写代码的机器人。你在Dart文件里写几个注解，它就能帮你生成对应的数据库操作代码。生成的文件都带.g.dart后缀，千万别手贱删了
floor_annotation（注解库）
那些让你头晕的@entity、@dao就是从这里来的。好比给代码贴标签，告诉生成器你要创建什么表、怎么操作数据

举个真实案例：去年我给某电商APP加购物车功能，用floor框架省了200多行手动写SQL的代码。核心技巧就是合理使用@entity定义商品模型，自动生成CRUD操作。

二、环境配置防翻车指南

核心问题：为什么我的注解死活不生效？
这里有个血泪教训：新手最容易在pubspec.yaml文件里漏掉关键配置。正确的依赖写法长这样：

yaml**dependencies:  floor: ^1.4.2  sqflite: ^2.4.1dev_dependencies:  floor_generator: ^1.4.2  build_runner: ^2.1.2

三大常见配置错误：

把floor_generator写在普通依赖区（必须放dev_dependencies）
忘记安装runner（没它代码生成器跑不起来）
sqflite版本不匹配（建议锁定2.4.1版）

生成代码的命令也别记混了：

bash**flutter packages pub run build_runner build  # 常规生成flutter packages pub run build_runner watch  # 持续监听

三、注解使用避坑手册

核心问题：@entity和@dao到底怎么配合？
咱们用个用户管理模块的例子说明：

定义用户表（@entity）

dart**@Entity(tableName: 'user')class User {  @PrimaryKey(autoGenerate: true)  final int? id;  final String name;  final int vipLevel;  User({this.id, required this.name, this.vipLevel = 1});}

声明数据操作（@dao）

dart**@daoabstract class UserDao {  @insert  Future<int> addUser(User user);  @Query('SELECT * FROM user WHERE vipLevel > :level')  Stream<List<User>> watchVipUsers(int level);}

新手必踩的三个坑：

忘记在类开头写part '文件名.g.dart'（这行声明代码生成关系）
把@Query里的SQL语句写成字符串模板（要用冒号绑定参数）
没有用Stream监听数据变化（导致界面不自动刷新）

四、数据库升级保命策略

核心问题：版本更新后老用户数据丢失怎么办？
去年某资讯APP就栽在这，损失了23%的日活。正确的升级姿势：

修改@Database注解里的版本号

dart**@Database(version: 2, entities: [User, Article])

实现迁移回调

dart**static Future<AppDatabase> init() async {  return await $FloorAppDatabase      .databaseBuilder('app_db.db')      .addMigrations([        Migration(1, 2, (database) async {          await database.execute('ALTER TABLE User ADD COLUMN bio TEXT');        })      ])      .build();}