Flutter本地数据存储插件shared_prefs的使用

在Flutter开发中，shared_preferences 是一个非常常用的插件，用于存储简单的键值对数据。它可以将数据保存到设备的共享偏好设置中，适合存储一些简单的配置信息或用户偏好设置。

添加依赖

首先，在 pubspec.yaml 文件中添加 shared_preferences 依赖：

dependencies:
  flutter:
    sdk: flutter
  shared_preferences: ^2.0.15 # 确保版本是最新的

然后运行以下命令以安装依赖：

flutter pub get

使用示例

下面是一个完整的示例，演示如何使用 shared_preferences 来存储和读取数据。

1. 导入库

在需要使用的文件中导入 shared_preferences 库：

import 'package:shared_preferences/shared_preferences.dart';

2. 存储数据

我们可以使用 SharedPreferences 类来存储数据。例如，存储一个布尔值、字符串和整数值。

void saveData() async {
  // 获取 SharedPreferences 实例
  SharedPreferences prefs = await SharedPreferences.getInstance();

  // 存储布尔值
  await prefs.setBool('isUserLoggedIn', true);

  // 存储字符串
  await prefs.setString('username', 'JohnDoe');

  // 存储整数
  await prefs.setInt('age', 25);
}

3. 读取数据

从 SharedPreferences 中读取之前存储的数据：

Future<void> loadData() async {
  // 获取 SharedPreferences 实例
  SharedPreferences prefs = await SharedPreferences.getInstance();

  // 读取布尔值
  bool isUserLoggedIn = prefs.getBool('isUserLoggedIn') ?? false;

  // 读取字符串
  String username = prefs.getString('username') ?? 'Unknown';

  // 读取整数
  int age = prefs.getInt('age') ?? 0;

  print('是否登录: $isUserLoggedIn');
  print('用户名: $username');
  print('年龄: $age');
}

4. 删除数据

如果需要删除某个键值对，可以使用 remove 方法：

void removeData() async {
  SharedPreferences prefs = await SharedPreferences.getInstance();
  prefs.remove('isUserLoggedIn'); // 删除布尔值
  prefs.remove('username');       // 删除字符串
  prefs.remove('age');           // 删除整数
}

完整示例代码

import 'package:flutter/material.dart';
import 'package:shared_preferences/shared_preferences.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: SharedPrefsExample(),
    );
  }
}

class SharedPrefsExample extends StatefulWidget {
  [@override](/user/override)
  _SharedPrefsExampleState createState() => _SharedPrefsExampleState();
}

class _SharedPrefsExampleState extends State<SharedPrefsExample> {
  bool _isLoggedIn = false;
  String _username = '';
  int _age = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _loadUserData();
  }

  Future<void> _loadUserData() async {
    SharedPreferences prefs = await SharedPreferences.getInstance();
    setState(() {
      _isLoggedIn = prefs.getBool('isUserLoggedIn') ?? false;
      _username = prefs.getString('username') ?? 'Unknown';
      _age = prefs.getInt('age') ?? 0;
    });
  }

  Future<void> _saveData() async {
    SharedPreferences prefs = await SharedPreferences.getInstance();
    await prefs.setBool('isUserLoggedIn', _isLoggedIn);
    await prefs.setString('username', _username);
    await prefs.setInt('age', _age);
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('数据已保存')));
  }

  Future<void> _clearData() async {
    SharedPreferences prefs = await SharedPreferences.getInstance();
    prefs.clear();
    setState(() {
      _isLoggedIn = false;
      _username = 'Unknown';
      _age = 0;
    });
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('数据已清除')));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('SharedPreferences 示例'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [
            TextField(
              decoration: InputDecoration(labelText: '用户名'),
              onChanged: (value) => setState(() => _username = value),
            ),
            SizedBox(height: 10),
            TextField(
              keyboardType: TextInputType.number,
              decoration: InputDecoration(labelText: '年龄'),
              onChanged: (value) => setState(() => _age = int.tryParse(value) ?? 0),
            ),
            SizedBox(height: 10),
            Row(
              mainAxisAlignment: MainAxisAlignment.spaceBetween,
              children: [
                ElevatedButton(
                  onPressed: _saveData,
                  child: Text('保存数据'),
                ),
                ElevatedButton(
                  onPressed: _clearData,
                  child: Text('清除数据'),
                ),
              ],
            ),
            SizedBox(height: 20),
            Text('是否登录: $_isLoggedIn'),
            Text('用户名: $_username'),
            Text('年龄: $_age'),
          ],
        ),
      ),
    );
  }
}