Flutter本地存储插件 get_storage_pro 的使用

get_storage_pro 是一个基于 get_storage 的 Flutter 插件，它简化了对象的存储和检索过程。本文将详细介绍如何使用 get_storage_pro 来进行本地数据存储。

概述

get_storage_pro 提供了存储对象、对象列表以及从存储中获取单个或多个对象的功能。在使用 GetStoragePro 之前，必须调用 GetStoragePro.init() 进行初始化。

初始化

在 main.dart 中，首先需要初始化 GetStoragePro：

import 'package:get_storage_pro/get_storage_pro.dart';
import 'main.reflectable.dart';

void main() async {
  initializeReflectable();
  WidgetsFlutterBinding.ensureInitialized();

  // Initialize GetStoragePro (call this before using any GetStoragePro functionality)
  await GetStoragePro.init();

  runApp(const MyApp());
}

使用步骤

1. 定义模型类

定义你的模型类，并使用 [@gsp](/user/gsp) 注解，继承 CommonDataClass 并实现必要的方法。确保模型类包含一个 id 属性，类型为 String，并实现 fromMap 和 toMap 方法。

import 'package:get_storage_pro/src/common_data_class.dart';

[@gsp](/user/gsp)
class YourModel extends CommonDataClass<YourModel> {
  final String id;
  final String name;

  YourModel({required this.id, required this.name});

  // Must have a factory named constructor fromMap
  factory YourModel.fromMap(Map<String, dynamic> map) {
    return YourModel(
      id: map['id'] as String,
      name: map['name'] as String,
    );
  }

  [@override](/user/override)
  Map<String, dynamic> toMap() {
    return {'id': id, 'name': name};
  }
}

2. 生成反射文件

运行以下命令生成反射文件：

dart pub run build_runner build

这将在项目根目录生成 main.reflectable.dart 文件，请不要修改该文件。

3. 初始化反射

在 main.dart 中调用 initializeReflectable()：

import 'package:get_storage_pro/get_storage_pro.dart';
import 'main.reflectable.dart';

void main() {
  initializeReflectable();
  
  // Your code here...
}

存储和获取数据

存储单个对象

YourModel model = YourModel(id: '1', name: 'John');
GetStoragePro.saveObject(model);

存储对象列表

List<YourModel> models = [
  YourModel(id: '2', name: 'Alice'),
  YourModel(id: '3', name: 'Bob'),
];
GetStoragePro.saveObjectsList(models);

获取单个对象

YourModel? retrievedModel = GetStoragePro.getObjectById<YourModel>('1');
print(retrievedModel?.name); // Output: John

获取所有对象

List<YourModel> allModels = GetStoragePro.getAllObjects<YourModel>();
print(allModels.length); // Output: 3 (including the previously saved objects)

删除对象

按 ID 删除

GetStoragePro.deleteById<YourModel>('1');

删除所有对象

GetStoragePro.deleteAllObjects<YourModel>();

监听数据变化

监听单个对象的变化

GetStoragePro.listenForObjectChanges<YourModel>(id: '1', onData: (model) {
  print('Updated model: ${model?.name}');
});

监听所有对象的变化

GetStoragePro.listenAllObjects<YourModel>(onData: (models) {
  print('All models: $models');
});

示例应用

下面是一个完整的示例应用，展示如何使用 get_storage_pro 存储用户信息：

import 'package:flutter/material.dart';
import 'package:get_storage_pro/get_storage_pro.dart';
import 'package:reflectable/reflectable.dart';

import 'main.reflectable.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'CommonDataClass Example',
      home: HomePage(),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('CommonDataClass Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            User user = User(id: '1', name: 'John');
            debugPrint(user.toMap().toString()); // Output: {id: 1, name: John}

            GetStoragePro.saveObject(user);
          },
          child: const Text('Run Example'),
        ),
      ),
    );
  }
}

// Example subclass of CommonDataClass
[@gsp](/user/gsp)
class User extends CommonDataClass<User> {
  [@override](/user/override)
  final String id;
  final String name;

  User({required this.id, required this.name});

  [@override](/user/override)
  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'name': name,
    };
  }

  factory User.fromMap(Map<String, dynamic> map) {
    return User(
      id: map['id'] as String,
      name: map['name'] as String,
    );
  }
}