Flutter API封装插件api_wrap的使用

api_wrap 是一个用于 Flutter 的 API 封装插件，旨在简化 API 请求的处理，并提供更好的代码组织和可维护性。通过 api_wrap，你可以将 API 请求、响应处理和错误管理封装在一个统一的接口中，从而减少代码重复并提高开发效率。

安装 api_wrap

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

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

然后运行 flutter pub get 来安装插件。

使用 api_wrap

1. 创建 API 服务类

你可以创建一个 API 服务类来封装所有的 API 请求。例如：

import 'package:api_wrap/api_wrap.dart';

class ApiService {
  final ApiWrap _apiWrap = ApiWrap(baseUrl: 'https://api.example.com');

  Future<dynamic> fetchUserData(int userId) async {
    return await _apiWrap.get('/users/$userId');
  }

  Future<dynamic> postUserData(Map<String, dynamic> data) async {
    return await _apiWrap.post('/users', data: data);
  }
}

2. 使用 API 服务类

在你的 Flutter 应用中，你可以像这样使用 ApiService 类来发起 API 请求：

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

class MyApp extends StatelessWidget {
  final ApiService _apiService = ApiService();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('API Wrap Example'),
        ),
        body: Center(
          child: FutureBuilder(
            future: _apiService.fetchUserData(1),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.waiting) {
                return CircularProgressIndicator();
              } else if (snapshot.hasError) {
                return Text('Error: ${snapshot.error}');
              } else {
                return Text('User Data: ${snapshot.data}');
              }
            },
          ),
        ),
      ),
    );
  }
}

void main() => runApp(MyApp());

3. 处理错误

api_wrap 提供了内置的错误处理机制。你可以通过 onError 回调来处理 API 请求中的错误：

class ApiService {
  final ApiWrap _apiWrap = ApiWrap(
    baseUrl: 'https://api.example.com',
    onError: (error) {
      // 在这里处理错误
      print('API Error: $error');
    },
  );

  Future<dynamic> fetchUserData(int userId) async {
    return await _apiWrap.get('/users/$userId');
  }
}

4. 配置请求头

你可以通过 headers 参数来配置请求头：

class ApiService {
  final ApiWrap _apiWrap = ApiWrap(
    baseUrl: 'https://api.example.com',
    headers: {
      'Authorization': 'Bearer your_token_here',
    },
  );

  Future<dynamic> fetchUserData(int userId) async {
    return await _apiWrap.get('/users/$userId');
  }
}

5. 使用拦截器

api_wrap 还支持请求和响应拦截器，你可以在请求发送前或响应接收后进行一些处理：

class ApiService {
  final ApiWrap _apiWrap = ApiWrap(
    baseUrl: 'https://api.example.com',
    interceptors: [
      (request) {
        // 在请求发送前处理
        print('Sending request: ${request.url}');
        return request;
      },
      (response) {
        // 在响应接收后处理
        print('Received response: ${response.statusCode}');
        return response;
      },
    ],
  );

  Future<dynamic> fetchUserData(int userId) async {
    return await _apiWrap.get('/users/$userId');
  }
}