Flutter插件flutter_pom的使用方法介绍

引言

flutter_pom 是一个基于 sqflite 的 Flutter 插件，提供了基于模型的 SQLite 访问功能，并支持自动数据库创建。本文将通过完整的示例代码展示如何在 Flutter 应用中使用 flutter_pom 插件。

安装与配置

1. 添加依赖

在项目的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter_pom: ^0.0.3

2. 安装插件

通过命令行安装插件：

$ flutter pub get

3. 导入插件

在 Dart 源文件中导入插件：

import 'package:flutter_pom/flutter_pom.dart';

flutter_pom示例代码

以下是一个完整的示例，展示了如何使用 flutter_pom 插件进行数据库操作。

1. 创建表模型

定义表模型 SampleTable，该模型描述了表的结构和字段。

class SampleTable extends Table {
  SampleTable() : super("sample_table");

  final IdField id = IdField("id").autoIncrement();
  final StringField str = StringField("str").notNull("");

  [@override](/user/override)
  Table getInstance() {
    return SampleTable();
  }

  [@override](/user/override)
  List<Field> initializeFields() {
    return [id, str];
  }
}

2. 创建数据库模型

定义数据库模型 SampleDb，包含所有需要访问的表。

class SampleDb extends Database {
  SampleDb() : super("sample.db");

  [@override](/user/override)
  Map<Type, Table> initializeDatabase() {
    return {
      SampleTable: SampleTable(),
    };
  }
}

3. 使用数据库

在应用逻辑中使用数据库进行增删改查操作。

void Do() async {
  // 初始化数据库
  var db = SampleDb();

  // 打开数据库连接
  await db.open();

  // 获取表上下文
  var context = await db.of<SampleTable>();

  // 创建新记录
  var sampleItem = SampleTable();
  sampleItem.str.value = "String value";

  // 插入数据
  await context.put(sampleItem);

  // 查询所有记录
  var itemsFilter = await context.select();

  // 复杂查询（过滤、排序、分页）
  var itemsFilter2 = await context.select((q) {
    return q
        .where(c.fields.idField.gte(3))
        .and(c.fields.idField.lte(20))
        .orderByAsc([c.fields.idField])
        .limit(40)
        .offset(2);
  });

  // 删除记录
  await context.delete(sampleItem);

  // 更新记录
  await context.update(sampleItem);

  // 监听新增事件
  context.onCreate.listen((item) {
    print("New item added: $item");
  });
}

关系表的支持

从版本 0.1.23 开始，flutter_pom 支持关系表绑定。以下是一个示例，展示如何定义和使用关系表。

1. 定义关系表

class User extends Table {
  StringField userName = StringField("user_name").notNull();

  KeyField<Job> job = KeyField<Job>("job_id");
}

class Job extends Table {
  StringField jobName = StringField("job_name").notNull();
}

2. 添加用户并绑定工作

void addUser(User user, Job job) async {
  var users = await db.of<User>();
  var jobs = await db.of<Job>();

  user.job.binding = job;

  await jobs.put(job);
  await users.put(user);
}

3. 查询用户并解析工作

void getUsers() async {
  var users = await db.of<User>();
  var jobs = await db.of<Job>();

  var userList = users.select().include<Job>(db, User().job);
}

索引支持

可以通过 .withIndex() 方法为字段添加索引。

StringField email = StringField("email").withIndex(unique: true);

事务支持

从版本 0.1.26 开始，flutter_pom 支持事务管理。

var txn = db.transaction();

await db.of<User>().add(newUser, txn);
await db.of<User>().deleteById(5, txn);

await txn.commit();

完整示例代码

以下是一个完整的示例代码，展示如何在 Flutter 应用中使用 flutter_pom 插件。

import 'package:flutter/material.dart';
import 'package:flutter_pom/flutter_pom.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter POM Demo',
      home: MyHomePage(title: 'Flutter POM Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() async {
    var db = SampleDb();
    await db.open();

    var c1 = await db.of<SampleTable>();
    var c2 = await db.of<SampleTable2>();

    var item1 = SampleTable();
    item1.counterValue.value = _counter + 1;
    item1.dateTime.value = DateTime.now();

    await c1.put(item1);

    var item = SampleTable2();
    item.counterValue.value = _counter + 1;
    item.dateTime.value = DateTime.now();
    item.keyField.binding = item1;

    await c2.put(item);

    var itemRef = await c2.select();
    var items = await itemRef.include<SampleTable>(db, SampleTable2().keyField);

    print(items);

    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('You have pushed the button this many times:'),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}