Flutter中使用Dio库封装网络请求服务工具类

在Flutter应用程序中，进行网络请求是非常常见的任务。Dio是一个强大的、易于使用的Dart包，用于处理HTTP请求。本篇博客将介绍如何封装Dio库，以及如何在Flutter应用中进行网络请求并取消请求。

什么是Dio？

Dio是一个基于Dart语言的强大的HTTP客户端库，用于与REST API进行通信。它提供了许多功能，包括异步请求、拦截器支持、取消请求、文件下载和上传等。

封装Dio网络请求库

为了更好地组织和管理网络请求代码，我们可以将Dio的实例和常见的HTTP请求操作封装到一个类中。下面是一个简单的示例：

import 'package:dio/dio.dart';

class HttpManager {
  static Dio _dio;

  static Dio getInstance() {
    if (_dio == null) {
      _dio = Dio();
      // 配置 Dio 实例
      _dio.options.baseUrl = 'https://api.example.com/';
      _dio.interceptors.add(LogInterceptor());
    }
    return _dio;
  }

  // get 请求
  static Future<Response> get(String url, {Map<String, dynamic> params, CancelToken cancelToken}) async {
    return await _dio.get(url, queryParameters: params, cancelToken: cancelToken);
  }

  // post 请求
  static Future<Response> post(String url, {Map<String, dynamic> data, CancelToken cancelToken}) async {
    return await _dio.post(url, data: data, cancelToken: cancelToken);
  }

  // put 请求
  static Future<Response> put(String url, {Map<String, dynamic> data, CancelToken cancelToken}) async {
    return await _dio.put(url, data: data, cancelToken: cancelToken);
  }

  // delete 请求
  static Future<Response> delete(String url, {CancelToken cancelToken}) async {
    return await _dio.delete(url, cancelToken: cancelToken);
  }

  // 取消请求
  static void cancelRequests(CancelToken cancelToken) {
    cancelToken.cancel("请求已被取消");
  }
}

在上面的代码中，我们创建了一个名为HttpManager的类，其中包含了一个getInstance方法用于获取Dio的单例实例，以及封装了常见的HTTP请求方法（GET、POST、PUT、DELETE）。

如何使用封装的HttpManager类？

现在我们已经封装了一个用于处理HTTP请求的类，我们可以在我们的Flutter应用程序中使用它。以下是一个简单的示例：

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

import 'http_manager.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Dio Demo',
      home: HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  CancelToken _cancelToken = CancelToken();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Dio Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            _fetchData();
          },
          child: Text('Fetch Data'),
        ),
      ),
    );
  }

  void _fetchData() async {
    try {
      Response response = await HttpManager.get('example_endpoint', cancelToken: _cancelToken);
      print(response.data);
    } catch (e) {
      print('Error: $e');
    }
  }

  @override
  void dispose() {
    // 页面销毁时取消请求
    HttpManager.cancelRequests(_cancelToken);
    super.dispose();
  }
}

在上面的示例中，我们在HomePage组件的dispose方法中调用了HttpManager.cancelRequests方法，以确保页面销毁时取消尚未完成的请求。

结论

在本篇博客中，我们学习了如何在Flutter应用中使用Dio库进行网络请求，并封装了一个简单的网络请求库。封装网络请求可以帮助我们更好地组织和管理代码，使其更易于维护和扩展。希望这篇博客对你有所帮助！