qs_storage_tool
一个基于 shared_preferences 的 Flutter 本地键值存储工具,提供统一的静态方法读写常用数据类型。
支持平台
- Android
- iOS
安装
在项目的 pubspec.yaml 中添加依赖:
dependencies:
qs_storage_tool: ^1.0.0
然后执行:
flutter pub get
导入
import 'package:qs_storage_tool/qs_storage_tool.dart';
使用方法
所有方法均为静态异步方法,无需创建 QsStorageTool 实例。
bool
final bool saved = await QsStorageTool.setBool(
key: 'isFirstLaunch',
value: false,
);
final bool? isFirstLaunch = await QsStorageTool.getBool(
key: 'isFirstLaunch',
);
double
final bool saved = await QsStorageTool.setDouble(
key: 'volume',
value: 0.8,
);
final double? volume = await QsStorageTool.getDouble(
key: 'volume',
);
int
final bool saved = await QsStorageTool.setInt(
key: 'launchCount',
value: 10,
);
final int? launchCount = await QsStorageTool.getInt(
key: 'launchCount',
);
String
final bool saved = await QsStorageTool.setString(
key: 'username',
value: 'Song',
);
final String? username = await QsStorageTool.getString(
key: 'username',
);
List<String>
final bool saved = await QsStorageTool.setStringList(
key: 'tags',
value: <String>['Flutter', 'Dart'],
);
final List<String>? tags = await QsStorageTool.getStringList(
key: 'tags',
);
删除数据
await QsStorageTool.remove(key: 'username');
API
| 方法 | 返回类型 | 说明 |
|---|---|---|
setBool |
Future<bool> |
保存 bool 值,并返回写入结果 |
getBool |
Future<bool?> |
读取 bool 值;键不存在时返回 null |
setDouble |
Future<bool> |
保存 double 值,并返回写入结果 |
getDouble |
Future<double?> |
读取 double 值;键不存在时返回 null |
setInt |
Future<bool> |
保存 int 值,并返回写入结果 |
getInt |
Future<int?> |
读取 int 值;键不存在时返回 null |
setString |
Future<bool> |
保存 String 值,并返回写入结果 |
getString |
Future<String?> |
读取 String 值;键不存在时返回 null |
setStringList |
Future<bool> |
保存 List<String>,并返回写入结果 |
getStringList |
Future<List<String>?> |
读取 List<String>;键不存在时返回 null |
remove |
Future<void> |
删除指定键对应的数据 |
注意事项
- 相同的键应始终使用相同的数据类型读取和写入。
- 读取不存在的键时会返回
null。 - 本插件适合保存轻量级配置,不应保存密码、令牌等敏感信息。
- 存储行为由
shared_preferences提供,不适合作为关键业务数据的唯一持久化方案。