Flutter 极简 Dio 组件二次封装文档_flutter dio的封装

---

前言

本文档介绍了如何通过二次封装 Flutter Dio 组件来简化网络请求的过程。通过封装，我们可以提高代码复用性，简化调用方式，并添加一些常用的功能，使网络请求更加易于管理和维护。

---

一、添加依赖

首先，确保你的 Flutter 项目已经添加了 Dio 的依赖。在项目的 pubspec.yaml 文件中，添加以下依赖：

dependencies:
  dio: ^4.0.0

1
2
3

然后运行 flutter pub get 来获取最新的依赖包。

二、创建封装类

创建一个新的 Dart 类来封装 Dio 组件的功能。例如，我们可以创建一个名为 ApiService 的类。

import 'package:dio/dio.dart';

class ApiService {
  final Dio _dio;

  ApiService() : _dio = Dio() {
    // 在这里可以添加一些公共配置，如请求超时时间、拦截器等
    _dio.options.baseUrl = 'https://api.example.com';
    _dio.options.connectTimeout = 5000; // 设置请求超时时间为5秒
  }

  // 在这里添加封装后的网络请求方法
  Future<Response> fetchData(String path, {Map<String, dynamic>? params}) async {
    try {
      final response = await _dio.get(path, queryParameters: params);
      return response;
    } catch (e) {
      throw Exception('网络请求失败');
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

在上面的示例代码中，我们创建了一个名为 ApiService 的类，它内部包含一个 _dio 实例来处理网络请求。在构造函数中，我们可以进行一些公共配置，例如设置基本 URL、请求超时时间等。

接下来，在 ApiService 类中，我们添加了一个 fetchData 方法来发送 GET 请求。该方法接受一个路径参数和一个可选的参数 Map，用于传递查询参数。在方法内部，我们使用 Dio 组件的 get 方法发送请求，并返回响应结果。

你可以根据实际需求，继续添加其他类型的请求方法（如 POST、PUT、DELETE 等）或其他功能。

三、使用封装类

在你的 Flutter 项目中，你可以通过实例化 ApiService 类来使用封装后的网络请求方法。以下是一个简单的示例：

final apiService = ApiService();

void fetchData() async {
  try {
    final response = await apiService.fetchData('/data', params: {'id': 1});
    // 处理响应结果
    print(response.data);
  } catch (e) {
    // 处理异常
    print(e.toString());
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

在上面的示例中，我们首先创建了一个 ApiService 实例 apiService，然后使用它来调用封装的 fetchData 方法进行网络请求。在 catch 块中，我们处理了可能出现的异常情况，并打印出错误信息。

根据实际需要，你可以进一步完善和扩展封装类的功能，以满足项目的具体要求。

四、拦截器

Dio 组件支持拦截器，你可以在请求发送前或响应返回后对其进行处理。这为添加公共参数、鉴权等功能提供了便利。

以下是一个示例，演示如何使用拦截器在请求头中添加 Token。

class ApiService {
  final Dio _dio;

  ApiService() : _dio = Dio() {
    // 在这里可以添加一些公共配置，如请求超时时间、拦截器等
    _dio.options.baseUrl = 'https://api.example.com';
    _dio.options.connectTimeout = 5000; // 设置请求超时时间为5秒

    // 添加拦截器
    _dio.interceptors.add(
      InterceptorsWrapper(
        onRequest: (options, handler) {
          // 在请求头中添加 Token
          final token = getToken(); // 获取 Token 的方法，根据实际情况替换
          options.headers['Authorization'] = 'Bearer $token';

          return handler.next(options);
        },
      ),
    );
  }

  // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

在上面的示例中，我们通过创建 InterceptorsWrapper 实例并添加到 _dio 的拦截器列表中来实现拦截器功能。在 onRequest 回调中，我们可以对请求进行修改或添加处理逻辑。在这个示例中，我们在请求头中添加了一个名为 “Authorization” 的字段，并设置其值为 Token。

你可以根据实际需求，添加其他拦截器来实现各种功能，例如日志记录、缓存等。

五、错误处理

在网络请求中，错误处理是非常重要的。你可以通过 Dio 组件的错误类型来捕获和处理不同的错误情况。

以下是一个示例，演示如何处理网络请求异常：

class ApiService {
  // ...

  Future<Response> fetchData(String path, {Map<String, dynamic>? params}) async {
    try {
      final response = await _dio.get(path, queryParameters: params);
      return response;
    } catch (e) {
      if (e is DioError) {
        // DioError 是 Dio 组件的异常类型，可以根据不同的错误类型进行处理
        if (e.type == DioErrorType.connectTimeout) {
          throw Exception('连接超时，请检查网络连接');
        } else if (e.type == DioErrorType.response) {
          // 如果服务器返回了错误响应，可以通过 e.response 来获取响应信息
          final statusCode = e.response?.statusCode;
          final errorMessage = e.response?.statusMessage;
          throw Exception('请求失败：$statusCode $errorMessage');
        } else {
          throw Exception('请求失败，请稍后重试');
        }
      } else {
        throw Exception('网络请求失败');
      }
    }
  }

  // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

在上面的示例中，我们首先捕获 Dio 组件的异常类型 DioError。然后根据不同的错误类型，我们可以自定义异常信息并抛出异常。

这只是一个简单的示例，你可以根据项目需求，进一步完善错误处理逻辑，并定义更多的异常类型。

---

总结

通过对 Flutter Dio 组件进行二次封装，我们可以提高代码的复用性和可维护性，简化网络请求的调用过程。在封装过程中，我们可以添加拦截器、处理错误等功能，使网络请求更加灵活和可靠。

希望本文档能够帮助你了解如何二次封装 Flutter Dio 组件，并在实际项目中应用。如果你对 Dio 组件有更深入的需求，建议参考 Dio 官方文档以获取更多详细信息。

祝你在 Flutter 开发中取得成功！如有任何疑问，请随时提问。