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 数据库。