Dart Flutter 通用 Api 响应类 动态类 数据类型

Posted 2023-02-23

【中文标题】Dart Flutter 通用 Api 响应类 动态类 数据类型

【英文标题】：Dart Flutter Generic Api Response Class Dynamic Class Data Type

【发布时间】：2021-02-12 04:24:40

【问题描述】：

我的应用目前正在为每个 api 响应使用自定义类作为模型。 但我试图改变它，优化一些小东西，所以我试图实现一个类包装器，例如称为 ApiResponse。 但是对于 make fromJson 和 toJson，它的静态调用和方法不能正常工作。

作为示例，我将展示我正在尝试的内容。 MyModel -> 类响应。 ApiResponse -> 内部包含任何模型类的主类，并且必须将子方法称为自身的“fromjson/tojson”。 测试 -> 用于测试目的的类，类上的错误 cmets。

class MyModel 
  String id;
  String title;
  MyModel(this.id, this.title);

  factory MyModel.fromJson(Map<String, dynamic> json) 
    return MyModel(
      id: json["id"],
      title: json["title"],
    );
  

  Map<String, dynamic> toJson() => 
        "id": this.id,
        "title": this.title,
      ;


class ApiResponse<T> 
  bool status;
  String message;
  T data;
  ApiResponse(this.status, this.message, this.data);

  factory ApiResponse.fromJson(Map<String, dynamic> json) 
    return ApiResponse<T>(
        status: json["status"],
        message: json["message"],
        data: (T).fromJson(json["data"])); // The method 'fromJson' isn't defined for the type 'Type'.
                                           // Try correcting the name to the name of an existing method, or defining a method named 'fromJson'.
  

  Map<String, dynamic> toJson() => 
        "status": this.status,
        "message": this.message,
        "data": this.data.toJson(), // The method 'toJson' isn't defined for the type 'Object'.
                                    // Try correcting the name to the name of an existing method, or defining a method named 'toJson'
      ;


class Test 
  test() 
    ApiResponse apiResponse = ApiResponse<MyModel>();
    var json = apiResponse.toJson();
    var response = ApiResponse<MyModel>.fromJson(json);
  

【参考方案1】：

base_response.dart

class BaseResponse 
  dynamic message;
  bool success;


  BaseResponse(
      this.message, this.success);

  factory BaseResponse.fromJson(Map<String, dynamic> json) 
    return BaseResponse(
        success: json["success"],
        message: json["message"]);
  

list_response.dart

server response for list

  "data": []
  "message": null,
  "success": true,


@JsonSerializable(genericArgumentFactories: true)
class ListResponse<T> extends BaseResponse 
  List<T> data;

  ListResponse(
    String message,
    bool success,
    this.data,
  ) : super(message: message, success: success);

  factory ListResponse.fromJson(Map<String, dynamic> json, Function(Map<String, dynamic>) create) 
    var data = List<T>();
    json['data'].forEach((v) 
      data.add(create(v));
    );

    return ListResponse<T>(
        success: json["success"],
        message: json["message"],
        data: data);
  

single_response.dart

server response for single object

  "data": 
  "message": null,
  "success": true,



@JsonSerializable(genericArgumentFactories: true)
class SingleResponse<T> extends BaseResponse 
  T data;

  SingleResponse(
    String message,
    bool success,
    this.data,
  ) : super(message: message, success: success);

  factory SingleResponse.fromJson(Map<String, dynamic> json, Function(Map<String, dynamic>) create) 
    return SingleResponse<T>(
        success: json["success"],
        message: json["message"],
        data: create(json["data"]));
  

data_response.dart

class DataResponse<T> 
  Status status;
  T res; //dynamic
  String loadingMessage;
  GeneralError error;

  DataResponse.init() : status = Status.Init;

  DataResponse.loading(this.loadingMessage) : status = Status.Loading;

  DataResponse.success(this.res) : status = Status.Success;

  DataResponse.error(this.error) : status = Status.Error;


  @override
  String toString() 
    return "Status : $status \n Message : $loadingMessage \n Data : $res";
  


enum Status 
  Init,
  Loading,
  Success,
  Error,

或者如果使用freeezed 那么 data_response 可以是

@freezed
abstract class DataResponse<T> with _$DataResponse<T> 
  const factory DataResponse.init() = Init;
  const factory DataResponse.loading(loadingMessage) = Loading;
  const factory DataResponse.success(T res) = Success<T>;
  const factory DataResponse.error(GeneralError error) = Error;

