Flutter数据持久化插件hawk_meta的使用

Flutter数据持久化插件hawk_meta的使用

特性

自动为您的项目生成Hawk风格的方法调用处理器。

开始使用

在您的pubspec.yaml文件中添加hawk_meta和hawk_source_gen包依赖：

dependencies:
  hawk_meta:
dev_dependencies:
  hawk_source_gen:
  build_runner:

使用方法

1. 使用[@HawkEntryPoint](/user/HawkEntryPoint)注解标记一个类或函数。

class UserInfo {
  final String userId;
  final String userToken;
  final String userName;

  UserInfo(this.userId, this.userToken, this.userName);

  UserInfo.fromMap(Map map)
      : userId = map['userId'] as String,
        userToken = map['userToken'] as String,
        userName = map['userName'] as String;
}

[@HawkEntryPoint](/user/HawkEntryPoint)()
class AuthService {
  Future<UserInfo> login(String userId, String userToken) async {
    await Future.delayed(const Duration(seconds: 2));
    return UserInfo(userId, userToken, 'test');
  }
}

注意: [@HawkEntryPoint](/user/HawkEntryPoint)注解可以用于类或顶级函数/获取器/设置器。如果用于类，则该类的所有公共方法都将被注册为入口点。如果您想忽略某些元素，请使用@HawkApi(ignore: true)注解。

1. 运行以下命令以生成代码：

flutter pub run build_runner build --delete-conflicting-outputs

生成的代码将放置在您的项目的.dart_tool/build/generated/{pkg}lib/src文件夹中，并且这些文件都具有.hawk.dart后缀。目前，您需要手动将这些文件复制到目标文件夹。

1. 然后您可以使用生成的代码来调用入口点。

void testHawk() {
  final handler = HawkMethodCallDispatcher();
  
  // 这一步是不必要的
  // 如果存在，Hawk 将自动查找类型的方法 fromMap/toJson。
  // 如果这不是您想要的，您可以注册自定义的 fromMap/toMap 方法。
  handler.registerTypeConverter(
    fromMap: (map) async => UserInfo.fromMap(map),
    toMap: (UserInfo info) => {
      'userId': info.userId,
      'userToken': info.userToken,
      'userName': info.userName,
    },
  );
  
  // 这一步是必要的
  handler.registerMethodCallHandler(
    'AuthService',
    instanceGetter: () async => AuthService(),
    handlers: [HawkAuthService.handleHawkMethodCall],
  );
  
  // 将 `handler` 传递给 `IntegratedManager`
  IntegratedManager.instance.init(
      // 其他参数
      // ...
      caseList: [handler],
  );
}

示例代码

以下是一个完整的示例代码，展示了如何使用hawk_meta插件：

import 'dart:async';
import 'package:hawk_meta/hawk_meta.dart';

class UserInfo {
  final String userId;
  final String userToken;
  final String userName;

  UserInfo(this.userId, this.userToken, this.userName);

  UserInfo.fromMap(Map map)
      : userId = map['userId'] as String,
        userToken = map['userToken'] as String,
        userName = map['userName'] as String;
}

[@HawkEntryPoint](/user/HawkEntryPoint)()
class AuthService {
  Future<UserInfo> login(String userId, String userToken) async {
    await Future.delayed(const Duration(seconds: 2));
    return UserInfo(userId, userToken, 'test');
  }
}

void testHawk() {
  final handler = HawkMethodCallDispatcher();
  
  // 注册自定义的 fromMap/toMap 方法
  handler.registerTypeConverter(
    fromMap: (map) async => UserInfo.fromMap(map),
    toMap: (UserInfo info) => {
      'userId': info.userId,
      'userToken': info.userToken,
      'userName': info.userName,
    },
  );
  
  // 注册方法调用处理器
  handler.registerMethodCallHandler(
    'AuthService',
    instanceGetter: () async => AuthService(),
    handlers: [HawkAuthService.handleHawkMethodCall],
  );
  
  // 初始化 IntegratedManager 并传递 handler
  IntegratedManager.instance.init(
      // 其他参数
      // ...
      caseList: [handler],
  );
}

void main() {
  testHawk();
}