Flutter本地数据存储插件simple_shared_pref的使用

Flutter本地数据存储插件simple_shared_pref的使用

SimpleSharedPref

SimpleSharedPref 是一个 Flutter 包，它提供了方便地访问共享偏好设置的功能。它遵循单例设计模式，允许你方便地在共享偏好设置中存储和检索数据。它还支持使用 CryptoModule 类对敏感数据进行可选的加密和解密。

安装

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

dependencies:
  simple_shared_pref: ^2.0.0

使用

在你的 Dart 文件中导入包和 SimpleSharedPref 类：

import 'package:simple_shared_pref/simple_shared_pref.dart';

创建一个 SimpleSharedPref 的实例：

SimpleSharedPref sharedPref = SimpleSharedPref();

初始化共享偏好设置，建议在主函数或应用程序启动时调用：

void main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await sharedPref.init();
    runApp(MyApp());
}

存储和检索值

你可以存储和检索各种类型的值到共享偏好设置中：

// 存储整数值
sharedPref.setValue<int>('counter', 10);

// 检索整数值
int? counterValue = sharedPref.getValue<int>('counter');

// 存储字符串值
sharedPref.setValue<String>('username', 'JohnDoe');

// 检索字符串值
String? username = sharedPref.getValue<String>('username');

// 存储布尔值
sharedPref.setValue<bool>('isLoggedIn', true);

// 检索布尔值
bool? isLoggedIn = sharedPref.getValue<bool>('isLoggedIn');

移除值

要从共享偏好设置中移除一个值，可以使用 removeValue 方法：

sharedPref.removeValue('counter');

检查值是否存在

你可以使用 containsKey 方法检查一个值是否存在于共享偏好设置中：

bool isUsernameStored = sharedPref.containsKey('username');

清除共享偏好设置

要清除所有存储在共享偏好设置中的值，可以使用 clear 方法：

sharedPref.clear();

示例代码

以下是一个完整的示例代码，展示了如何使用 SimpleSharedPref 插件来存储和检索不同类型的值：

import 'package:example/SharedPrefEnum.dart';
import 'package:flutter/material.dart';
import 'package:simple_shared_pref/simple_shared_pref.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await SimpleSharedPref().init(allowEncryptAndDecrypt: true);
  runApp(MyApp());
}

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    setDataToShared();
  }

  void setDataToShared() async {
    await SimpleSharedPref().setValue<int>(value: 2, key: SharedPrefEnum.id);
    await SimpleSharedPref().setValue<double>(value: 2.2, key: SharedPrefEnum.price);
    await SimpleSharedPref().setValue<bool>(value: true, key: SharedPrefEnum.selected);
    await SimpleSharedPref().setValue<String>(value: 'Product', key: SharedPrefEnum.name);
    await SimpleSharedPref().setValue<List<String>>(
        value: ['Product1', 'Product2', 'Product3'], key: SharedPrefEnum.namesList);
  }

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

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

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

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.center,
          children: <Widget>[
            ListView(
              padding: EdgeInsets.all(20.0),
              shrinkWrap: true,
              children: [
                Text('id: ${SimpleSharedPref().getValue<int>(key: SharedPrefEnum.id)?.toString() ?? "Not Found"}'),
                Text('price: ${SimpleSharedPref().getValue<double>(key: SharedPrefEnum.price)?.toString() ?? "Not Found"}'),
                Text('product: ${SimpleSharedPref().getValue<String>(key: SharedPrefEnum.name)?.toString() ?? "Not Found"}'),
                Text('selected: ${SimpleSharedPref().getValue<bool>(key: SharedPrefEnum.selected)?.toString() ?? "Not Found"}'),
                Text(SimpleSharedPref().getValue<List<String>>(key: SharedPrefEnum.namesList)?.toString() ?? "Not Found"),
              ],
            )
          ],
        ),
      ),
    );
  }
}