Flutter网络请求插件http_dio的使用

http_dio 是一个用于 Flutter 的网络请求插件，它基于 Dio 库，提供了更简洁的 API 来进行网络请求。Dio 是 Dart 语言中一个强大的 HTTP 客户端，支持拦截器、全局配置、FormData、文件上传/下载、请求取消等功能。

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 http_dio 依赖：

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

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

2. 导入包

在你的 Dart 文件中导入 http_dio：

import 'package:http_dio/http_dio.dart';

3. 基本使用

3.1 创建 HttpDio 实例

你可以创建一个 HttpDio 实例来发起网络请求：

final httpDio = HttpDio();

3.2 发起 GET 请求

void fetchData() async {
  final response = await httpDio.get('https://jsonplaceholder.typicode.com/posts/1');
  print(response.data);
}

3.3 发起 POST 请求

void postData() async {
  final response = await httpDio.post(
    'https://jsonplaceholder.typicode.com/posts',
    data: {
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    },
  );
  print(response.data);
}

3.4 发起 PUT 请求

void updateData() async {
  final response = await httpDio.put(
    'https://jsonplaceholder.typicode.com/posts/1',
    data: {
      'id': 1,
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    },
  );
  print(response.data);
}

3.5 发起 DELETE 请求

void deleteData() async {
  final response = await httpDio.delete('https://jsonplaceholder.typicode.com/posts/1');
  print(response.data);
}

4. 配置 HttpDio

你可以通过 HttpDio 的构造函数来配置一些全局选项，例如超时时间、拦截器等。

final httpDio = HttpDio(
  options: BaseOptions(
    baseUrl: 'https://jsonplaceholder.typicode.com',
    connectTimeout: 5000,
    receiveTimeout: 3000,
  ),
  interceptors: [
    InterceptorsWrapper(
      onRequest: (options, handler) {
        // 在请求之前做一些处理
        return handler.next(options);
      },
      onResponse: (response, handler) {
        // 在响应之前做一些处理
        return handler.next(response);
      },
      onError: (DioError e, handler) {
        // 在错误时做一些处理
        return handler.next(e);
      },
    ),
  ],
);

5. 文件上传

http_dio 也支持文件上传：

void uploadFile() async {
  final formData = FormData.fromMap({
    'file': await MultipartFile.fromFile('path/to/file', filename: 'upload.txt'),
  });

  final response = await httpDio.post(
    'https://example.com/upload',
    data: formData,
  );
  print(response.data);
}

6. 文件下载

你还可以使用 http_dio 下载文件：

void downloadFile() async {
  final response = await httpDio.download(
    'https://example.com/file',
    'path/to/save/file',
  );
  print('File downloaded to ${response.data}');
}

7. 错误处理

http_dio 会自动处理网络请求中的错误，你可以通过 try-catch 来捕获异常：

void fetchData() async {
  try {
    final response = await httpDio.get('https://jsonplaceholder.typicode.com/posts/1');
    print(response.data);
  } catch (e) {
    print('Error: $e');
  }
}

8. 取消请求

你可以使用 CancelToken 来取消请求：

void fetchData() async {
  final cancelToken = CancelToken();

  httpDio.get(
    'https://jsonplaceholder.typicode.com/posts/1',
    cancelToken: cancelToken,
  ).then((response) {
    print(response.data);
  }).catchError((e) {
    if (CancelToken.isCancel(e)) {
      print('Request canceled');
    } else {
      print('Error: $e');
    }
  });

  // 取消请求
  cancelToken.cancel('Request canceled by user');
}