Flutter Http请求库 dio 代码封装

原创已于 2023-05-05 15:27:26 修改 · 784 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#flutter

于 2020-01-16 15:07:48 首次发布

Flutter 专栏收录该内容

7 篇文章

订阅专栏

本文介绍了一个基于Flutter的Http请求库dio的封装实现——HttpUtils.dart。该库提供了RESTful请求的GET、POST、DELETE、PATCH等方法的封装，统一处理了请求前缀、请求信息、响应信息及错误信息，适用于跨平台应用开发。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

源代码地址https://github.com/junkai-li/NetCoreKevin
基于NET6搭建跨平台WebApi架构支持单点登录、多缓存、自动任务、分布式、多租户、日志、授权和鉴权、网关注册与发现、CAP集成事件、领域事件、 docker部署

Flutter Http请求库 dio 代码封装

新增HttpUtils.dart

import 'package:dio/dio.dart';
import 'dart:async';

//**********************************************************************************
//
// 文件名称：HttpUtils.dart
//
/ 
//
// 创建日期：2020-01-07
//
// 文件描述：Dio 封装 restful 请求 GET、POST、DELETE、PATCH
// * 主要作用为统一处理相关事务：
//*  - 统一处理请求前缀；
//*  - 统一打印请求信息；
//*  - 统一打印响应信息；
//*  - 统一打印报错信息；
// 修改履历：
// ---------------------------------------------------------------------------------
// 修改日期     修改者  修改标识   修改描述 (首行为示例)
// 2020/1/7    李军凯             链接Api验证登陆账号密码
//
//**********************************************************************************
class HttpUtils {
  /// global dio object
  static Dio dio;

  /// default options
  static const String API_PREFIX = 'http://10.0.2.2/api';//10.0.2.2//127.0.0.1
  //请求时间
  static const int CONNECT_TIMEOUT = 10000;
  //响应时间
  static const int RECEIVE_TIMEOUT = 10000;

  /// http request methods
  static const String GET = 'get';
  static const String POST = 'post';
  static const String PUT = 'put';
  static const String PATCH = 'patch';
  static const String DELETE = 'delete';

  /// request method
  static Future<Map> request(String url,
      {data, method, contentTypeString}) async {
    data = data ?? {};
    method = method ?? 'GET';
    contentTypeString = contentTypeString ?? 'application/json;charset=UTF-8';

    /// 打印请求相关信息：请求地址、请求方式、请求参数
    print('请求地址：【' + method + '  ' + url + '】');
    print('请求参数：' + data.toString());
    
    clear();
    Dio dio = createInstance();

    var result; 

    try {

      Response response = await dio.request(url,
          data: data,
          options: new Options(method: method, contentType: contentTypeString));

      result = response.data;

      /// 打印响应相关信息
      print('响应数据：' + response.toString());
    } on DioError catch (e) {

      ErrorEntity en = new ErrorEntity().createErrorEntity(e); 
      /// 打印请求失败相关信息
      print('请求出错：' + en.message);

    }

    return result;
  }

  /// 创建 dio 实例对象
  static Dio createInstance() {
    if (dio == null) {
      /// 全局属性：请求前缀、连接超时时间、响应超时时间
      BaseOptions options = new BaseOptions(
        baseUrl: API_PREFIX,
        connectTimeout: CONNECT_TIMEOUT,
        receiveTimeout: RECEIVE_TIMEOUT, 
      );

      dio = new Dio(options);
    }

    return dio;
  }

  /// 清空 dio 对象
  static clear() {
    dio = null;
  }
}

//请求错误类
class ErrorEntity {
  int code;
  String message;

  ErrorEntity({this.code, this.message});

  // 错误信息
  ErrorEntity createErrorEntity(DioError error) {
    switch (error.type) {
      case DioErrorType.CANCEL:
        {
          return ErrorEntity(code: -1, message: "请求取消");
        }
        break;
      case DioErrorType.CONNECT_TIMEOUT:
        {
          return ErrorEntity(code: -1, message: "连接超时");
        }
        break;
      case DioErrorType.SEND_TIMEOUT:
        {
          return ErrorEntity(code: -1, message: "请求超时");
        }
        break;
      case DioErrorType.RECEIVE_TIMEOUT:
        {
          return ErrorEntity(code: -1, message: "响应超时");
        }
        break;
      case DioErrorType.RESPONSE:
        {
          try {
            int errCode = error.response.statusCode;
            String errMsg = error.response.statusMessage;
            // return ErrorEntity(code: errCode, message: errMsg);
            switch (errCode) {
              case 400:
                {
                  return ErrorEntity(code: errCode, message: "请求语法错误");
                }
                break;
              case 403:
                {
                  return ErrorEntity(code: errCode, message: "服务器拒绝执行");
                }
                break;
              case 404:
                {
                  return ErrorEntity(code: errCode, message: "无法连接服务器");
                }
                break;
              case 405:
                {
                  return ErrorEntity(code: errCode, message: "请求方法被禁止");
                }
                break;
              case 500:
                {
                  return ErrorEntity(code: errCode, message: "服务器内部错误");
                }
                break;
              case 502:
                {
                  return ErrorEntity(code: errCode, message: "无效的请求");
                }
                break;
              case 503:
                {
                  return ErrorEntity(code: errCode, message: "服务器挂了");
                }
                break;
              case 505:
                {
                  return ErrorEntity(code: errCode, message: "不支持HTTP协议请求");
                }
                break;
              default:
                {
                  return ErrorEntity(code: errCode, message: "未知错误");
                }
            }
          } on Exception catch (_) {
            return ErrorEntity(code: -1, message: "未知错误");
          }
        }
        break;
      default:
        {
          return ErrorEntity(code: -1, message: error.message);
        }
    }
  }
}

如何使用？

 var result = await HttpUtils.request(
                                '/MoveApp/AppLogin',
                                method: HttpUtils.POST,
                                data: {'name': _name, 'password': _pwd});