GetStorage 是 GetX 提供的一个轻量级键值存储工具，类似于 Flutter 中的 SharedPreferences，但相比之下更加简单高效。它支持同步数据读写，并且可以直接用于小型数据持久化存储。

1. GetStorage 的特点2. GetStorage 的初始化

在使用 GetStorage 之前，需要先进行初始化。初始化时会创建一个默认的存储容器。

import 'package:flutter/material.dart';
import 'package:get_storage/get_storage.dart';
void main() async {
  await GetStorage.init(); // 初始化 GetStorage
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

⚠️ 注意：GetStorage.init()是异步操作，因此需要在main函数中使用await，确保初始化完成后再运行应用。

3. GetStorage 的基本用法3.1 创建存储实例

GetStorage默认会提供一个全局实例。

final box = GetStorage(); // 获取默认存储实例

如果需要多个存储容器，也可以自定义存储实例。

final userBox = GetStorage('UserBox'); // 创建名为 UserBox 的存储实例

3.2 数据存储

通过write方法将数据存储到本地。

box.write('username', 'JohnDoe'); // 存储字符串
box.write('isLoggedIn', true);    // 存储布尔值
box.write('userAge', 25);         // 存储数字
box.write('preferences', {'theme': 'dark', 'fontSize': 16}); // 存储对象

3.3 数据读取

通过read方法读取数据。

String username = box.read('username') ?? 'Guest';
bool isLoggedIn = box.read('isLoggedIn') ?? false;
Map<String, dynamic> preferences = box.read('preferences') ?? {};

3.4 数据删除

通过remove方法删除某个键值对。

box.remove('username'); // 删除键为 'username' 的数据

删除所有数据。

box.erase(); // 清空存储容器

4. GetStorage 的进阶功能4.1 数据监听

GetStorage 支持对指定键的变化进行监听。每当数据发生变化时，回调函数会被触发。

box.listen(() {
  print('数据发生变化：${box.read('username')}');
});
// 或监听特定键
box.listenKey('username', (value) {
  print('用户名更新为：$value');
});

4.2 数据同步

GetStorage 的所有操作都是同步的，存储操作立即生效，因此不需要等待异步操作完成。

4.3 自定义储存位置

默认情况下，GetStorage 会在设备的默认存储路径下创建一个 JSON 文件。如果需要自定义存储路径，可以在初始化时指定。

await GetStorage.init('UserBox', 'your/custom/path');

5. 使用场景5.1 保存用户登录状态

final box = GetStorage();
// 保存登录状态
void login() {
  box.write('isLoggedIn', true);
}
// 检查用户是否已登录
bool checkLoginStatus() {
  return box.read('isLoggedIn') ?? false;
}

5.2 实现主题切换并保存用户选择

final box = GetStorage();
// 切换主题并保存
void toggleTheme() {
  bool isDarkMode = box.read('isDarkMode') ?? false;
  box.write('isDarkMode', !isDarkMode);
  Get.changeTheme(isDarkMode ? ThemeData.light() : ThemeData.dark());
}
// 初始化时加载用户选择的主题
void loadTheme() {
  bool isDarkMode = box.read('isDarkMode') ?? false;
  Get.changeTheme(isDarkMode ? ThemeData.dark() : ThemeData.light());
}

5.3 保存用户设置和偏好

final box = GetStorage();
// 保存用户偏好
void savePreferences() {
  box.write('preferences', {
    'theme': 'dark',
    'fontSize': 16,
    'notificationsEnabled': true,
  });
}
// 读取用户偏好
Map<String, dynamic> loadPreferences() {
  return box.read('preferences') ?? {};
}

5.4 本地缓存接口数据

一般情况下，可以通过 GetStorage 缓存接口数据，减少重复请求。

Future<Map<String, dynamic>> fetchData() async {
  final cachedData = box.read('apiData');
  if (cachedData != null) {
    return cachedData; // 返回缓存数据
  }
  // 模拟从 API 获取数据
  final apiData = {'id': 1, 'name': 'GetX'};
  box.write('apiData', apiData); // 缓存数据
  return apiData;
}

6. 与其他常用的存储工具的对比特性GetStorageSharedPreferencesHive

异步支持

同步读写

异步

异步

数据格式

JSON 格式

键值对

自定义二进制格式

性能

高性能

中等

高性能

监听支持

支持

不支持

支持

自定义存储位置

支持

不支持

支持

使用场景

小型存储

小型存储

大量结构化数据存储

7. 注意事项

非大型存储解决方案：GetStorage 适合用于小型数据存储（如用户偏好、状态标志等）。如果需要存储大量或复杂结构的数据，建议使用 Hive 或 SQLite。

默认存储位置：GetStorage 默认会将数据存储在应用的私有存储路径中，删除应用时会一并清除。

加密存储：GetStorage 本身不提供加密功能。如果需要安全存储敏感数据，建议结合加密库（如encrypt）使用。

8. 总结

GetStorage 是一个轻量级、快速、易用的存储工具，特别适合以下场景：

通过简单的 API 和高效的性能，GetStorage 成为小型数据存储的优秀选择，与 GetX 框架的其他模块无缝集成，为使用者带来了极大的便利。