Flutter網(wǎng)絡(luò)請(qǐng)求之基于dio的簡(jiǎn)單封裝

dio是一個(gè)強(qiáng)大的Dart Http請(qǐng)求庫(kù),支持Restful API涉波、FormData英上、攔截器、請(qǐng)求取消啤覆、Cookie管理苍日、文件上傳/下載、超時(shí)窗声、自定義適配器等相恃。本文是基于dio庫(kù)的簡(jiǎn)單二次封裝,以適應(yīng)我們平常開發(fā)中常用的get請(qǐng)求和post請(qǐng)求笨觅。

添加依賴

dependencies:
  dio: ^2.1.0

dio封裝

首先拦耐,對(duì)dio進(jìn)行初始化耕腾。這里使用工廠構(gòu)造函數(shù)創(chuàng)建DioUtil,在Dart中杀糯,當(dāng)實(shí)現(xiàn)一個(gè)使用 factory 關(guān)鍵詞修飾的構(gòu)造函數(shù)時(shí)扫俺,這個(gè)構(gòu)造函數(shù)不必創(chuàng)建類的新實(shí)例。

  static final DioUtil _instance = DioUtil._init();
  static Dio _dio;

  factory DioUtil() {
    return _instance;
  }

  DioUtil._init() {
    _dio = new Dio();
  }

設(shè)置BaseOptions參數(shù)固翰,可以設(shè)置網(wǎng)絡(luò)請(qǐng)求超時(shí)時(shí)間狼纬,設(shè)置baseUrl。dio默認(rèn)請(qǐng)求contentType為application/json骂际,如果需要設(shè)置為application/x-www-form-urlencoded疗琉,需在BaseOptions中單獨(dú)設(shè)置。在BaseOptions.hearders中可以添加自定義的網(wǎng)絡(luò)請(qǐng)求頭信息歉铝。

  static BaseOptions getDefOptions() {
    BaseOptions options = BaseOptions();
    options.connectTimeout = 10 * 1000;
    options.receiveTimeout = 20 * 1000;
    options.baseUrl = ‘ http://www.mocky.io/)’
    options.contentType = ContentType.parse('application/x-www-form-urlencoded');

    Map<String, dynamic> headers = Map<String, dynamic>();
    headers['Accept'] = 'application/json';

    String platform;
    if(Platform.isAndroid) {
      platform = "Android";
    } else if(Platform.isIOS) {
      platform = "IOS";
    }
    headers['OS'] = platform;
    options.headers = headers;

    return options;
  }

  setOptions(BaseOptions options) {
    _options = options;
    _dio.options = _options;
  }

網(wǎng)絡(luò)請(qǐng)求過(guò)程

  • path 請(qǐng)求path路徑盈简,這里我們進(jìn)行了restful請(qǐng)求處理,path路徑參數(shù)放在pathParams中犯戏。
  • method 請(qǐng)求方式送火,可以為GET、POST先匪、PUT种吸、HEAD、DELETE呀非、PATCH等坚俗,這字我們僅展示GET請(qǐng)求和POST請(qǐng)求。
  • pathParams path路徑參數(shù)岸裙,Map數(shù)據(jù)結(jié)構(gòu)
  • errorCallback 自定義錯(cuò)誤處理猖败,代碼中_handleHttpError()方法進(jìn)行統(tǒng)一的http錯(cuò)誤碼處理,如接口需單獨(dú)處理某種錯(cuò)誤碼降允,可添加此回調(diào)方法恩闻。

返回?cái)?shù)據(jù)如果為Map數(shù)據(jù)直接返回,如果為Json數(shù)據(jù)需通過(guò)json.decode解析之后再返回剧董。

  Future<Map<String, dynamic>> request(String path,{String method, Map pathParams, data, Function errorCallback}) async {
    ///restful請(qǐng)求處理
    if(pathParams != null) {
      pathParams.forEach((key, value) {
        if(path.indexOf(key) != -1) {
          path = path.replaceAll(":$key", value.toString());
        }
      });
    }

    Response response = await _dio.request(path, data: data, options: Options(method: method));

    if(response.statusCode == HttpStatus.ok || response.statusCode == HttpStatus.created) {
      try {
        if(response.data is Map) {
          return response.data;
        } else {
          return json.decode(response.data.toString());
        }
      } catch(e) {

        return null;
      }
    } else {
      _handleHttpError(response.statusCode);
      if(errorCallback != null) {
        errorCallback(response.statusCode);
      }
      return null;
    }
  }

GET請(qǐng)求

  Future<Map<String, dynamic>> get(String path, {pathParams, data, Function errorCallback}) {
    return request(path, method: Method.get, pathParams: pathParams, data: data, errorCallback: errorCallback);
  }

POST請(qǐng)求

  Future<Map<String, dynamic>> post(String path, {pathParams, data, Function errorCallback}) {
    return request(path, method: Method.post, pathParams: pathParams, data: data, errorCallback: errorCallback);
  }

完整代碼

import 'dart:convert';
import 'dart:io';

import 'package:dio/dio.dart';

class Method {
  static final String get = "GET";
  static final String post = "POST";
  static final String put = "PUT";
  static final String head = "HEAD";
  static final String delete = "DELETE";
  static final String patch = "PATCH";
}

