Flutter网络请求清理响应数据插件dio_clean_http_response的使用

Flutter网络请求清理响应数据插件dio_clean_http_response的使用

1. 简介

dio_clean_http_response 是一个Dart包，旨在简化在使用Dio库时处理HTTP响应的过程。它提供了干净、结构化且可定制的错误处理机制，适用于各种HTTP失败场景。通过这个插件，您可以更轻松地将Dio HTTP响应转换为成功的结果或详细的错误信息。

2. 主要特性

• 简洁的API集成：无缝集成到Dio请求中，使错误管理更加健壮和易于维护。
• 结构化的错误处理：使用HttpFailure密封类的不同子类型来轻松管理Dio异常，每个子类型代表一个特定的HTTP失败场景。
• 本地化支持：自定义不同场景下的错误消息，支持多语言实现。

3. 安装

在pubspec.yaml文件中添加以下依赖：

dependencies:
  dio_clean_http_response: ^2.0.0
  dio: ^5.4.0

然后运行以下命令来安装依赖：

pub get

4. 使用示例

以下是一个完整的示例，展示了如何使用dio_clean_http_response进行网络请求并处理响应数据。

示例代码

import 'package:dio/dio.dart';
import 'package:dio_clean_http_response/src/dio_clean_http_response_extension.dart';

// 定义PostModel类，用于表示从API获取的帖子数据
class PostModel {
  final int id;
  final int userId;
  final String title;
  final String body;

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

  // 从JSON映射创建PostModel实例
  factory PostModel.fromJson(Map<String, dynamic> json) {
    return PostModel(
      id: json["id"] as int,
      userId: json["userId"] as int,
      title: json["title"] as String,
      body: json["body"] as String,
    );
  }

  [@override](/user/override)
  String toString() =>
      '🟩\nPOST $id \nuserId: $userId \ntitle: $title \nbody:$body\n';
}

void main() async {
  // 创建Dio客户端，并设置基础URL
  final httpClient = Dio(
    BaseOptions(
      baseUrl: 'https://jsonplaceholder.typicode.com',
      validateStatus: (status) => status != 400, // 自定义状态码验证逻辑
    ),
  );

  // 获取单个帖子数据
  final postModelOrFailure = await httpClient
      .get('/posts/1')
      .fromJson(PostModel.fromJson); // 使用fromJson方法解析单个对象

  // 处理结果，使用fold方法处理Either类型的返回值
  postModelOrFailure.fold(
    (failure) => print(failure.message()), // 处理失败情况
    (postModel) => print(postModel), // 处理成功情况
  );

  // 获取多个帖子数据
  final postModelsListOrFailure = await httpClient
      .get('/posts')
      .fromJsonAsList(PostModel.fromJson); // 使用fromJsonAsList方法解析列表

  // 处理结果，使用fold方法处理Either类型的返回值
  postModelsListOrFailure.fold(
    (failure) => print(failure.message()), // 处理失败情况
    (postModelsList) => print(postModelsList), // 处理成功情况
  );

  // 测试400状态码的情况
  final postModelOrFailure400 = await httpClient
      .get('https://httpstat.us/400')
      .fromJson(PostModel.fromJson);

  postModelOrFailure400.fold(
    (failure) => print(failure.message()), // 处理失败情况
    (postModel) => print(postModel), // 处理成功情况
  );

  // 测试503状态码的情况
  final postModelsListOrFailure400 = await httpClient
      .get('https://httpstat.us/503')
      .fromJsonAsList(PostModel.fromJson);

  postModelsListOrFailure400.fold(
    (failure) => print(failure.message()), // 处理失败情况
    (postModelsList) => print(postModelsList), // 处理成功情况
  );
}