Contents

在磁盘上存储键值数据

Contents

1. 添加依赖项
2. 保存数据
3. 读取数据
4. 删除数据
支持的类型
测试支持

如果您需要保存相对较小的键值集合，可以使用shared_preferences 插件。

通常情况下，您需要为每个平台编写本地平台集成来存储数据。幸运的是，shared_preferences 插件可用于将键值数据持久化到 Flutter 支持的每个平台的磁盘上。

此食谱使用以下步骤：

添加依赖项。
保存数据。
读取数据。
删除数据。

在开始之前，请添加shared_preferences 包作为依赖项。

要添加 shared_preferences 包作为依赖项，请运行 flutter pub add：

flutter pub add shared_preferences

要持久化数据，请使用 SharedPreferences 类提供的 setter 方法。setter 方法适用于各种原始类型，例如 setInt、setBool 和 setString。

setter 方法执行两件事：首先，同步更新内存中的键值对。然后，将数据持久化到磁盘。

dart// 加载并获取此应用的共享首选项。
final prefs = await SharedPreferences.getInstance();

// 将计数器值保存到持久存储的 'counter' 键下。
await prefs.setInt('counter', counter);

要读取数据，请使用 SharedPreferences 类提供的适当的 getter 方法。每个 setter 都有一个对应的 getter。例如，您可以使用 getInt、getBool 和 getString 方法。

dartfinal prefs = await SharedPreferences.getInstance();

// 尝试从持久存储中读取计数器值。
// 如果不存在，则返回 null，因此默认为 0。
final counter = prefs.getInt('counter') ?? 0;

请注意，如果持久化值与 getter 方法预期的类型不同，则 getter 方法会抛出异常。

要删除数据，请使用 remove() 方法。

dartfinal prefs = await SharedPreferences.getInstance();

// 从持久存储中删除计数器键值对。
await prefs.remove('counter');

虽然 shared_preferences 提供的键值存储易于使用且方便，但它有一些限制：

只能使用原始类型：int、double、bool、String 和 List<String>。
它并非设计用于存储大量数据。
并不能保证数据会在应用重启后仍然持久化。

最好使用 shared_preferences 测试持久化数据的代码。为此，该包提供了一个首选项存储的内存中模拟实现。

要设置测试以使用模拟实现，请在测试文件的 setUpAll() 方法中调用 setMockInitialValues 静态方法。传入一个键值对映射作为初始值。

dartSharedPreferences.setMockInitialValues(<String, Object>{
  'counter': 2,
});

##完整示例

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

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Shared preferences demo',
      home: MyHomePage(title: 'Shared preferences demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  @override
  void initState() {
    super.initState();
    _loadCounter();
  }

  /// 启动时从持久存储中加载初始计数器值，
  /// 或如果不存在则回退到 0。
  Future<void> _loadCounter() async {
    final prefs = await SharedPreferences.getInstance();
    setState(() {
      _counter = prefs.getInt('counter') ?? 0;
    });
  }

  /// 单击后，递增计数器状态并
  /// 异步将其保存到持久存储。
  Future<void> _incrementCounter() async {
    final prefs = await SharedPreferences.getInstance();
    setState(() {
      _counter = (prefs.getInt('counter') ?? 0) + 1;
      prefs.setInt('counter', _counter);
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times: ',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

除非另有说明，否则本网站上的文档反映的是 Flutter 的最新稳定版本。页面最后更新于 2025-01-30。查看源代码或报告问题。

1. 添加依赖项

2. 保存数据

3. 读取数据

4. 删除数据

支持的类型

测试支持