关于 dart:Flutter: 共享偏好


Flutter: shared preferences

我有这个功能：

1
2
3
4
5
6
7
8
9
  Future<String> load(SharedPreferences prefs, String fileName) async {
    prefs = await SharedPreferences.getInstance();
    String jsonString = prefs.getString(fileName) ??"";
    if (jsonString.isNotEmpty) {
      return jsonString;
    }else{
      return ...
    }
  }

在 else 情况下我应该返回什么？我尝试使用" 但它不起作用。

相关讨论

共享偏好

在 Flutter 中，Shared Preferences 用于存储原始数据(int、double、bool、string 和 stringList)。此数据与应用相关联，因此当用户卸载您的应用时，这些数据也会被删除。

获取插件

来自 pub 的 shared_preferences 插件是 Android SharedPreferences 和 iOS NSUserDefaults 的package器。您可以通过在依赖项部分的 pubspec.yaml 文件中添加 shared_preferences 行来获取此插件。

1
2
dependencies:
  shared_preferences: '>=0.5.12+2 <2.0.0'

您可以将版本号更改为当前版本号，但任何低于 2.0 的版本都应兼容。

导入包

在您需要共享首选项的任何文件中，添加以下导入：

1
import 'package:shared_preferences/shared_preferences.dart';

读取和写入数据

要获取共享首选项对象，您可以执行以下操作：

1
final prefs = await SharedPreferences.getInstance();

这将用于以下所有示例。

整数

  • 阅读：final myInt = prefs.getInt('my_int_key') ?? 0;
  • 写：prefs.setInt('my_int_key', 42);

双倍的

  • 阅读：final myDouble = prefs.getDouble('my_double_key') ?? 0.0;
  • 写：prefs.setDouble('my_double_key', 3.14);

布尔

  • 阅读：final myBool = prefs.getBool('my_bool_key') ?? false;
  • 写：prefs.setBool('my_bool_key', true);

细绳

  • 阅读：final myString = prefs.getString('my_string_key') ?? '';
  • 写：prefs.setString('my_string_key', 'hello');

字符串列表

  • 阅读：final myStringList = prefs.getStringList('my_string_list_key') ?? [];
  • 写：prefs.setStringList('my_string_list_key', ['horse', 'cow', 'sheep']);

删除数据

您可以通过提供键名来删除任何已保存的数据：

1
prefs.remove('my_int_key');

不过，我很少发现需要这样做。我只是覆盖旧数据或忽略它。您不应在共享首选项中存储任何敏感数据。

也可以看看

  • Flutter 中用于代码可维护性的共享首选项服务
  • 文档：在磁盘上存储键值对数据
  • 什么是 ？？ Dart 中的双问号？
  • 如何在 Dart 中创建一个空列表
相关讨论

答案是"视情况而定"。也就是说，这取决于你对这个函数的结果做了什么，以及一个好的空默认值在那个上下文中意味着什么。

假设您将返回的 JSON 字符串解码为 Map<String, dynamic>，那么一个好的默认值可能是空映射。在这种情况下，您可以按如下方式重新构造您的函数：

1
2
3
4
5
6
7
8
9
10
11
12
Future<String> loadJSON(final String fileName) async {
  final SharedPreferences prefs = await SharedPreferences.getInstance();
  final String jsonString = prefs.getString(fileName);
  if (jsonString != null && jsonString.isNotEmpty) {
    return jsonString;
  }
  return"{}"; // default value
}

final String jsonString = await loadJSON("test.json");

final Map<String, dynamic> jsonData = json.decode(jsonString);

但是，将这个过程重新表述为返回实际地图值的稍微高级一点的函数可能更有意义：

1
2
3
4
5
6
7
8
9
10
Future<Map<String, dynamic>> loadData(final String fileName) async {
  final SharedPreferences prefs = await SharedPreferences.getInstance();
  final String jsonString = prefs.getString(fileName);
  if (jsonString != null && jsonString.isNotEmpty) {
    return json.decode(jsonString);
  }
  return Map(); // default value
}

final Map<String, dynamic> jsonData = await loadData("test.json");