Flutter中存储API返回的Map/JSON数据及统一字段调用方案咨询

这种构建方式完全合理，也是Flutter开发中管理本地持久化数据的常规做法，以下是具体实现方案：

1. 核心思路：将JSON转为强类型实体类（Model） #

把API返回的JSON数据映射成Dart实体类，既实现variable.field的字段式访问，又能通过"实体类→JSON字符串"的转换，解决SharedPreferences无法直接存储Map的问题。

实现步骤： #

• 添加依赖：在pubspec.yaml中引入json_annotation（注解用）和json_serializable（自动生成序列化代码）
• 定义实体类示例（以用户数据为例）：

import 'package:json_annotation/json_annotation.dart';

part 'user_data.g.dart';

@JsonSerializable()
class UserData {
  final String userId;
  final String username;
  final String email;
  final int phone;

  UserData({required this.userId, required this.username, required this.email, required this.phone});

  // 从JSON转实体类
  factory UserData.fromJson(Map<String, dynamic> json) => _$UserDataFromJson(json);

  // 实体类转JSON
  Map<String, dynamic> toJson() => _$UserDataToJson(this);
}

• 运行命令生成序列化代码：flutter pub run build_runner build

2. 集中化存储管理：封装单例存储工具类 #

创建全局单例的存储管理类，统一处理所有数据的存、取、删操作，实现数据的集中管控。

示例代码：

import 'dart:convert';
import 'package:shared_preferences/shared_preferences.dart';
import 'user_data.dart';
import 'cart_item.dart'; // 你的购物车实体类

class StorageManager {
  static final StorageManager _instance = StorageManager._internal();
  late SharedPreferences _prefs;

  factory StorageManager() => _instance;

  StorageManager._internal();

  // 初始化SharedPreferences
  Future<void> init() async {
    _prefs = await SharedPreferences.getInstance();
  }

  // 存储用户数据
  Future<void> saveUserData(UserData userData) async {
    final jsonStr = jsonEncode(userData.toJson());
    await _prefs.setString('user_data', jsonStr);
  }

  // 读取用户数据
  UserData? getUserData() {
    final jsonStr = _prefs.getString('user_data');
    if (jsonStr == null) return null;
    final jsonMap = jsonDecode(jsonStr);
    return UserData.fromJson(jsonMap);
  }

  // 存储购物车数据
  Future<void> saveCartItems(List<CartItem> cartItems) async {
    final jsonList = cartItems.map((item) => item.toJson()).toList();
    final jsonStr = jsonEncode(jsonList);
    await _prefs.setString('cart_items', jsonStr);
  }

  // 读取购物车数据
  List<CartItem> getCartItems() {
    final jsonStr = _prefs.getString('cart_items');
    if (jsonStr == null) return [];
    final jsonList = jsonDecode(jsonStr) as List<dynamic>;
    return jsonList.map((item) => CartItem.fromJson(item)).toList();
  }

  // 删除指定数据
  Future<void> removeData(String key) async {
    await _prefs.remove(key);
  }
}

3. 实际使用方式 #

在应用启动时先初始化存储管理器：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await StorageManager().init();
  runApp(const MyApp());
}

之后在任意页面即可直接调用：

// 存储API返回的用户数据
final apiUserData = UserData(userId: '1001', username: 'Tom', email: 'tom@example.com', phone: 13800000000);
await StorageManager().saveUserData(apiUserData);

// 读取并访问字段
final savedUser = StorageManager().getUserData();
if (savedUser != null) {
  print(savedUser.username); // 直接通过.field访问字段
  print(savedUser.email);
}

4. 进阶方案：使用轻量级本地数据库（Hive/Isar） #

如果数据结构复杂、数据量较大，SharedPreferences的性能可能不足，推荐使用Hive或Isar这类轻量级NoSQL数据库：

• 支持直接存储实体类对象，无需手动转JSON字符串
• 性能优于SharedPreferences，支持索引、事务等功能
• 同样支持variable.field的字段式访问

Hive简化示例： #

• 添加依赖：hive、hive_flutter、hive_generator、build_runner
• 注册适配器并初始化：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Hive.initFlutter();
  Hive.registerAdapter(UserDataAdapter()); // 自动生成的实体类适配器
  await Hive.openBox('app_storage');
  runApp(const MyApp());
}

• 存储与读取：

final storageBox = Hive.box('app_storage');
// 存储
await storageBox.put('user_data', apiUserData);
// 读取
final savedUser = storageBox.get('user_data') as UserData;
print(savedUser.username);

内容的提问来源于stack exchange，提问作者Antonio Cortese