devbox
我家自动化
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Flutter 数据存储--shared_preferences使用详情

作者：我家自动化 | 2024-03-25 09:47:19

赞

踩

shared_preferences

1.shared_preferences介绍

shared_preferences主要的作用是用于将数据异步持久化到磁盘，因为持久化数据只是存储到临时目录，当app删除时该存储的数据就是消失，web开发时清除浏览器存储的数据也将消失。

支持存储类型：

  • bool
  • int
  • double
  • string
  • stringList

shared_preferences应用场景

主要用于持久化数据，如持久化用户信息、列表数据等。

持久化用户信息

因为用户信息基本是不改变的，而在一个应用程序中常常会有多个页面需要展示用户信息，我们不可能每次都去获取接口，那么本地持久化就会变得很方便。

持久化列表数据

为了给用户更好的体验，在获取列表数据时我们常常会先展示旧数据，带给用户更好的体验，不至于一打开页面就是空白的，当我们采用持久化列表数据后，可以直接先展示本地数据，当网络数据请求回来后在进行数据更新。

shared_preferences使用的对应类库

我们知道每个平台持久化数据的方式都不一样，而shared_preferences针对不同的平台封装了一个通用的类库，接下来我们看看不同平台下他们使用的库：

  • iOS： NSUserDefaults
  • Android： SharedPreferences
  • Web： localStorage
  • Linux： FileSystem（保存数据到本地系统文件库中）
  • Mac OS： FileSystem（保存数据到本地系统文件库中）
  • Windows： FileSystem（保存数据到本地系统文件库中）

2.shared_preferences基本使用

导入头文件

import 'package:shared_preferences/shared_preferences.dart';

获取实例对象

SharedPreferences? sharedPreferences = await SharedPreferences.getInstance();

2.1.持久化数据的存储和读取

我们可以通过sharedPreferences的实例化对象调用对应的set方法设置持久化数据,通过get方法进行获取.

  1. import 'package:flutter/material.dart';
  2. import 'package:shared_preferences/shared_preferences.dart';
  3.  
  4. class SharedPreferencesExample extends StatefulWidget {
  5.   @override
  6.   _SharedPreferencesExampleState createState() => _SharedPreferencesExampleState();
  7. }
  8.  
  9. class _SharedPreferencesExampleState extends State<SharedPreferencesExample> {
  10.  
  11.  
  12.   SharedPreferences? sharedPreferences;
  13.  
  14.   // 设置持久化数据
  15.   void _setData() async {
  16.     // 实例化
  17.     sharedPreferences = await SharedPreferences.getInstance();
  18.  
  19.     // 设置string类型
  20.     await sharedPreferences?.setString("name", "Jimi");
  21.  
  22.     // 设置int类型
  23.     await sharedPreferences?.setInt("age", 18);
  24.  
  25.     // 设置bool类型
  26.     await sharedPreferences?.setBool("isTeacher", true);
  27.  
  28.     // 设置double类型
  29.     await sharedPreferences?.setDouble("height", 1.88);
  30.  
  31.     // 设置string类型的数组
  32.     await sharedPreferences?.setStringList("action", ["吃饭", "睡觉", "打豆豆"]);
  33.  
  34.     setState(() {});
  35.   }
  36.  
  37.  
  38.   @override
  39.   Widget build(BuildContext context) {
  40.     return Scaffold(
  41.       appBar: AppBar(
  42.         title: Text("SharedPreferences"),
  43.       ),
  44.       floatingActionButton: FloatingActionButton(
  45.         onPressed: _setData,
  46.         child: Icon(Icons.add),
  47.       ),
  48.       body: Center(
  49.         child: Column(
  50.           mainAxisAlignment: MainAxisAlignment.center,
  51.           crossAxisAlignment: CrossAxisAlignment.center,
  52.           children: [
  53.             Text("名字: ${sharedPreferences?.getString("name") ?? ""}",
  54.                  style: TextStyle(
  55.                    color: Colors.blue,
  56.                    fontSize: 20
  57.                  ),
  58.                 ),
  59.             SizedBox(height: 20,),
  60.             Text("年龄: ${sharedPreferences?.getInt("age") ?? ""}",
  61.                  style: TextStyle(
  62.                    color: Colors.red,
  63.                    fontSize: 20
  64.                  ),
  65.                 ),
  66.             SizedBox(height: 20,),
  67.             Text("是老师吗?: ${sharedPreferences?.getBool("isTeacher") ?? ""}",
  68.                  style: TextStyle(
  69.                    color: Colors.orange,
  70.                    fontSize: 20
  71.                  ),
  72.                 ),
  73.             SizedBox(height: 20,),
  74.             Text("身高: ${sharedPreferences?.getDouble("height") ?? ""}",
  75.                  style: TextStyle(
  76.                    color: Colors.pink,
  77.                    fontSize: 20
  78.                  ),
  79.                 ),
  80.             SizedBox(height: 20,),
  81.             Text("我正在: ${sharedPreferences?.getStringList("action") ?? ""}",
  82.                  style: TextStyle(
  83.                    color: Colors.purple,
  84.                    fontSize: 20
  85.                  ),
  86.                 ),
  87.           ],
  88.         ),
  89.       ),
  90.     );
  91.   }
  92. }

  2.2. 获取持久化数据中所有存入的key

  1. List<String> keys = sharedPreferences?.getKeys().toList() ?? [];
  2. print(keys);
  3.  
  4. // 控制台输出
  5. [name, age, isTeacher, height, action]

