Flutter数据持久化插件simple_json_persistence的使用

simple_json_persistence 是一个基于简单JSON文件的Flutter数据存储插件。它完全用Dart编写，无需与原生iOS/Android代码进行通信，并支持多种存储类型。下面是如何使用这个插件的详细指南。

主要特点

1. 纯Dart实现：不需要与原生代码交互。
2. 多存储支持：可以为不同类型的数据创建多个存储。
3. 适合中等规模数据集：适用于不适合使用SharedPreferences但又不想使用复杂数据库的场景。

开始使用

1. 创建数据模型

首先，你需要创建一个数据模型，并实现从JSON到对象和从对象到JSON的转换。这里推荐使用built_value或json_serializable库来简化这一过程。

import 'package:simple_json_persistence/simple_json_persistence.dart';

[@JsonSerializable](/user/JsonSerializable)(nullable: false)
class MyModel {
  MyModel({required this.property});

  factory MyModel.fromJson(Map<String, dynamic> json) => _$MyModelFromJson(json);

  Map<String, dynamic> toJson() => _$MyModelToJson(this);

  final String property;
}

2. 初始化存储并保存/加载数据

接下来，初始化SimpleJsonPersistence实例，并保存或加载数据。

void doSomething() async {
  // 初始化存储
  final store = SimpleJsonPersistence.forType(
    (json) => MyModel.fromJson(json),
    name: 'MyModel',
  );

  // 保存数据
  await store.save(MyModel(property: 'foo'));

  // 加载数据
  final foo = await store.load();

  // 监听值变化
  store.onValueChanged.listen((newValue) {
    print('got a new value $newValue');
  });
}

在Flutter应用中使用（StreamBuilder）

你可以将SimpleJsonPersistence与StreamBuilder结合使用，以便在数据变化时自动更新UI。

Widget build(BuildContext context) {
  final store = SimpleJsonPersistence.forType(
      (json) => AppData.fromJson(json),
      defaultCreator: () => AppData(counter: 0));

  return StreamBuilder<AppData>(
    stream: store.onValueChangedAndLoad,
    initialData: store.cachedValue,
    builder: (context, snapshot) => Text('Counter: ${snapshot.data?.counter ?? 'Loading'}'),
  );
}

完整示例

以下是一个完整的示例，展示了如何在一个简单的计数器应用中使用simple_json_persistence：

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

// 数据模型
[@JsonSerializable](/user/JsonSerializable)(nullable: false)
class AppData {
  AppData({required this.counter});

  factory AppData.fromJson(Map<String, dynamic> json) => _$AppDataFromJson(json);
  Map<String, dynamic> toJson() => _$AppDataToJson(this);

  final int counter;
}

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(primarySwatch: Colors.blue),
      home: const SimpleCounter(),
    );
  }
}

class SimpleCounter extends StatelessWidget {
  const SimpleCounter({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    final store = SimpleJsonPersistence.getForTypeSync(
      (json) => AppData.fromJson(json),
      defaultCreator: () => AppData(counter: 0),
      name: 'AppData',
    );

    return StreamBuilder<AppData?>(
        stream: store.onValueChangedAndLoad,
        initialData: store.cachedValue,
        builder: (context, snapshot) {
          final data = snapshot.data;
          return Scaffold(
            appBar: AppBar(title: const Text('SimpleJsonPersistence Example')),
            body: Center(
              child: Padding(
                padding: const EdgeInsets.all(16.0),
                child: Column(
                  mainAxisAlignment: MainAxisAlignment.center,
                  children: data == null
                      ? <Widget>[const Center(child: CircularProgressIndicator())]
                      : <Widget>[
                          const Text(
                            'You have pushed the button:',
                            textAlign: TextAlign.center,
                          ),
                          Row(
                            mainAxisSize: MainAxisSize.min,
                            children: <Widget>[
                              Text(
                                '${data.counter}',
                                style: Theme.of(context).textTheme.headlineSmall,
                              ),
                              const Text(' times')
                            ],
                          ),
                          const SizedBox(height: 32),
                          const Text(
                            'Value will be persisted on every touch, so feel free to restart the app at any time.',
                            textScaler: TextScaler.linear(0.75),
                            textAlign: TextAlign.center,
                          ),
                        ],
                ),
              ),
            ),
            floatingActionButton: FloatingActionButton(
              onPressed: () => store.save(AppData(counter: (data?.counter ?? 0) + 1)),
              tooltip: 'Increment',
              child: const Icon(Icons.add),
            ),
          );
        });
  }
}