使用Dio实现Flutter网络请求(网络请求工具类)

前言
在Flutter应用中，网络请求是一个不可避免的需求。为了方便、灵活地处理网络请求，我们可以使用第三方库Dio。本文将介绍如何使用Dio库实现网络请求，并结合工厂模式和单例模式创建一个简洁而高效的网络请求工具类

一、 Dio简介

Dio是一个强大且易于使用的Flutter网络请求库。它支持RESTful API、文件上传、拦截器、请求取消等功能，使得网络请求变得更加灵活。

二、工厂模式和单例模式

在设计网络请求工具类时，我们使用了工厂模式和单例模式。

工厂模式： 通过工厂模式，我们可以在构造函数中进行一些初始化操作，并保证只有一个实例被创建。 单例模式：
单例模式确保在应用中只有一个网络请求工具类的实例，避免重复创建对象，节省资源。

三、导入依赖

引入后记得put get

dio: ^4.0.6

四、Dio网络请求工具类设计

/// 自定义枚举
enum Method { get, post }

class Net {
  // 工厂模式
  factory Net() => _getInstance()!;

  static Net? get instance => _getInstance();
  static Net? _instance;

  late Dio dio;

  Net._internal() {
    // 初始化
    dio = Dio(BaseOptions(
      connectTimeout: 60 * 1000, // 连接服务器超时时间，单位是毫秒.
      receiveTimeout: 60 * 1000, // 响应流上前后两次接受到数据的间隔，单位为毫秒, 这并不是接收数据的总时限.
    ));
  }

  // 单列模式
  static Net? _getInstance() {
    _instance ??= Net._internal();
    return _instance;
  }

  get(String url, Map<String, dynamic> params, {Function? success}) {
    _doRequest(url, params, Method.get, success);
  }

  post(String url, Map<String, dynamic> params, {Function? success}) {
    _doRequest(url, params, Method.post, success);
  }

  getBody(String url, Map<String, dynamic> params, {Function? success}) {
    _doRequestBody(url, params, success);
  }

  void _doRequest(String url, Map<String, dynamic> params, Method method,
      Function? successCallBack) async {
    //

    try {
      /// 添加header
      dio.options.headers.addAll({
         'Token': "ACCTOKEN"
      });
      Response response;
      switch (method) {
        case Method.get:
          if (params.isNotEmpty) {
            response = await dio.get(url, queryParameters: params);
          } else {
            response = await dio.get(url);
          }
          break;
        case Method.post:
          if (params.isNotEmpty) {
            response =
                await dio.post(url, data: params, queryParameters: params);
          } else {
            response = await dio.post(url);
          }
          break;
      }
      var result = json.decode(response.toString());
      if (successCallBack != null) {
        //返回请求数据
        successCallBack(result);
      }
    } catch (exception) {
      showShortToast("网络超时，请检查网络"+exception.toString());
      if (successCallBack != null) {
        //返回请求数据
        successCallBack("");
      }
    }
  }

  void _doRequestBody(String url, Map<String, dynamic> params,
      Function? successCallBack) async {
    try {
      /// 可以添加header
      dio.options.headers.addAll({
        'Token': "ACCTOKEN"
      });
      Response response;
      response = await dio.request(url,
          data: params,
          options: Options(method: "GET", contentType: "application/json"));
      var result = json.decode(response.toString());
      if (successCallBack != null) {
        //返回请求数据
        successCallBack(result);
      }
    } catch (exception) {
      showShortToast("网络超时，请检查网络" + exception.toString());
      if (successCallBack != null) {
        //返回请求数据
        successCallBack("");
      }
    }
  }
}

五、发送GET和POST请求

void fetchData() {
  Net net = Net.instance!;
  var params = {
      'param1': value1,
    };
  // 发送GET请求
  net.get("https://api.example.com/data", params, success: (result) {
    print("GET请求成功：$result");
  });
  // 发送POST请求
  net.post("https://api.example.com/data", params, success: (result) {
    print("POST请求成功：$result");
  });
}

六、添加Header和处理响应

void fetchData() {
  Net net = Net.instance!;
   // 添加Header
  net.dio.options.headers.addAll({
    'X-Auth-Token': 'your_auth_token',
  });
  
  var params = {
      'param1': value1,
    };
  // 发送GET请求
  net.get("https://api.example.com/data", params, success: (result) {
    print("GET请求成功：$result");
  });
  // 发送POST请求
  net.post("https://api.example.com/data", params, success: (result) {
    print("POST请求成功：$result");
  });
}

总结
通过使用Dio库，我们创建了一个高效的网络请求工具类。工厂模式和单例模式的结合使得我们可以方便地进行初始化，并确保应用中只有一个网络请求实例。这种设计使得网络请求变得简单、可维护，提高了代码的可读性和可维护性。