2.3.判断持久化数据中是否包含某个key

  1. bool isContainKey = sharedPreferences?.containsKey("name") ?? false;
  2. print(isContainKey);
  3.  
  4. // 控制台输出
  5. flutter: true

2.4.删除持久化数据中某个key

  1. bool isRemoveKey = await sharedPreferences?.remove("name") ?? false;
  2. print(isRemoveKey);
  3.  
  4. // 控制台输出
  5. flutter: true

2.5.清除所有持久化数据

  1. bool isClearAllKey = await sharedPreferences?.clear() ?? false;
  2. print(isClearAllKey);
  3.  
  4. // 控制台输出
  5. flutter: true

2.6.重新加载所有数据（仅重载运行时）

await sharedPreferences?.reload();

3.shared_preferences封装

我们在使用shared_preferences时每次都需要去获取它的实例，如果多个地方用到，那么每次都要实例化一次。这样代码的可读性差，后期的维护成本也变得很高，而且还不支持存储Map类型，所以接下来我们对shared_preferences来封装一个通用而且使用更简单的库。

使用单例模式进行shared_preferences封装

因为我们获取的都是同一个实例，所以采用单例模式来进行封装最好，而且获取实例是异步的，所以我们在应用程序启动时先初始化，这样使用起来更加的方便。

创建单例类

因为我们代码都是采用了空安全，所以空安全里面有个非常重要的属性late来延迟加载我们实例，如下.

  1. class JSpUtil {
  2.  
  3.   JSpUtil._internal();
  4.   
  5.   factory JSpUtil() => _instance;
  6.  
  7.   static late final JSpUtil _instance = JSpUtil._internal();
  8. }

初始化shared_preferences

因为采用单例模式，所以在获取唯一实例的时候我们在入口统一获取一次即可。

  1. static late SharedPreferences _preferences;
  2.  
  3. static Future<JSpUtil> getInstance() async {
  4.   _preferences = await SharedPreferences.getInstance();
  5.   return _instance;
  6. }

封装方式一：对应get、set方法

  1. /// 根据key存储int类型
  2. static Future<bool> setInt(String key, int value) {
  3.   return _preferences.setInt(key, value);
  4. }
  5.  
  6. /// 根据key获取int类型
  7. static int? getInt(String key, {int defaultValue = 0}) {
  8.   return _preferences.getInt(key) ?? defaultValue;
  9. }
  10.  
  11. /// 根据key存储double类型
  12. static Future<bool> setDouble(String key, double value) {
  13.   return _preferences.setDouble(key, value);
  14. }
  15.  
  16. /// 根据key获取double类型
  17. static double? getDouble(String key, {double defaultValue = 0.0}) {
  18.   return _preferences.getDouble(key) ?? defaultValue;
  19. }
  20.  
  21. /// 根据key存储字符串类型
  22. static Future<bool> setString(String key, String value) {
  23.   return _preferences.setString(key, value);
  24. }
  25.  
  26. /// 根据key获取字符串类型
  27. static String? getString(String key, {String defaultValue = ""}) {
  28.   return _preferences.getString(key) ?? defaultValue;
  29. }
  30.  
  31. /// 根据key存储布尔类型
  32. static Future<bool> setBool(String key, bool value) {
  33.   return _preferences.setBool(key, value);
  34. }
  35.  
  36. /// 根据key获取布尔类型
  37. static bool? getBool(String key, {bool defaultValue = false}) {
  38.   return _preferences.getBool(key) ?? defaultValue;
  39. }
  40.  
  41. /// 根据key存储字符串类型数组
  42. static Future<bool> setStringList(String key, List<String> value) {
  43.   return _preferences.setStringList(key, value);
  44. }
  45.  
  46. /// 根据key获取字符串类型数组
  47. static List<String> getStringList(String key, {List<String> defaultValue = const []}) {
  48.   return _preferences.getStringList(key) ?? defaultValue;
  49. }
  50.  
  51. /// 根据key存储Map类型
  52. static Future<bool> setMap(String key, Map value) {
  53.   return _preferences.setString(key, json.encode(value));
  54. }
  55.  
  56. /// 根据key获取Map类型
  57. static Map getMap(String key) {
  58.   String jsonStr = _preferences.getString(key) ?? "";
  59.   return jsonStr.isEmpty ? Map : json.decode(jsonStr);
  60. }

