Flutter共享对象管理插件shared_objects的使用

概念

在创建可持久化的值时，通常需要一些样板代码。例如：

import 'package:shared_preferences/shared_preferences.dart';

String? _value;

Future<void> setValue(String newValue) async {
  final sharedPrefs = await SharedPreferences.getInstance();
  await sharedPrefs.setString('name', newValue);
}

Future<String?> getValue() async {
  final sharedPrefs = await SharedPreferences.getInstance();
  return sharedPrefs.getString('name');
}

shared_objects 包旨在将这些样板代码简化为更简洁的实现。例如：

import 'package:shared_objects/shared_objects.dart';

final value = SharedString('name');
await value.set('newValue');
await value.get();

开始使用

在项目中添加依赖项，使用以下命令：

flutter pub add shared_objects

使用方法

定义一个可持久化的对象的基本类是显式类型的 SharedObjectBase 类。所有可持久化的对象都包含以下组件：

• id: 与该对象关联的唯一 String 键。
• set(T?): 异步设置该对象的新值。如果新值为 null，则删除对象的内容，并从 SharedPreferences 映射中移除 id。
• get(): 异步获取该对象的当前值。
• mutate(T? Function(T?)): 异步通过传递一个函数来修改对象的值。该函数通过 get() 获取初始值，并必须返回更新后的值。如果初始值等于更新后的值，则不进行任何更改，跳过对 set(T?) 的调用。

该包已经包括了几个方便的基类扩展。这包括以下类：

• SharedBool: 可持久化的 bool。
• SharedDouble: 可持久化的 double，具有算术扩展（add、sub、mul、div、pow）。
• SharedInt: 可持久化的 int，具有算术扩展（add、sub、mul、div、pow）。
• SharedString: 可持久化的 String，具有 append 扩展。
• SharedStringList: 可持久化的 List<String>，具有列表扩展（add、addAll、remove）。

完整示例

以下是一个完整的示例，展示了如何使用 shared_objects 插件来注入带有持久化状态的对象。

import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import 'package:shared_objects/shared_objects.dart';

// 使用 shared_objects 注入具有持久化状态的对象。
class SharedObjectProvider {
  final count = SharedInt('count');
  final toggle = SharedBool('toggle');

  Future<void> setDefaults() async {
    // 初始化计数器
    count.mutate((initial) => initial ?? 0);
    // 初始化开关
    toggle.mutate((initial) => initial ?? false);
  }
}

Future<void> main() async {
  final sharedObjectProvider = SharedObjectProvider();
  await sharedObjectProvider.setDefaults();
  WidgetsFlutterBinding.ensureInitialized();

  runApp(Provider.value(
    value: sharedObjectProvider,
    child: const MyApp(),
  ));
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

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

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

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

class _MyHomePageState extends State<MyHomePage> {
  late final _count = context.read<SharedObjectProvider>().count;
  late final _toggle = context.read<SharedObjectProvider>().toggle;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('shared_objects'),
      ),
      body: Center(
        child: Row(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
          children: [
            OutlinedButton(
              child: const Text('Increment'),
              onPressed: () async {
                await _count.add(1);
                setState(() {});
              },
            ),
            FutureBuilder(
              future: _count.get(),
              initialData: -1,
              builder: (context, snapshot) {
                final data = snapshot.data as int;
                return Text('Current count: $data');
              },
            ),
            FutureBuilder(
              future: _toggle.get(),
              initialData: false,
              builder: (context, snapshot) {
                final data = snapshot.data as bool;
                return Switch(
                  value: data,
                  onChanged: (newState) {
                    _toggle.set(newState);
                    setState(() {});
                  },
                );
              },
            )
          ],
        ),
      ),
    );
  }
}