Flutter网络请求工具插件xh_dio_utils的使用

xh_dio_utils 是一个基于 dio 的 Flutter 网络请求工具插件，它简化了网络请求的配置和使用，提供了更加便捷的 API 来进行网络请求。以下是如何使用 xh_dio_utils 的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 xh_dio_utils 依赖：

dependencies:
  flutter:
    sdk: flutter
  xh_dio_utils: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 初始化 XhDioUtils

在使用 xh_dio_utils 之前，需要先进行初始化。通常可以在 main.dart 中进行初始化：

import 'package:xh_dio_utils/xh_dio_utils.dart';

void main() {
  XhDioUtils.init(
    baseUrl: 'https://api.example.com', // 你的API基础URL
    connectTimeout: 5000, // 连接超时时间
    receiveTimeout: 3000, // 接收超时时间
    interceptors: [], // 可以添加自定义拦截器
  );
  runApp(MyApp());
}

3. 发起网络请求

xh_dio_utils 提供了多种方法来发起网络请求，包括 GET、POST、PUT、DELETE 等。

GET 请求

import 'package:xh_dio_utils/xh_dio_utils.dart';

Future<void> fetchData() async {
  try {
    var response = await XhDioUtils.get('/path/to/endpoint', queryParameters: {'param1': 'value1'});
    print(response.data);
  } catch (e) {
    print('Error: $e');
  }
}

POST 请求

import 'package:xh_dio_utils/xh_dio_utils.dart';

Future<void> postData() async {
  try {
    var response = await XhDioUtils.post('/path/to/endpoint', data: {'key1': 'value1', 'key2': 'value2'});
    print(response.data);
  } catch (e) {
    print('Error: $e');
  }
}

PUT 请求

import 'package:xh_dio_utils/xh_dio_utils.dart';

Future<void> updateData() async {
  try {
    var response = await XhDioUtils.put('/path/to/endpoint', data: {'key1': 'updatedValue'});
    print(response.data);
  } catch (e) {
    print('Error: $e');
  }
}

DELETE 请求

import 'package:xh_dio_utils/xh_dio_utils.dart';

Future<void> deleteData() async {
  try {
    var response = await XhDioUtils.delete('/path/to/endpoint');
    print(response.data);
  } catch (e) {
    print('Error: $e');
  }
}

4. 处理响应

xh_dio_utils 的请求方法返回的是一个 Response 对象，你可以通过 response.data 来获取响应的数据。

var response = await XhDioUtils.get('/path/to/endpoint');
print(response.data); // 打印响应数据

5. 错误处理

xh_dio_utils 会自动处理一些常见的网络错误，但你也可以在 catch 块中自定义错误处理逻辑。

try {
  var response = await XhDioUtils.get('/path/to/endpoint');
  print(response.data);
} catch (e) {
  print('Error: $e');
}

6. 添加拦截器

你可以在初始化时添加自定义拦截器，例如日志拦截器、认证拦截器等。

XhDioUtils.init(
  baseUrl: 'https://api.example.com',
  interceptors: [
    InterceptorsWrapper(
      onRequest: (options, handler) {
        // 在请求发送之前做一些处理
        print('Request: ${options.uri}');
        handler.next(options);
      },
      onResponse: (response, handler) {
        // 在响应返回之前做一些处理
        print('Response: ${response.data}');
        handler.next(response);
      },
      onError: (error, handler) {
        // 在请求失败时做一些处理
        print('Error: $error');
        handler.next(error);
      },
    ),
  ],
);

7. 其他功能

xh_dio_utils 还提供了其他一些功能，例如文件上传、下载、取消请求等。你可以根据需要使用这些功能。

文件上传

var response = await XhDioUtils.upload('/path/to/upload', filePath: '/path/to/file');
print(response.data);

文件下载

var response = await XhDioUtils.download('/path/to/download', savePath: '/path/to/save');
print(response.data);

取消请求

var cancelToken = CancelToken();
XhDioUtils.get('/path/to/endpoint', cancelToken: cancelToken);

// 取消请求
cancelToken.cancel();