用法：（retrofit 库和retrofit_generator 自动生成代码的一部分）

const _extra = <String, dynamic>;
    final queryParameters = <String, dynamic>;
    final _data = <String, dynamic>;
    final _result = await _dio.request<Map<String, dynamic>>('$commentID',
        queryParameters: queryParameters,
        options: RequestOptions(
            method: 'GET',
            headers: <String, dynamic>,
            extra: _extra,
            baseUrl: baseUrl),
        data: _data);
    final value = SingleResponse<Comment>.fromJson(
      _result.data,
      (json) => Comment.fromJson(json),
    );

【参考方案2】：

您可以尝试我的方法来应用通用响应：APIResponse<MyModel> 通过实现自定义 Decodable 抽象类，来自 http 请求的响应将返回为 MyModel 对象。

Future<User> fetchUser() async 

    final client = APIClient();

    final result = await client.request<APIResponse<User>>(
      manager: APIRoute(APIType.getUser), 
      create: () => APIResponse<User>(create: () => User())
    );

    final user = result.response.data; // reponse.data will map with User

    if (user != null) 
      return user;
    

    throw ErrorResponse(message: 'User not found');

这是我的源代码： https://github.com/katafo/flutter-generic-api-response

【参考方案3】：

There is another way, 

Map<String, dynamic> toJson() => 
        "message": message,
        "status": status,
        "data": _toJson<T>(data),
      ;

static T _fromJson<T>(Map<String, dynamic> json) 
    return ResponseModel.fromJson(json) as T;
  

【讨论】：

序列化会给你带来问题

【参考方案4】：

您不能在 Dart 上调用类型的方法，因为静态方法必须在编译时解析，并且类型在运行时才具有值。

但是，您可以将解析器回调传递给构造函数并使用每个模型都可以实现的接口（例如Serializable）。然后，通过将您的ApiResponse 更新为ApiResponse<T extends Serializable>，它会知道每个类型T 都会有一个toJson() 方法。

这是更新的完整示例。

class MyModel implements Serializable 
  String id;
  String title;
  MyModel(this.id, this.title);

  factory MyModel.fromJson(Map<String, dynamic> json) 
    return MyModel(
      id: json["id"],
      title: json["title"],
    );
  

  @override
  Map<String, dynamic> toJson() => 
        "id": this.id,
        "title": this.title,
      ;


class ApiResponse<T extends Serializable> 
  bool status;
  String message;
  T data;
  ApiResponse(this.status, this.message, this.data);

  factory ApiResponse.fromJson(Map<String, dynamic> json, Function(Map<String, dynamic>) create) 
      return ApiResponse<T>(
      status: json["status"],
      message: json["message"],
      data: create(json["data"]),
    );
  

  Map<String, dynamic> toJson() => 
        "status": this.status,
        "message": this.message,
        "data": this.data.toJson(),
      ;


abstract class Serializable 
  Map<String, dynamic> toJson();


class Test 
  test() 
    ApiResponse apiResponse = ApiResponse<MyModel>();
    var json = apiResponse.toJson();
    var response = ApiResponse<MyModel>.fromJson(json, (data) => MyModel.fromJson(data));
  

【讨论】：

似乎可行，但现在的问题是，当我在控制器中获取响应时，例如，我无法获取模型的数据： response.data.title 'The getter 'id'没有为“Serializable”类型定义。尝试导入定义“id”的库，将名称更正为现有 getter 的名称，或定义名为“id”的 getter 或字段。这是一个问题，因为我需要模型的数据，我会有很多模型和属性。在这种情况下你会怎么做？

你是说你不能做response.data.id？你应该可以没有问题。

我的意思是正在测试响应是的，但我正在处理一个 TDD 项目颤动，所以所有这些过程都在远程数据源中，所以这个返回 ApiResponse 类，现在在下一个级别，我例如，只需获取响应 ApiResponse 响应，因此现在我无法获取 response.data.id。你明白我想说什么吗？

好的，我解决了它，只使用了一个演员，将 AnotherModel data = response.data 作为 AnotherModel。它有效，非常感谢你，伙计。 ;)

我有一个问题，如果响应不是对象类“T”，并且只是一个布尔值或字符串，你如何处理它？我在“布尔值不可序列化”或“字符串”上遇到错误...谢谢