Flutter JSON与Chopper网络请求转换插件json_serializable_chopper_converter的使用

Flutter JSON与Chopper网络请求转换插件json_serializable_chopper_converter的使用

特性

• 全面的测试覆盖
• 轻松集成到Chopper
• 支持泛型响应

使用方法

final client = ChopperClient(
    services: [
        _$ApiService(),
    ],
    converter: JsonSerializableConverter({
        PostResource: PostResource.fromJson,
    }),
);

其他包

如果您需要其他常用类型的JsonSerializable转换器，可以查看以下这些包：

• json_serializable_uuid_converter
• json_serializable_converters
• json_serializable_flutter_converters

完整示例代码

以下是一个完整的示例代码，展示了如何使用json_serializable_chopper_converter来处理JSON数据和Chopper网络请求。

// ignore_for_file: avoid_print

import 'package:chopper/chopper.dart';
import 'package:json_serializable_chopper_converter/json_serializable_chopper_converter.dart';
import 'package:json_annotation/json_annotation.dart' hide JsonConverter;

part 'json_serializable_chopper_converter_example.g.dart';
part 'json_serializable_chopper_converter_example.chopper.dart';

abstract class APIModel {
  const APIModel();
  Map<String, dynamic> toJson();
}

[@JsonSerializable](/user/JsonSerializable)(
  genericArgumentFactories: true,
)
class Paginator<T extends APIModel> extends APIModel {
  const Paginator({
    required this.count,
    required this.next,
    required this.previous,
    required this.results,
  });

  final int count;
  final String? next;
  final String? previous;
  final List<T> results;

  // 从JSON数据创建Paginator对象
  factory Paginator.fromJson(Map<String, dynamic> json, JsonFactory jsonFactory) =>
      _$PaginatorFromJson<T>(json, (json) => jsonFactory(json as Map<String, dynamic>) as T);
  
  [@override](/user/override)
  Map<String, dynamic> toJson() => _$PaginatorToJson(this, (T value) => value.toJson());
}

[@JsonSerializable](/user/JsonSerializable)()
class PostResource extends APIModel {
  final int id;
  final String title;
  final String body;
  [@JsonKey](/user/JsonKey)(name: 'user_id')
  final int userId;

  const PostResource({
    required this.id,
    required this.title,
    required this.body,
    required this.userId,
  });

  // 从JSON数据创建PostResource对象
  factory PostResource.fromJson(Map<String, dynamic> json) => _$PostResourceFromJson(json);
  
  [@override](/user/override)
  Map<String, dynamic> toJson() => _$PostResourceToJson(this);
}

[@JsonSerializable](/user/JsonSerializable)()
class PostCreateBody extends APIModel {
  final String title;
  final String body;
  [@JsonKey](/user/JsonKey)(name: 'user_id')
  final int userId;

  const PostCreateBody({
    required this.title,
    required this.body,
    required this.userId,
  });

  // 从JSON数据创建PostCreateBody对象
  factory PostCreateBody.fromJson(Map<String, dynamic> json) => _$PostCreateBodyFromJson(json);
  
  [@override](/user/override)
  Map<String, dynamic> toJson() => _$PostCreateBodyToJson(this);
}

[@ChopperApi](/user/ChopperApi)(baseUrl: 'https://jsonplaceholder.typicode.com')
abstract class ApiService extends ChopperService {
  // 获取所有Post
  [@Get](/user/Get)(path: '/posts')
  Future<Response<List<PostResource>>> list();

  // 获取指定ID的Post
  [@Get](/user/Get)(path: '/posts/{id}')
  Future<Response<PostResource>> retrieve([@Path](/user/Path)('id') int id);

  // 创建一个新的Post
  [@Post](/user/Post)(path: '/posts')
  Future<Response<PostResource>> post(
    @Body() PostCreateBody body,
  );

  // 创建API服务实例
  static ApiService create() {
    final client = ChopperClient(
      services: [
        _$ApiService(),
      ],
      interceptors: const [
        HeadersInterceptor(
          {
            'Cache-Control': 'no-cache',
            'Content-Type': 'application/json; charset=UTF-8',
          },
        ),
      ],
      converter: JsonSerializableConverter({
        PostResource: PostResource.fromJson,
        Paginator<PostResource>: (json) => Paginator<PostResource>.fromJson(json, PostResource.fromJson),
        PostCreateBody: PostCreateBody.fromJson,
      }),
    );

    return _$ApiService(client);
  }
}

void main() async {
  final apiService = ApiService.create();

  // 获取所有Post
  final response = await apiService.list();
  print(response.body!.map((e) => e.toJson()));
}