Flutter注解处理插件riverfit_annotation的使用

Riverfit

概述

Riverfit 是一个Dart代码生成库，旨在集成 riverpod_generator 和 retrofit_generator 的功能。

为什么使用Riverfit？

这种集成适用于依赖于Riverpod进行状态管理以及通过Retrofit进行API交互的项目。

当使用 @Riverpod 注解时，可以选择为函数或类添加注解。我更倾向于为类添加注解，尤其是为了更好的组织、可读性和可维护性。

• 更好的封装性：类将相关的逻辑和数据组合在一起，使理解并管理provider的行为更加容易。
• 更好的可读性：有了专用的类，可以立即清楚地了解provider代表什么，并且可以添加额外的方法或属性以扩展其功能。
• 可扩展性：类允许你添加与provider状态直接相关的其他方法、属性或计算值。

然而，目前无法在同一类上使用 riverpod_generator 和 retrofit_generator 的注解，因为 @Riverpod 期望的是具体类，而 @RestApi 期望的是抽象类。

Riverfit通过分析带有 @Riverfit 注解的类来解决这个问题：

• 将provider代码生成委托给Riverpod Generator。
• 生成包含转发调用到Retrofit成员的wrapper方法的provider扩展类。这消除了手动代理样板的需求。

子项目

1. riverfit_annotation

提供了用于标记类以供Riverfit处理的 @Riverfit()/@riverfit 注解。将其用作 @Riverpod() 或 @riverpod 注解的替代品。

使用方法

1. 创建你的标准Retrofit抽象类作为API合同。

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'api.g.dart';

@RestApi(baseUrl: 'https://example.com')
abstract class Api {
  factory Api(Dio dio, {String? baseUrl}) = _Api;

  @GET('/fetchData')
  Future<dynamic> fetchData();

  @PUT('/pushData/{id}')
  Future<dynamic> pushData(String id);
}

1. 创建一个API客户端作为要提供的类

import 'package:riverfit_annotation/riverfit_annotation.dart';

@Riverfit(keepAlive: true, dependencies: [OtherProvider])
class ApiClient extends _$ApiClient {
  // 声明一个Retrofit成员
  late final Api _api;

  @override
  Future<ApiClient> build() async {
    // 初始化逻辑在这里...
    // 例如自定义Dio配置或添加跨切关注点（如日志记录或身份验证）的拦截器
    _api = Api(Dio());
    return this;
  }
}

如果使用AutoDisposeProvider（keepAlive: false）

import 'package:riverfit_annotation/riverfit_annotation.dart';

@riverfit
class ApiClient extends _$ApiClient {
  // 声明一个Retrofit成员
  late final Api _api;

  @override
  Future<ApiClient> build() async {
    // 初始化逻辑在这里...
    // 例如自定义Dio配置或添加跨切关注点（如日志记录或身份验证）的拦截器
    _api = Api(Dio());
    return this;
  }
}

1. 生成代码

dart run build_runner build --delete-conflicting-outputs

实现细节

注解将所有参数代理给Riverpod注解，目前包括：

• keepAlive: 是否即使在provider不再使用时也要保持其状态。默认为 false。
• dependencies: 该类所依赖的Riverpod provider列表。

2. riverfit_generator

这是将Riverpod和Retrofit代码生成统一的核心生成器。它确保注解被正确处理并生成provider和扩展方法。

特性

• 为带注解的类生成Riverpod provider代码。
• 创建无缝调用Retrofit成员的wrapper方法。

示例

运行 dart run build_runner build，生成的代码将包括：

1. ApiClient 的Riverpod provider。
2. RestApi 成员 Api 的wrapper方法的扩展类。

生成输出：

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'api_client.dart';

// Riverpod provider (a pass-through to riverpod_generator.generate())
String _$apiClientHash() => r'XXXX';

/// See also [ApiClient].
@ProviderFor(ApiClient)
final apiClientProvider = AsyncNotifierProvider<ApiClient, ApiClient>.internal(
  ApiClient.new,
  name: r'apiClientProvider',
  debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$apiClientHash,
  dependencies: null,
  allTransitiveDependencies: null,
);

typedef _$ApiClient = AsyncNotifier<ApiClient>;

// Wrapper methods for Retrofit member
extension ApiClientExtension on ApiClient {
  Future<String> fetchData() {
    return _api.fetchData();
  }

  Future<void> pushData(int id) {
    return _api.pushData(id);
  }
}

安装

在你的 pubspec.yaml 中添加以下依赖项：

dependencies:
  riverfit_annotation: ^1.0.0

dev_dependencies:
  riverfit_generator: ^1.0.0
  build_runner: ^2.4.0