Flutter网络通用处理插件generic_network的使用

特性

这是一个功能强大的Flutter HTTP网络包，旨在以最少的干净代码处理HTTP请求，并轻松处理错误。

开始使用

1. 创建API类

首先，我们需要创建一个继承自BaseApi的类。这个类用于定义基础URL。

class Api extends BaseApi {
  Api() : super(url: "https://your-base-url.com"); // 替换为你的实际基础URL
}

2. 定义请求目标

接下来，我们定义一个继承自TargetType的类，表示具体的HTTP请求。

class LoginRequest extends TargetType {
  final String email;
  final String password;

  LoginRequest({required this.password, required this.email}) {
    requestParameters = {"password": password, "email": email}; // 请求参数
  }

  [@override](/user/override)
  String? get path => "login"; // 替换为你的具体接口路径

  [@override](/user/override)
  HttpMethod? get method => HttpMethod.post; // HTTP方法，例如POST

  [@override](/user/override)
  Map<String, dynamic>? get headers => {}; // 额外的请求头

  [@override](/user/override)
  var requestParameters; // 请求参数
}

3. 定义响应模型

然后，我们定义一个继承自Decodable的类，表示服务器返回的JSON数据如何解析为对象。

class LoginResponse extends Decodable<LoginResponse> {
  String? userName;
  int? age;

  [@override](/user/override)
  LoginResponse fromJson(Map<String, dynamic> json) {
    return LoginResponse.fromJson(
      age: json["age"],
      userName: json["userName"],
    );
  }

  LoginResponse();

  LoginResponse.fromJson({required this.age, required this.userName});
}

4. 调用网络请求

最后，我们可以调用网络请求并处理结果。

void login() {
  Api().fetchData<LoginResponse, LoginResponse>(
    LoginRequest(email: "test@example.com", password: "password"),
    LoginResponse(),
  ).then((value) {
    // 处理成功或失败的结果
    if (value case Success(value: final value)) {
      print("登录成功: $value");
    } else if (value case Failure(exception: final exception)) {
      print("登录失败: $exception");
    }
  });
}

示例完整代码

以下是完整的示例代码，包括所有步骤：

import 'package:generic_network/generic_network.dart';

class Api extends BaseApi {
  Api() : super(url: "https://your-base-url.com"); // 替换为你的实际基础URL
}

class LoginRequest extends TargetType {
  final String email;
  final String password;

  LoginRequest({required this.password, required this.email}) {
    requestParameters = {"password": password, "email": email}; // 请求参数
  }

  [@override](/user/override)
  String? get path => "login"; // 替换为你的具体接口路径

  [@override](/user/override)
  HttpMethod? get method => HttpMethod.post; // HTTP方法，例如POST

  [@override](/user/override)
  Map<String, dynamic>? get headers => {}; // 额外的请求头

  [@override](/user/override)
  var requestParameters; // 请求参数
}

class LoginResponse extends Decodable<LoginResponse> {
  String? userName;
  int? age;

  [@override](/user/override)
  LoginResponse fromJson(Map<String, dynamic> json) {
    return LoginResponse.fromJson(
      age: json["age"],
      userName: json["userName"],
    );
  }

  LoginResponse();

  LoginResponse.fromJson({required this.age, required this.userName});
}

void login() {
  Api().fetchData<LoginResponse, LoginResponse>(
    LoginRequest(email: "test@example.com", password: "password"),
    LoginResponse(),
  ).then((value) {
    // 处理成功或失败的结果
    if (value case Success(value: final value)) {
      print("登录成功: $value");
    } else if (value case Failure(exception: final exception)) {
      print("登录失败: $exception");
    }
  });
}