Flutter网络API请求插件apklis_dio_web_api的使用

apklis_dio_web_api 是一个基于 Dio 的 Flutter 插件，用于简化网络 API 请求。它提供了一个简单的方式来处理 HTTP 请求、响应、错误处理等。以下是如何使用 apklis_dio_web_api 插件的详细步骤。

1. 添加依赖

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

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

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

2. 导入包

在你的 Dart 文件中导入 apklis_dio_web_api 包：

import 'package:apklis_dio_web_api/apklis_dio_web_api.dart';

3. 初始化 ApklisDioWebApi

在你的应用程序启动时，初始化 ApklisDioWebApi。你可以在 main 函数中进行初始化：

void main() {
  ApklisDioWebApi.initialize(
    baseUrl: 'https://api.example.com', // 你的 API 基础 URL
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN', // 如果需要，添加请求头
    },
  );
  runApp(MyApp());
}

4. 发起 API 请求

你可以使用 ApklisDioWebApi 提供的方法来发起 GET、POST、PUT、DELETE 等请求。

4.1 GET 请求

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

4.2 POST 请求

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

4.3 PUT 请求

Future<void> updateData() async {
  try {
    var response = await ApklisDioWebApi.put(
      '/endpoint/1',
      data: {
        'key1': 'new_value1',
        'key2': 'new_value2',
      },
    );
    print('Response: ${response.data}');
  } catch (e) {
    print('Error: $e');
  }
}

4.4 DELETE 请求

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

5. 处理错误

ApklisDioWebApi 会自动处理常见的网络错误，并将错误信息返回给调用者。你可以在 try-catch 块中捕获这些错误并进行处理。

6. 自定义配置

你可以在初始化时传递自定义的 Dio 配置，例如超时时间、拦截器等：

ApklisDioWebApi.initialize(
  baseUrl: 'https://api.example.com',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  },
  dioOptions: BaseOptions(
    connectTimeout: 5000,
    receiveTimeout: 3000,
  ),
);

7. 使用拦截器

你可以添加自定义的拦截器来处理请求和响应：

ApklisDioWebApi.initialize(
  baseUrl: 'https://api.example.com',
  interceptors: [
    InterceptorsWrapper(
      onRequest: (options, handler) {
        // 在请求发送之前做一些处理
        return handler.next(options);
      },
      onResponse: (response, handler) {
        // 在收到响应之前做一些处理
        return handler.next(response);
      },
      onError: (error, handler) {
        // 在发生错误时做一些处理
        return handler.next(error);
      },
    ),
  ],
);

8. 示例代码

以下是一个完整的示例代码，展示了如何使用 apklis_dio_web_api 插件：

import 'package:flutter/material.dart';
import 'package:apklis_dio_web_api/apklis_dio_web_api.dart';

void main() {
  ApklisDioWebApi.initialize(
    baseUrl: 'https://jsonplaceholder.typicode.com',
  );
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('ApklisDioWebApi Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: fetchData,
            child: Text('Fetch Data'),
          ),
        ),
      ),
    );
  }

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