Flutter 本地存储 —— 基本的键值对存储

本文正在参加「金石计划」

前言

在原生的 Android 或 iOS 中，都供应了底子的键值对存储方法，Android 是 SharedPreferences，iOS 是 NSUserDefaults。在 Flutter 中，供应了 shared_preferences 这个插件来完结本地键值对数据存储。实际上，shared_preferences 在 Android 便是运用 SharedPreferences 完结，在 iOS 上则是运用 NSUserDefaults 完结。

底子运用

在 pubspec.yaml 文件中增加以下代码：

dependencies:
    flutter:
        sdk: flutter
    shared_preferences: ^2.0.18

我们将根底的计数使用修改为支撑从上一次成果（即存储在本地的数值）开端增加。代码如下：

import 'package:flutter/material.dart';
import 'package:shared_preferences/shared_preferences.dart';
class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
  int _counter = 0;
  late SharedPreferences _prefs;
  @override
  void initState() {
    super.initState();
    _loadCounter();
  }
  void _loadCounter() async {
    _prefs = await SharedPreferences.getInstance();
    setState(() {
      _counter = (_prefs.getInt('counter') ?? 0);
    });
  }
  void _incrementCounter() async {
    setState(() {
      _counter++;
    });
    await _prefs.setInt('counter', _counter);
  }
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Shared Preferences 示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text(
                'You have pushed the button this many times:',
              ),
              Text(
                '$_counter',
                style: Theme.of(context).textTheme.headline4,
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _incrementCounter,
          tooltip: 'Increment',
          child: Icon(Icons.add),
        ),
      ),
    );
  }
}

上面的代码是一个根底的计数器使用，我们界说了一个_counter变量来保存计数器的值，而且运用 SharedPreferences 实例来存储和检索_counter变量的值。 在initState方法中，我们运用_loadCounter方法来加载_counter变量的值。在_loadCounter方法中，我们首要运用SharedPreferences.getInstance() 方法来获取 SharedPreferences 实例，然后运用 getInt()方法来检索 _counter 变量的值。假设检索到的值为 null，则将 _counter 变量的值设置为 0。 在 _incrementCounter 方法中，我们运用了setInt方法将 _counter 变量的值保存到 SharedPreferences 实例中来完结本地存储。 运转效果如下：

存储其他类型数据

shared_preferences支撑存储的数据类型有整型、浮点型（double）、字符串、布尔型和字符串数组。假设想存储方针，也可以通过 json 序列化和反序列化的方法完结。我们来看一个更凌乱点的例子。

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);
  @override
  _MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
  // 初始化需求存储的值
  int _counter = 0;
  String _username = '';
  bool _isDarkModeEnabled = false;
  final _textController = TextEditingController(text: '');
  // SharedPreferences 实例
  late SharedPreferences _prefs;
  // 加载 SharedPreferences 中存储的值
  Future<void> _loadData() async {
    _prefs = await SharedPreferences.getInstance();
    setState(() {
      _counter = _prefs.getInt('counter') ?? 0;
      _username = _prefs.getString('username') ?? '';
      _textController.text = _username;
      _isDarkModeEnabled = _prefs.getBool('isDarkModeEnabled') ?? false;
    });
  }
  void _incrementCounter() async {
    setState(() {
      _counter++;
    });
    await _prefs.setInt('counter', _counter);
  }
  // 保存用户名
  void _saveUsername(String username) async {
    setState(() {
      _username = username;
    });
    await _prefs.setString('username', _username);
  }
  // 切换暗黑方式
  void _toggleDarkMode(bool isDarkModeEnabled) async {
    setState(() {
      _isDarkModeEnabled = isDarkModeEnabled;
    });
    await _prefs.setBool('isDarkModeEnabled', _isDarkModeEnabled);
  }
  @override
  void initState() {
    super.initState();
    _loadData();
  }
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter SharedPreferences 示例',
      theme: _isDarkModeEnabled ? ThemeData.dark() : ThemeData.light(),
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Flutter SharedPreferences 示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text(
                '计数器的值：$_counter',
              ),
              const SizedBox(height: 20),
              TextFormField(
                decoration: const InputDecoration(
                  labelText: '请输入您的姓名',
                ),
                controller: _textController,
                onChanged: (value) {
                  _saveUsername(value);
                },
              ),
              const SizedBox(height: 20),
              SwitchListTile(
                title: const Text('启用暗黑方式'),
                value: _isDarkModeEnabled,
                onChanged: (value) {
                  _toggleDarkMode(value);
                },
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _incrementCounter,
          tooltip: '递加计数器的值',
          child: const Icon(Icons.add),
        ),
      ),
    );
  }
}

上述代码增加了两个类型的存储，分别是字符串和布尔型，存储方法其实是类似的，布尔型运用 getBool 获取、setBool 存储；字符串则是运用 getString和 setString。我们通过布尔型变量操控是否启用暗黑方式，运用字符串类存储用户名。下面是运转的成果。

总结

可以看到shared_preferences 十分简略，因而可以使用在简略的键值对存储中，典型的便是我们在本地换成后端的SessionId、记住用户名和密码、或许默许的勾选项等等。然后依据这些存储的数据做默许值显现和业务规矩操控、或填充到恳求表单里。关于凌乱的业务方针存储，则需求运用 SQL数据库或许是 NoSQL 数据库。

我是岛上码农，微信大众号同名。如有问题可以加自己微信沟通，微信号：island-coder。

：觉得有收成请点个赞鼓励一下！

：保藏文章，便利回看哦！

：谈论沟通，相互进步！

本文正在参加「金石计划」