Flutter：共享偏好

Flutter: shared preferences

我有这个功能：

  Future<String> load(SharedPreferences prefs, String fileName) async {
    prefs = await SharedPreferences.getInstance();
    String jsonString = prefs.getString(fileName) ?? "";
    if (jsonString.isNotEmpty) {
      return jsonString;
    }else{
      return ...
    }
  }

在其他情况下我应该return做什么？我尝试使用“”但它不起作用。

答案是"it depends"。也就是说，这取决于您对该函数的结果究竟做了什么，以及在该上下文中好的空默认值意味着什么。

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

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);

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

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");

共享首选项

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

获取插件

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

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

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

导入包

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

import 'package:shared_preferences/shared_preferences.dart';

读写数据

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

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']);

正在删除数据

您可以通过提供密钥名称来删除任何保存的数据：

prefs.remove('my_int_key');

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

另见