Flutter共享偏好设置插件solid_shared_pref的使用

描述

通过Solid Shared Preference，你可以在顶级文件中声明一次你的偏好，并且不再需要关心其键和类型。它会记住其类型和键。因此，出错的机会为零。它甚至可以区分可空和不可空类型。默认情况下，偏好值是非可空的。

我们推荐一个单一全局常量对应一个单一偏好，但也可以创建局部偏好。

使用方法

1. 添加依赖

在你的pubspec.yaml文件中添加以下行：

dependencies:
  solid_shared_pref: ^1.0.0

2. 导入包

在你的main.dart文件中导入该包：

import 'package:solid_shared_pref/solid_shared_pref.dart';

3. 初始化

将你的主函数设为异步，并调用以下两个函数以确保初始化完成：

void main() async {
  /// 初始化静态共享偏好
  WidgetsFlutterBinding.ensureInitialized();
  await initSolidSharedPreferences();
  runApp(const MyApp());
}

4. 创建偏好变量/常量

推荐尽可能地创建常量。因为偏好对象只包含键和默认值，所以创建常量不会影响偏好值（这将提高性能）。

创建一个文件来存储所有顶级常量/变量，以便在整个应用中访问它们。

创建一个整数类型的偏好

const counterPreference = IntPreference('my_counter', 0);
// IntPreference(key, defaultValue);

读取其值

final counter = counterPreference.value;

更新其值

counterPreference.value++;

设置值为null

由于偏好非可空，默认情况下将值设置为null会导致编译错误。为了使用可空偏好，应使用NullableIntPreference对象：

counterPreference.value = null; /// 编译时错误
const nullableCounter = NullableIntPreference('my_nullable_counter', 0);
nullableCounter.value = null;  /// 可以

移除值

counterPreference.remove();

创建自定义对象的偏好

final jokeMetadata = CustomPreference<JokeMetadata>(
    'joke_metadata', JokeMetadata.defaultValue(),
    fromJson: (json) => JokeMetadata.fromJson(json),
    toJson: (metadata) => metadata.toJson);
// CustomPreference(key, defaultValue , {fromJson, toJson});

fromJson: 将Map<String, dynamic>转换为对象的函数

toJson: 将对象转换为Map<String, dynamic>的函数

现在你可以为你的自定义类享受所有基本功能了。

示例代码

以下是一个完整的示例代码，展示了如何使用solid_shared_pref插件：

import 'package:example/counter.dart';
import 'package:example/preferences.dart';
import 'package:flutter/material.dart';
import 'package:solid_shared_pref/solid_shared_pref.dart';

void main() async {
  /// 初始化静态共享偏好
  WidgetsFlutterBinding.ensureInitialized();
  await initSolidSharedPreferences();
  runApp(const MyApp());
}

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

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

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

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  void _incrementCounter() {
    setState(() {
      /// 更新偏好值使其持久化
      counterPreference.value =
          Counter('NEw value', counterPreference.value.value + 1);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              /// 从偏好中读取值
              '${counterPreference.value.value}',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}