Flutter网络请求插件try_dio的使用

try_dio 是一个基于 Dio 的 Flutter 网络请求插件，它简化了网络请求的使用，提供了更友好的 API 和错误处理机制。Dio 是一个强大的 Dart HTTP 客户端，支持拦截器、全局配置、FormData、请求取消等功能。

以下是如何在 Flutter 项目中使用 try_dio 插件的步骤：

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  try_dio: ^最新版本

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

2. 导入包

在需要使用 try_dio 的文件中导入包：

import 'package:try_dio/try_dio.dart';

3. 初始化 TryDio

在使用 try_dio 之前，你可以选择初始化它。通常，你可以在 main.dart 中进行全局初始化：

void main() {
  TryDio.init(
    baseUrl: 'https://jsonplaceholder.typicode.com',
    connectTimeout: 5000,
    receiveTimeout: 3000,
  );
  runApp(MyApp());
}

4. 发起网络请求

try_dio 提供了多种方法来发起网络请求，以下是几个常用的例子：

GET 请求

Future<void> fetchData() async {
  try {
    var response = await TryDio.get('/posts/1');
    print('Response data: ${response.data}');
  } catch (e) {
    print('Error: $e');
  }
}

POST 请求

Future<void> postData() async {
  try {
    var response = await TryDio.post('/posts', data: {
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    });
    print('Response data: ${response.data}');
  } catch (e) {
    print('Error: $e');
  }
}

PUT 请求

Future<void> updateData() async {
  try {
    var response = await TryDio.put('/posts/1', data: {
      'id': 1,
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    });
    print('Response data: ${response.data}');
  } catch (e) {
    print('Error: $e');
  }
}

DELETE 请求

Future<void> deleteData() async {
  try {
    var response = await TryDio.delete('/posts/1');
    print('Response data: ${response.data}');
  } catch (e) {
    print('Error: $e');
  }
}

5. 错误处理

try_dio 会自动处理网络请求中的错误，并将错误信息返回给调用者。你可以通过 try-catch 块来捕获并处理这些错误。

Future<void> fetchData() async {
  try {
    var response = await TryDio.get('/posts/1');
    print('Response data: ${response.data}');
  } on DioError catch (e) {
    print('DioError: ${e.message}');
  } catch (e) {
    print('Error: $e');
  }
}

6. 拦截器

try_dio 也支持拦截器，你可以在请求发起前或响应返回后进行一些操作。

TryDio.addInterceptor(InterceptorsWrapper(
  onRequest: (options, handler) {
    // 在请求发起前做一些操作
    print('Request: ${options.uri}');
    return handler.next(options);
  },
  onResponse: (response, handler) {
    // 在响应返回后做一些操作
    print('Response: ${response.data}');
    return handler.next(response);
  },
  onError: (DioError e, handler) {
    // 在发生错误时做一些操作
    print('Error: ${e.message}');
    return handler.next(e);
  },
));

7. 取消请求

try_dio 支持取消请求，你可以通过 CancelToken 来取消正在进行的请求。

CancelToken cancelToken = CancelToken();

Future<void> fetchData() async {
  try {
    var response = await TryDio.get('/posts/1', cancelToken: cancelToken);
    print('Response data: ${response.data}');
  } catch (e) {
    if (CancelToken.isCancel(e)) {
      print('Request cancelled');
    } else {
      print('Error: $e');
    }
  }
}

void cancelRequest() {
  cancelToken.cancel('Request cancelled by user');
}

8. 其他配置

try_dio 还支持其他配置，如设置请求头、超时时间、代理等。

TryDio.updateOptions(
  headers: {
    'Authorization': 'Bearer your_token',
  },
  connectTimeout: 10000,
  receiveTimeout: 10000,
);