封装方式二：统一set、get方法

  1. /// 通用设置持久化数据
  2. static setLocalStorage<T>(String key, T value) {
  3.   String type = value.runtimeType.toString();
  4.  
  5.   switch (type) {
  6.     case "String":
  7.       setString(key, value as String);
  8.       break;
  9.     case "int":
  10.       setInt(key, value as int);
  11.       break;
  12.     case "bool":
  13.       setBool(key, value as bool);
  14.       break;
  15.     case "double":
  16.       setDouble(key, value as double);
  17.       break;
  18.     case "List<String>":
  19.       setStringList(key, value as List<String>);
  20.       break;
  21.     case "_InternalLinkedHashMap<String, String>":
  22.       setMap(key, value as Map);
  23.       break;
  24.   }
  25. }
  26.  
  27. /// 获取持久化数据
  28. static dynamic getLocalStorage<T>(String key) {
  29.   dynamic value = _preferences.get(key);
  30.   if (value.runtimeType.toString() == "String") {
  31.     if (_isJson(value)) {
  32.       return json.decode(value);
  33.     }
  34.   }
  35.   return value;
  36. }

两种封装的使用方式

  1. // 设置String类型
  2. await JSpUtil.setString("name", "Jimi");
  3.  
  4. // 设置int类型
  5. await JSpUtil.setInt("age", 18);
  6.  
  7. // 设置bool类型
  8. await JSpUtil.setBool("isTeacher", true);
  9.  
  10. // 设置double类型
  11. await JSpUtil.setDouble("height", 1.88);
  12.  
  13. // 设置string类型的数组
  14. await JSpUtil.setStringList("action", ["吃饭", "睡觉", "打豆豆"]);
  15.  
  16. // 设置Map类型
  17. await JSpUtil.setMap("weight", {"weight": 112});
  18.  
  19. JSpUtil.setLocalStorage("name", "Jimi");
  20. JSpUtil.setLocalStorage("age", 18);
  21. JSpUtil.setLocalStorage("isTeacher", true);
  22. JSpUtil.setLocalStorage("height", 1.88);
  23. JSpUtil.setLocalStorage("action", ["吃饭", "睡觉", "打豆豆"]);
  24. JSpUtil.setLocalStorage("weight", {"weight": "112"});
  25.  
  26. JSpUtil.getLocalStorage("name");
  27. JSpUtil.getLocalStorage("age");
  28. JSpUtil.getLocalStorage("isTeacher");
  29. JSpUtil.getLocalStorage("height");
  30. JSpUtil.getLocalStorage("action");
  31. JSpUtil.getLocalStorage("weight");
  32.  
  33.  
  34. // 获取磁盘中所有存入的key
  35. List<String> keys = JSpUtil.getKeys().toList();
  36. print(keys);
  37.  
  38. // 持久化数据中是否包含某个key
  39. bool isContainKey = JSpUtil.containsKey("name");
  40. print(isContainKey);
  41.  
  42. // 删除持久化数据中某个key
  43. bool isRemoveKey = await JSpUtil.remove("name");
  44. print(isRemoveKey);
  45.  
  46. // 清除所有持久化数据
  47. bool isClearAllKey = await JSpUtil.clear();
  48. print(isClearAllKey);
  49.  
  50. // 重新加载所有数据,仅重载运行时
  51. await JSpUtil.reload();

获取值的方式

  1. Text("名字: ${JSpUtil.getString("name")}",
  2.      style: TextStyle(
  3.        color: Colors.blue,
  4.        fontSize: 20
  5.      ),
  6.     ),
  7. SizedBox(height: 20,),
  8. Text("年龄: ${JSpUtil.getInt("age")}",
  9.      style: TextStyle(
  10.        color: Colors.red,
  11.        fontSize: 20
  12.      ),
  13.     ),
  14. SizedBox(height: 20,),
  15. Text("是老师吗?: ${JSpUtil.getBool("isTeacher")}",
  16.      style: TextStyle(
  17.        color: Colors.orange,
  18.        fontSize: 20
  19.      ),
  20.     ),
  21. SizedBox(height: 20,),
  22. Text("身高: ${JSpUtil.getDouble("height")}",
  23.      style: TextStyle(
  24.        color: Colors.pink,
  25.        fontSize: 20
  26.      ),
  27.     ),
  28. SizedBox(height: 20,),
  29. Text("我正在: ${JSpUtil.getStringList("action")}",
  30.      style: TextStyle(
  31.        color: Colors.purple,
  32.        fontSize: 20
  33.      ),
  34.     ),

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家自动化/article/detail/308725
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号