Flutter网络请求增强插件custom_dio_fix的使用

Flutter网络请求增强插件custom_dio_fix的使用

简介

custom_dio_fix 是一个基于 custom_dio 的网络请求插件，专门为 Flutter 设计。它提供了简单易用的 API 来处理常见的 HTTP 请求，包括 GET、POST、上传文件、删除、更新等操作。

使用步骤

1. 初始化插件

在发送任何请求之前，必须调用 CustomDio.setInitData 方法来初始化基础配置。

WidgetsFlutterBinding.ensureInitialized();
CustomDio.setInitData(
  CustomDioOptions(
    baseUrl: "http://www.example.com/api/v1/", // 设置默认的 API 基础地址
    headers: {"authorization": "Bearer xxx"}, // 设置全局请求头
  ),
);

示例代码

2. POST 请求

用于发送带有 JSON 数据的 POST 请求。

try {
  final response = await CustomDio()
      .send(
        reqMethod: RequestMethod.post, // 指定请求方法为 POST
        path: "user/login", // 请求路径
        body: {"email": "test@example.com"}, // 请求体
      );
  print("POST Response: ${response.data}");
} catch (err) {
  print("Error: ${err.toString()}");
}

3. GET 请求

用于发送带有查询参数的 GET 请求。

try {
  final response = await CustomDio()
      .send(
        reqMethod: RequestMethod.get, // 指定请求方法为 GET
        path: "user/profile", // 请求路径
        query: {"userId": "12345"}, // 查询参数
      );
  print("GET Response: ${response.data}");
} catch (err) {
  print("Error: ${err.toString()}");
}

4. 文件上传

用于上传单个文件到服务器。

try {
  final response = await CustomDio()
      .uploadFile(
        path: "upload/file", // 请求路径
        filePath: "/path/to/file.png", // 文件路径
        body: [
          {"description": "This is a test file"}, // 可选的附加请求体
        ],
      );
  print("Upload Response: ${response.data}");
} catch (err) {
  print("Error: ${err.toString()}");
}

5. 上传二进制数据

用于上传二进制文件（如图片或文件流）。

try {
  final response = await CustomDio().uploadBytes(
    path: "upload/image", // 请求路径
    bytesExtension: "png", // 文件扩展名
    bytes: bytes, // 二进制数据
    body: [
      {"description": "Binary file upload"}, // 可选的附加请求体
    ],
  );
  print("Upload Bytes Response: ${response.data}");
} catch (err) {
  print("Error: ${err.toString()}");
}

6. DELETE 请求

用于发送 DELETE 请求以删除资源。

Future<void> deleteResource() async {
  try {
    final response = await CustomDio()
        .send(
          reqMethod: RequestMethod.delete, // 指定请求方法为 DELETE
          path: "resources/123", // 请求路径
        );
    print("DELETE Response: ${response.data}");
  } catch (err) {
    print("Error: ${err.toString()}");
  }
}

7. 单个资源获取

用于获取特定 ID 的资源。

Future<void> getResourceById() async {
  try {
    final response = await CustomDio()
        .send(
          reqMethod: RequestMethod.get, // 指定请求方法为 GET
          path: "resources/123", // 请求路径
        );
    print("GET Resource by ID Response: ${response.data}");
  } catch (err) {
    print("Error: ${err.toString()}");
  }
}

8. PATCH 请求

用于更新资源的部分信息。

Future<void> updateResource() async {
  try {
    final response = await CustomDio()
        .send(
          reqMethod: RequestMethod.patch, // 指定请求方法为 PATCH
          path: "resources/123", // 请求路径
          body: {"status": "active"}, // 更新的数据
        );
    print("PATCH Response: ${response.data}");
  } catch (err) {
    print("Error: ${err.toString()}");
  }
}

完整示例代码

以下是一个完整的示例代码，展示了如何集成 custom_dio_fix 并发送多种类型的请求。

import 'package:custom_dio_fix/custom_dio.dart';
import 'package:flutter/material.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  CustomDio.setInitData(
    CustomDioOptions(
      baseUrl: "http://www.example.com/api/v1/",
      headers: {"authorization": "Bearer xxx"},
    ),
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text("custom_dio_fix Example")),
        body: const Center(
          child: Text("Check the console for responses!"),
        ),
      ),
    );
  }
}

// 示例函数：发送 POST 请求
Future<void> postRequest() async {
  try {
    final response = await CustomDio()
        .send(
          reqMethod: RequestMethod.post,
          path: "user/login",
          body: {"email": "test@example.com"},
        );
    print("POST Response: ${response.data}");
  } catch (err) {
    print("Error: ${err.toString()}");
  }
}

// 示例函数：发送 GET 请求
Future<void> getRequest() async {
  try {
    final response = await CustomDio()
        .send(
          reqMethod: RequestMethod.get,
          path: "user/profile",
          query: {"userId": "12345"},
        );
    print("GET Response: ${response.data}");
  } catch (err) {
    print("Error: ${err.toString()}");
  }
}