当前位置：首页 > news >正文

SharedPreferences基础：Flutter在鸿蒙平台实现轻量级数据存储

news 2026/7/25 7:27:58

一、什么是SharedPreferences

SharedPreferences是一种轻量级的键值对存储机制，广泛应用于移动应用开发中。它提供了一种简单、高效的方式来存储和读取应用的配置信息、用户偏好设置等少量数据。

1.1 SharedPreferences的特点

特性	说明
存储类型	键值对（Key-Value）
数据类型	基本类型（String、int、double、bool、List）
存储位置	应用私有目录下的XML文件
适用场景	配置信息、用户偏好、少量数据缓存
数据大小	建议不超过100KB

1.2 在Flutter中的实现

Flutter通过shared_preferences包提供了对SharedPreferences的支持。这个包是一个Flutter社区维护的插件，支持Android、iOS、Web等多个平台，包括鸿蒙平台。

二、集成与配置

2.1 添加依赖

在项目的pubspec.yaml文件中添加shared_preferences依赖：

dependencies:flutter:sdk:fluttershared_preferences:^2.2.2

然后运行flutter pub get命令获取依赖。

2.2 鸿蒙平台特殊配置

在鸿蒙平台上使用SharedPreferences时，需要确保应用具有正确的权限配置。在module.json5文件中添加以下配置：

{"module":{"abilities":[],"requestPermissions":[{"name":"ohos.permission.WRITE_USER_DATA","reason":"需要写入用户数据","usedScene":{"abilities":["MainAbility"],"when":"always"}},{"name":"ohos.permission.READ_USER_DATA","reason":"需要读取用户数据","usedScene":{"abilities":["MainAbility"],"when":"always"}}]}}

三、基本操作

3.1 获取SharedPreferences实例

import'package:shared_preferences/shared_preferences.dart';Future<void>main()async{WidgetsFlutterBinding.ensureInitialized();SharedPreferencesprefs=awaitSharedPreferences.getInstance();}

3.2 存储数据

SharedPreferences支持以下数据类型的存储：

// 存储字符串awaitprefs.setString('username','张三');// 存储整数awaitprefs.setInt('age',25);// 存储浮点数awaitprefs.setDouble('score',98.5);// 存储布尔值awaitprefs.setBool('isVip',true);// 存储字符串列表awaitprefs.setStringList('tags',['Flutter','HarmonyOS','Dart']);

3.3 读取数据

// 读取字符串String?username=prefs.getString('username');// 读取整数int?age=prefs.getInt('age');// 读取浮点数double?score=prefs.getDouble('score');// 读取布尔值bool?isVip=prefs.getBool('isVip');// 读取字符串列表List<String>?tags=prefs.getStringList('tags');

3.4 删除数据

// 删除单个键awaitprefs.remove('username');// 清空所有数据awaitprefs.clear();

3.5 检查键是否存在

bool hasKey=prefs.containsKey('username');

3.6 获取所有键

Set<String>keys=prefs.getKeys();

四、实际应用示例

4.1 用户登录状态保存

classAuthService{staticconstString_keyToken='auth_token';staticconstString_keyUserId='user_id';staticconstString_keyUsername='username';staticFuture<void>saveUser(Stringtoken,StringuserId,Stringusername)async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();awaitprefs.setString(_keyToken,token);awaitprefs.setString(_keyUserId,userId);awaitprefs.setString(_keyUsername,username);}staticFuture<Map<String,String?>>getUser()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();return{'token':prefs.getString(_keyToken),'userId':prefs.getString(_keyUserId),'username':prefs.getString(_keyUsername),};}staticFuture<void>logout()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();awaitprefs.remove(_keyToken);awaitprefs.remove(_keyUserId);awaitprefs.remove(_keyUsername);}staticFuture<bool>isLoggedIn()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();returnprefs.containsKey(_keyToken);}}

4.2 应用主题设置

classThemeService{staticconstString_keyThemeMode='theme_mode';staticconstString_keyPrimaryColor='primary_color';staticFuture<void>saveTheme(ThemeModemode,Colorcolor)async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();awaitprefs.setString(_keyThemeMode,mode.name);awaitprefs.setInt(_keyPrimaryColor,color.value);}staticFuture<ThemeMode>getThemeMode()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();String?mode=prefs.getString(_keyThemeMode);returnmode!=null?ThemeMode.values.firstWhere((m)=>m.name==mode):ThemeMode.system;}staticFuture<Color>getPrimaryColor()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();int?colorValue=prefs.getInt(_keyPrimaryColor);returncolorValue!=null?Color(colorValue):Colors.blue;}}

4.3 应用设置保存

classAppSettings{staticconstString_keyNotifications='notifications';staticconstString_keySoundEnabled='sound_enabled';staticconstString_keyAutoUpdate='auto_update';staticconstString_keyLanguage='language';staticFuture<void>saveSettings({required bool notifications,required bool soundEnabled,required bool autoUpdate,requiredStringlanguage,})async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();awaitprefs.setBool(_keyNotifications,notifications);awaitprefs.setBool(_keySoundEnabled,soundEnabled);awaitprefs.setBool(_keyAutoUpdate,autoUpdate);awaitprefs.setString(_keyLanguage,language);}staticFuture<Map<String,dynamic>>getSettings()async{SharedPreferencesprefs=awaitSharedPreferences.getInstance();return{'notifications':prefs.getBool(_keyNotifications)??true,'soundEnabled':prefs.getBool(_keySoundEnabled)??true,'autoUpdate':prefs.getBool(_keyAutoUpdate)??false,'language':prefs.getString(_keyLanguage)??'zh',};}}