Flutter宏命令执行或自动化插件macrofit的使用

安装与配置

macrofit 是一个基于宏功能（macro feature）的类型转换 Dio 客户端生成器，受到了 retrofit.dart 的启发。

启用宏功能

由于宏功能目前还不稳定，你需要在你的 analysis_options.yaml 文件中启用它：

include: package:flutter_lints/flutter.yaml

analyzer:
  enable-experiment:
    - macros

此外，在运行应用时需要添加标志 --enable-experiment=macros：

dart run --enable-experiment=macros example/lib/example.dart

使用说明

创建客户端

首先，创建一个客户端类：

@RestClient()
class ClientExample {
  ClientExample(this._dio, [this.baseUrl]);
}

定义查询方法

你可以为客户端填充各种查询方法。例如：

@RestClient()
class ClientExample {

  ClientExample(this._dio, [this.baseUrl]);

  // 多部分请求
  @MultiPart('some/path')
  external Future<void> someRequest(
    @Part() String id,
    @Part() File photo,
    @Part(as: 'user_info') UserInfo userInfo,
  );

  // POST 请求
  @POST('/posts/{userId}')
  external Future<void> updateProfile(
    @Header('Test') String testHeader,
    @Body() String name,
    @Body(as: 'user_name') String username,
    String userId,
  );

  // DELETE 请求
  @DELETE('/posts/{id}')
  external Future<TestResponse> deletePost(
    @Header('Test') String id,
  );

  // GET 请求
  @GET('/posts')
  external Future<List<double>> getPosts(
    @Query() int page,
    @Query(as: 'limit') int perPage,
  );
}

自定义方法

该库支持 GET, POST, PUT, DELETE 方法。你也可以定义自己的方法：

@Custom('/posts/{id}', methodName: 'PATCH')
external Future<PostEntity> patchPost(int id, @Body() String title);

参数使用

你可以使用以下注解来处理不同的参数：

• @Query 用于查询参数（如 ?page=1&limit=10）

@GET('/posts')
external Future<List<double>> getPosts(
  @Query() int page,
  @Query() int limit,
);

• @Body 用于请求体

@POST('/posts')
external Future<void> newPost(
  @Body() String title,
  @Body() String body,
);

• @Header 用于头部信息

@GET('/posts')
external Future<PostEntity> translate(
  @Header('Locale') String locale,
);

• @Part 用于多部分请求

@MultiPart('/posts')
external Future<void> newPost(
  @Part() String title,
  @Part() File photo,
);

• @Path 用于路径参数。确保在方法和路径中使用相同的名称

@GET('/posts/{id}')
external Future<PostEntity> getPost(int id);

完整示例代码

以下是一个完整的示例代码，展示了如何使用 macrofit 插件进行 API 调用：

import 'package:dio/dio.dart';
import 'package:example/client.dart';
import 'package:example/entities/post_entity.dart';
import 'package:collection/collection.dart';

void main() async {
  final dio = Dio()..interceptors.add(LogInterceptor(logPrint: print));
  final client = Client(dio, baseUrl: 'https://jsonplaceholder.typicode.com');

  const idOfExistingPost = 1;

  // 获取所有帖子
  final posts = await client.getPosts();

  // 获取第一个包含用户ID的帖子的用户ID
  final userId = posts.firstWhereOrNull((p) => p.userId != null)?.userId;

  if (userId == null) {
    return;
  }

  // 按用户ID获取帖子
  await client.getPostsByUserId(userId);

  // 获取特定ID的帖子
  await client.getPostById(idOfExistingPost);

  // 创建新帖子
  await client.createPost(
    PostEntity(
      userId: 1111,
      title: 'new post',
      body: 'new post body',
      id: 9999,
    ),
  );

  // 更新帖子
  await client.updatePost(
    idOfExistingPost,
    PostEntity(
      userId: 2222,
      title: 'updated post',
      body: 'updated post body',
      id: idOfExistingPost,
    ),
  );

  // 部分更新帖子
  await client.patchPost(idOfExistingPost, 'patched title');

  // 删除帖子
  await client.deletePost(idOfExistingPost);
}