Flutter网络请求辅助插件http_helper的使用

http_helper 是一个为Dart设计的强大且易于使用的HTTP网络库，旨在封装在客户端应用程序中进行HTTP请求的复杂性。该库提供了一套高级API函数来发送HTTP请求和接收响应，它包装了http库的底层功能，为开发者提供了简化且更友好的接口。

以下是http_helper的主要特性：

1. 简化的请求方法：支持使用任何HTTP方法（GET, POST, PUT, PATCH, DELETE）发送HTTP请求。
2. HTTP错误处理：具备全面的错误处理机制以有效捕获和处理HTTP错误。
3. 超时设置：内置HTTP请求超时功能防止请求无限期挂起。
4. 中间件：提供中间件函数处理HTTP请求的不同阶段如发送前、发送后、超时等。
5. 默认头信息和参数：支持为HTTP请求设置默认头信息和参数，方便开发者批量发送相似请求。
6. 灵活的响应处理：允许用户指定如何将HTTP响应转换为所需的数据格式。

无论是在构建大型客户端应用还是仅需在小型项目中发起几个HTTP请求，http_helper都能帮助简化网络代码并使开发过程更加顺畅高效。

示例代码

示例 1: GET 请求返回对象作为响应

import 'package:http_helper/http_helper.dart';
import 'my_model.dart';

void main() async {
  // 定义URL和路径
  String url = 'jsonplaceholder.typicode.com';
  String path = '/posts/1';

  // 定义用于将响应转换为MyModel对象的转换器
  myToJsonConverter(response) {
    return MyModel.fromJson(response);
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.get,
    converter: myToJsonConverter,
  );

  // 发送请求
  var response = await HttpHelper.sendRequest<MyModel>(request);

  print(response.statusCode);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data.toString());
  } else {
    print(response.error!.message!);
  }
}

示例 2: GET 请求返回对象列表作为响应

import 'package:http_helper/http_helper.dart';
import 'my_model.dart';

void main() async {
  // 定义URL和路径
  String url = 'jsonplaceholder.typicode.com';
  String path = '/posts';

  // 定义用于将响应转换为MyModel对象的转换器
  myToJsonConverter(response) {
    var responseList = response as List;
    var mappedList = responseList.map((e) => e == null ? null : MyModel.fromJson(e as Map<String, dynamic>)).toList();
    var withoutNulls = List<MyModel>.from(mappedList.where((e) => e != null));
    return withoutNulls;
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.get,
    converter: myToJsonConverter,
  );

  // 发送请求
  var response = await HttpHelper.sendRequest<List<MyModel>>(request);

  print(response.statusCode);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data.toString());
  } else {
    print(response.error!.message!);
  }
}

示例 3: POST 请求包含头部和查询参数

import 'package:http_helper/http_helper.dart';
import 'my_model.dart';

void main() async {
  // 定义URL和路径
  String url = 'jsonplaceholder.typicode.com';
  String path = '/posts';

  Map<String, String> headers = {"Authorization": "Bearer your_token_here"};
  Map<String, dynamic> queryParams = {"userId": 1, "title": "Test Title", "body": "Test Body"};

  // 定义用于将响应转换为MyModel对象的转换器
  myToJsonConverter(response) {
    return MyModel.fromJson(response);
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.post,
    converter: myToJsonConverter,
    queryParameters: queryParams,
    headers: headers,
  );

  // 发送请求
  var response = await HttpHelper.sendRequest<MyModel>(request);

  print(response.statusCode);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data.toString());
  } else {
    print(response.error!.message!);
  }
}

示例 4: POST 请求包含主体内容

import 'package:http_helper/http_helper.dart';
import 'my_model.dart';

void main() async {
  // 定义URL和路径
  String url = 'jsonplaceholder.typicode.com';
  String path = '/posts';

  // 定义请求体
  final body = """
    {
      "userId": 1,
      "id": 10111,
      "title": "foo",
      "body": "bar"
    }
  """;

  // 定义用于将响应转换为MyModel对象的转换器
  myToJsonConverter(response) {
    return MyModel.fromJson(response);
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.post,
    converter: myToJsonConverter,
    body: body,
  );

  // 发送请求
  var response = await HttpHelper.sendRequest<MyModel>(request);

  print(response.statusCode);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data.toString());
  } else {
    print(response.error!.message!);
  }
}

示例 5: 使用中间件处理HTTP请求的不同阶段

import 'package:http_helper/http_helper.dart';
import 'my_model.dart';

void main() async {
  HttpHelper.defaultHeaders = {"App-Language": "en"};
  HttpHelper.timeoutDurationSeconds = 5;

  // 设置中间件函数
  HttpHelper.onBeforeSend = (request) {
    // 执行任何预发送逻辑
    print("Request ${request.method.name.toUpperCase()} is about to be sent: ${request.url}${request.path}");
    // 如果预发送逻辑决定不应发送请求，则返回HttpError
    return null;
  };

  HttpHelper.onAfterSend = (request, response) {
    print("Request has been sent, received response: ${response.statusCode}");
  };

  HttpHelper.onException = (request, exception) {
    print("An exception occurred: ${exception.toString()}");
  };

  HttpHelper.onTimeout = (request) {
    print("Request ${request.method} timed out: ${request.url}${request.path}");
  };

  // 定义URL和路径
  String url = 'jsonplaceholder.typicode.com';
  String path = '/posts';

  // 定义用于将响应转换为MyModel对象的转换器
  myToJsonConverter(response) {
    return MyModel.fromJson(response);
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.post,
    converter: myToJsonConverter,
  );

  // 发送请求
  var response = await HttpHelper.sendRequest<MyModel>(request);

  print(response.statusCode);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data.toString());
  } else {
    print(response.error!.message!);
  }
}

示例 6: 使用onBeforeSend中间件阻止未登录用户进入私有区域（虚构示例）

import 'package:http_helper/http_helper.dart';
import 'typicode_model.dart';

void main() async {
  // 设置中间件函数
  HttpHelper.onBeforeSend = (request) {
    if (!user.loggedIn) {
      // 返回HttpError阻止请求发送
      return HttpError(message: "You must be logged in to enter the private area");
    }
    return null;
  };

  // 定义URL和路径
  String url = 'accounts.example.com';
  String path = '/private';

  // 定义用于将响应转换为UserPrivateDetails对象的转换器
  myToJsonConverter(response) {
    return UserPrivateDetails.fromJson(response);
  }

  // 定义请求
  final request = HttpRequest(
    url: url,
    path: path,
    method: HttpRequestMethod.get,
    converter: myToJsonConverter,
  );

  // 发送请求
  final response = await HttpHelper.sendRequest<UserPrivateDetails>(request);

  // 打印响应数据
  if (response.isSuccess) {
    print(response.data);
  } else {
    print(response.error!.message!);
  }
}

以上是关于http_helper插件的基本介绍及使用示例，通过这些例子可以更好地理解如何利用此插件简化Flutter应用中的网络请求操作。希望这些信息对您有所帮助！