具有shared_preferences的Flutter Null安全配置类

Question

在flutter 1.x中，我使用flutter shared_preferences包实现了一个Config类；代码如下：

import 'package:shared_preferences/shared_preferences.dart';
class Config {
static final Config _config = Config._internal();
factory Config() => _config;
final accessTokenKey = 'accessToken';
String _accessToken;
SharedPreferences prefs;
Config._internal() {
loadData();
}
void loadData() async {
prefs = await SharedPreferences.getInstance();
_accessToken = prefs.getString(accessTokenKey) ?? '';
}
String get accessToken {
return _accessToken;
}
set accessToken(String accessToken) {
_accessToken = accessToken;
_saveString(accessTokenKey, accessToken);
}
_saveString(String key, String value, {String printValue = ''}) {
String printVal = printValue.length > 0 ? printValue : value;
prefs.setString(key, value);
}
}

我正在Flutter2.x中创建一个新项目，并尝试使用相同的代码，但由于与零安全相关的更改，我很难正确地获得更新的代码。该包的更新文档说要初始化_prefs对象，如下所示：

Future<SharedPreferences> _prefs = SharedPreferences.getInstance();

然后使用创建本地prefs对象

final SharedPreferences prefs = await _prefs;

这很好，但我不想让每个使用shared_preferences的类方法都异步，然后重新创建变量。同时，如果不先初始化它，我就不能将它创建为类变量。有人能告诉我一种更清洁的方法吗？还是我每次使用都必须重新申报？另外，如何初始化其他类中的配置对象？在我的1.x代码中，我只会这样做：

final Config config = new Config();

然后开始访问配置对象的属性。我现在如何用类中的所有异步代码初始化它？

以下是今天更新的代码：

import 'package:shared_preferences/shared_preferences.dart';
import '../models/device.dart';
class Config {
static final Config _config = Config._internal();
factory Config() => _config;
final accessTokenKey = 'accessToken';
String _accessToken = '';
Future<SharedPreferences> _prefs = SharedPreferences.getInstance();
Config._internal() {
print('Config constructor');
loadData();
}
Future<void> loadData() async {
final SharedPreferences prefs = await _prefs;
_accessToken = prefs.getString(accessTokenKey) ?? '';
}
String get accessToken {
return _accessToken;
}
set accessToken(String accessToken) {
_accessToken = accessToken;
_saveString(accessTokenKey, accessToken);
}
_saveString(String key, String value, {String printValue = ''}) {
String printVal = printValue.length > 0 ? printValue : value;
print('Config: _saveString("$key", "$printVal")');
final SharedPreferences prefs = await _prefs;
prefs.setString(key, value);
}
}

Answer 1

您可以在init方法中获得SharedPreferences的实例作为静态字段：

static SharedPreferences? _prefs; //or: static late SharedPreferences _prefs;
static init() async {
_prefs = await SharedPreferences.getInstance();
}

并像第一次运行小部件的build()方法一样在某个地方调用init()。现在，您可以随心所欲地在任何地方使用_prefs。如果我想向您展示一个使用SharedPreferences的完整类，它看起来像这样：

import 'package:shared_preferences/shared_preferences.dart';
class SharedPreferencesRepository {
static SharedPreferences? _prefs;
static init() async {
_prefs = await SharedPreferences.getInstance();
}
static putInteger(String key, int value) {
if (_prefs != null) _prefs!.setInt(key, value);
}
static int getInteger(String key) {
return _prefs == null ? 0 : _prefs!.getInt(key) ?? 0;
}
static putString(String key, String value) {
if (_prefs != null) _prefs!.setString(key, value);
}
static String getString(String key) {
return _prefs == null ? 'DEFAULT_VALUE' : _prefs!.getString(key) ?? "";
}
static putBool(String key, bool value) {
if (_prefs != null) _prefs!.setBool(key, value);
}
static bool getBool(String key) {
return _prefs == null ? false : _prefs!.getBool(key) ?? false;
}
}

我希望这对你有用。

Answer 2

如果在获取类的实例之前需要等待一些异步工作完成，请考虑使用静态方法(而不是factory构造函数，因为构造函数必须始终返回基类型(。

您可以使用late字段来允许它们在初始化之前为非空：

class Config {
late String _accessToken;
String get accessToken => _accessToken;
Config._();  // private constructor to prevent accidental creation
static Future<Config> create() async {
final config = Config();
final preferences = await SharedPreferences.getInstance();
config._accessToken = await preferences.getString('<your key>');
return config;
}
}

如果你想确保在运行应用程序之前初始化它，你可以在main()方法中初始化它，然后再调用runApp()来控制Flutter框架：

Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();  // make sure all plugins loaded etc.
final config = await Config.create();
print(config.accessToken);
runApp(MyApp());
}