class DioUtil {
  static final DioUtil _instance = DioUtil._init();
  static Dio _dio;
  static BaseOptions _options = getDefOptions();

  factory DioUtil() {
    return _instance;
  }

  DioUtil._init() {
    _dio = new Dio();
  }

  static BaseOptions getDefOptions() {
    BaseOptions options = BaseOptions();
    options.connectTimeout = 10 * 1000;
    options.receiveTimeout = 20 * 1000;
    options.contentType = ContentType.parse('application/x-www-form-urlencoded');

    Map<String, dynamic> headers = Map<String, dynamic>();
    headers['Accept'] = 'application/json';

    String platform;
    if(Platform.isAndroid) {
      platform = "Android";
    } else if(Platform.isIOS) {
      platform = "IOS";
    }
    headers['OS'] = platform;
    options.headers = headers;

    return options;
  }

  setOptions(BaseOptions options) {
    _options = options;
    _dio.options = _options;
  }

  Future<Map<String, dynamic>> get(String path, {pathParams, data, Function errorCallback}) {
    return request(path, method: Method.get, pathParams: pathParams, data: data, errorCallback: errorCallback);
  }

  Future<Map<String, dynamic>> post(String path, {pathParams, data, Function errorCallback}) {
    return request(path, method: Method.post, pathParams: pathParams, data: data, errorCallback: errorCallback);
  }

  Future<Map<String, dynamic>> request(String path,{String method, Map pathParams, data, Function errorCallback}) async {
    ///restful請(qǐng)求處理
    if(pathParams != null) {
      pathParams.forEach((key, value) {
        if(path.indexOf(key) != -1) {
          path = path.replaceAll(":$key", value.toString());
        }
      });
    }

    Response response = await _dio.request(path, data: data, options: Options(method: method));

    if(response.statusCode == HttpStatus.ok || response.statusCode == HttpStatus.created) {
      try {
        if(response.data is Map) {
          return response.data;
        } else {
          return json.decode(response.data.toString());
        }
      } catch(e) {

        return null;
      }
    } else {
      _handleHttpError(response.statusCode);
      if(errorCallback != null) {
        errorCallback(response.statusCode);
      }
      return null;
    }
  }

  ///處理Http錯(cuò)誤碼
  void _handleHttpError(int errorCode) {

  }

}

示例

  DioUtil().get('v2/5ca06a7d3300007200a87e01/:id', 
    pathParams: {
      ':id': 12
    },
    data: {
      'name':'tony',
      'age': 23
    },
    errorCallback: (statusCode) {
      print('Http error code : $statusCode');
    }
  ).then((data) {
    print('Http response: $data');
  });
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末幢尚,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子翅楼,更是在濱河造成了極大的恐慌尉剩,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,042評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件毅臊,死亡現(xiàn)場(chǎng)離奇詭異理茎,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評(píng)論 2 384
  • 文/潘曉璐 我一進(jìn)店門皂林,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)朗鸠,“玉大人,你說(shuō)我怎么就攤上這事式撼⊥纾” “怎么了?”我有些...
    開封第一講書人閱讀 156,674評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵著隆,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我呀癣,道長(zhǎng)美浦,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,340評(píng)論 1 283
  • 正文 為了忘掉前任项栏,我火速辦了婚禮浦辨,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘沼沈。我一直安慰自己流酬,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,404評(píng)論 5 384
  • 文/花漫 我一把揭開白布列另。 她就那樣靜靜地躺著芽腾,像睡著了一般。 火紅的嫁衣襯著肌膚如雪页衙。 梳的紋絲不亂的頭發(fā)上摊滔,一...
    開封第一講書人閱讀 49,749評(píng)論 1 289
  • 那天,我揣著相機(jī)與錄音店乐,去河邊找鬼艰躺。 笑死,一個(gè)胖子當(dāng)著我的面吹牛眨八,可吹牛的內(nèi)容都是我干的腺兴。 我是一名探鬼主播,決...
    沈念sama閱讀 38,902評(píng)論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼廉侧,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼页响!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起伏穆,我...
    開封第一講書人閱讀 37,662評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤拘泞,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后枕扫,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體陪腌,經(jīng)...
    沈念sama閱讀 44,110評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了诗鸭。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片染簇。...
    茶點(diǎn)故事閱讀 38,577評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖强岸,靈堂內(nèi)的尸體忽然破棺而出锻弓,到底是詐尸還是另有隱情,我是刑警寧澤蝌箍,帶...
    沈念sama閱讀 34,258評(píng)論 4 328
  • 正文 年R本政府宣布青灼,位于F島的核電站,受9級(jí)特大地震影響妓盲,放射性物質(zhì)發(fā)生泄漏杂拨。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,848評(píng)論 3 312
  • 文/蒙蒙 一悯衬、第九天 我趴在偏房一處隱蔽的房頂上張望弹沽。 院中可真熱鬧,春花似錦筋粗、人聲如沸策橘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)丽已。三九已至,卻和暖如春暇唾,著一層夾襖步出監(jiān)牢的瞬間促脉,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評(píng)論 1 264
  • 我被黑心中介騙來(lái)泰國(guó)打工策州, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留瘸味,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,271評(píng)論 2 360
  • 正文 我出身青樓够挂,卻偏偏與公主長(zhǎng)得像旁仿,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子孽糖,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,452評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容