Flutter数据库管理插件scientisst_db的使用

安装

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

dependencies:
  flutter:
    sdk: flutter
  scientisst_db: ^0.1.2

架构

数据库存储在应用程序文档目录中，该目录由 path_provider 提供。

数据库目录存储在一个名为 scientisst_db 的根文件夹中。

第一层仅包含 collections，每个 collection 都有一个对应的目录。每个 collection 目录由三个独立的文件夹组成：collections、documents 和 metadata。collection 的子 documents 存储在 documents 文件夹中，每个 document 都有自己的文件，文件名与 ObjectId 对应。ObjectId 是根据 MongoDB 的标准生成的，也可以是一个任意的 String。document 数据以 JSON 格式存储在文本文件中。

每个 document 都有一个对应的 metadata 文件，存储在 collection 目录内的 metadata 文件夹中，文件名与 ObjectId 相同，并且也是以 JSON 格式编码的。

一个 document 可以存储 collections（子集合），这些 collections 存储在父 collection 目录下的 collections 文件夹内。这个文件夹的文件名与 document 的 ObjectId 相同，并遵循相同的 collection 结构。

示例

完整的示例可以查看 这里。

一些基本示例：

添加文档到集合

DocumentReference doc = await ScientISSTdb.instance.collection("movies").add(
  {
    "title": "Eternal Sunshine of the Spotless Mind",
    "year": 2004,
    "characters": [
      "Joel",
      "Clementine",
    ],
  },
);

更新文档

await doc.update(
  {
    "title": "Hello world",
  },
);

删除文档

await ScientISSTdb.instance.collection("movies").document("507f1f77bcf86cd7994ca120").delete();

获取集合中的所有文档

await ScientISSTdb.instance.collection("movies").getDocuments();

按字段值排序文档

await ScientISSTdb.instance
    .collection("movies")
    .orderBy("year", ascending: false)
    .getDocuments();

示例代码

以下是在 main.dart 中使用 scientisst_db 插件的基本示例：

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Example(),
    );
  }
}

class Example extends StatefulWidget {
  [@override](/user/override)
  _ExampleState createState() => _ExampleState();
}

class _ExampleState extends State<Example> {
  [@override](/user/override)
  void initState() {
    super.initState();
    generateDB();
  }

  void generateDB() async {
    // 清除数据库
    await ScientISSTdb.clearDatabase(confirm: true);

    // 添加电影数据
    await ScientISSTdb.instance.collection("movies").add(
      {
        "title": "Eternal Sunshine of the Spotless Mind",
        "year": 2004,
        "characters": [
          "Joel",
          "Clementine",
        ],
      },
    );

    // 添加另一部电影及其演员
    DocumentReference inception = await ScientISSTdb.instance.collection("movies").add(
      {
        "title": "Inception",
        "year": 2010,
        "characters": [
          "Cobb",
          "Arthur",
          "Ariadne",
        ],
      },
    );

    await ScientISSTdb.instance
        .collection("movies")
        .document(inception.id)
        .collection("actors")
        .add(
      {
        "name": "Leonardo DiCaprio",
        "birthdate": DateTime(1974, 10, 11),
      },
    );

    await ScientISSTdb.instance
        .collection("movies")
        .document(inception.id)
        .collection("actors")
        .add(
      {
        "name": "Joseph Gordon-Levitt",
        "birthdate": DateTime(1981, 2, 17),
      },
    );

    // 更新UI状态
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Movies"),
      ),
      body: SafeArea(
        child: FutureBuilder(
          future: ScientISSTdb.instance
              .collection("movies")
              .orderBy("year", descending: false)
              .getDocuments(),
          builder: (BuildContext context,
              AsyncSnapshot<List<DocumentSnapshot>> snap) {
            if (snap.hasError || snap.data == null)
              return Container();
            else
              return ListView.builder(
                itemCount: snap.data!.length,
                itemBuilder: (BuildContext context, int index) => ListTile(
                  title: Text(
                    snap.data![index].data["title"],
                  ),
                  subtitle: Text(
                    snap.data![index].data["year"].toString(),
                  ),
                ),
              );
          },
        ),
      ),
    );
  }
}