Flutter网络请求辅助插件dio_helper_api的使用

在Flutter开发中，处理网络请求是一个常见的任务。为了简化这一过程，可以使用dio库作为基础，并结合一个封装良好的辅助类来实现更高效的网络请求管理。以下是如何使用dio_helper_api插件的详细说明。

Dio Documentation

• 参考文档: https://pub.dev/packages/dio

示例代码

首先，确保你已经在项目的pubspec.yaml文件中添加了dio依赖：

dependencies:
  dio: ^4.0.0

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

接下来，我们创建一个WeatherApi类来封装网络请求逻辑：

import 'package:dio/dio.dart';
import 'package:flutter/services.dart' show rootBundle;

// 定义一个Api类来封装dio实例
class Api {
  final String baseUrl;
  final String accessToken;
  final String refreshToken;
  final Function(String) onTokenRefreshed;
  final String serverCertificate;
  final int connectTimeout;
  final int receiveTimeout;
  final Map<String, dynamic> header;

  late Dio dio;

  Api({
    required this.baseUrl,
    required this.accessToken,
    required this.refreshToken,
    required this.onTokenRefreshed,
    required this.serverCertificate,
    required this.connectTimeout,
    required this.receiveTimeout,
    required this.header,
  }) {
    // 初始化Dio实例
    dio = Dio(BaseOptions(
      baseUrl: baseUrl,
      connectTimeout: Duration(seconds: connectTimeout),
      receiveTimeout: Duration(seconds: receiveTimeout),
      headers: header,
    ));
  }

  void onInit() {
    // 在这里可以添加额外的初始化逻辑
    debugPrint('Api initialized with base URL: $baseUrl');
  }
}

// 创建WeatherApi类来获取Dio实例
class WeatherApi {
  Dio dioApi() {
    // 获取环境变量中的base URL
    String baseUrl = 'https://api.openweathermap.org';

    // 设置API配置
    Api api = Api(
      baseUrl: baseUrl,
      accessToken: '', // 如果有访问令牌，可以在这里设置
      refreshToken: '', // 如果有刷新令牌，可以在这里设置
      onTokenRefreshed: (newToken) {
        debugPrint('New token: $newToken');
      },
      serverCertificate: '', // 如果需要验证服务器证书，可以在这里设置
      connectTimeout: 180, // 连接超时时间（秒）
      receiveTimeout: 180, // 接收数据超时时间（秒）
      header: {}, // 自定义请求头
    );

    // 初始化Api实例
    api.onInit();

    // 返回Dio实例
    return api.dio;
  }
}

接下来，我们创建一个WeatherService类来使用WeatherApi进行实际的网络请求：

import 'package:get/get.dart';
import 'weather_api.dart'; // 导入WeatherApi类

// 使用GetX框架管理状态
class WeatherService extends GetxService {
  final WeatherApi api;

  WeatherService({required this.api});

  // 示例方法：获取天气信息
  Future<Map<String, dynamic>> fetchWeatherData(String city) async {
    try {
      // 调用Dio实例发送GET请求
      Response response = await api.dioApi().get('/data/2.5/weather', queryParameters: {
        'q': city,
        'appid': 'your_open_weather_map_api_key', // 替换为你的OpenWeatherMap API密钥
      });

      // 检查响应状态码
      if (response.statusCode == 200) {
        return response.data; // 返回解析后的JSON数据
      } else {
        throw Exception('Failed to load weather data');
      }
    } catch (e) {
      // 捕获并打印错误信息
      debugPrint('Error fetching weather data: $e');
      rethrow;
    }
  }
}

最后，在应用程序的主入口处初始化WeatherService并调用它：

import 'package:flutter/material.dart';
import 'package:get/get.dart';
import 'weather_service.dart'; // 导入WeatherService类

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return GetMaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Dio Helper Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              // 初始化WeatherService
              WeatherApi weatherApi = WeatherApi();
              WeatherService weatherService = WeatherService(api: weatherApi);

              // 调用fetchWeatherData方法
              Map<String, dynamic> weatherData = await weatherService.fetchWeatherData('London');

              // 打印返回的数据
              debugPrint('Weather Data: $weatherData');
            },
            child: Text('Fetch Weather Data'),
          ),
        ),
      ),
    );
  }
}