Flutter网络封装(一)

引言

flutter网络请求我们使用dio库来实现:

dependencies:
  flutter:
    sdk: flutter
  dio: ^3.0.10

一个基础网络库,通常我们将其分成两个部分:

  1. 基础网络层
  2. 数据模型转换层

那今天,我们先来实现基础网络层的功能封装

新建 base_request.dart 文件,封装requestOptions,并对外提供内容注入能力(子类重写):
typedef ProgressCallback = void Function(int count, int total);

abstract class BaseRequest {
  String get path;
  String get method => 'POST';
  int get connectTimeout => 5000;
  int get receiveTimeout => 5000;
  int get sendTimeout => 5000;
  Map<String, dynamic> get headers => null;
  ProgressCallback get onReceiveProgress => null;
  bool get showErrorToast => true;

  RequestOptions requestOptions() {
    return RequestOptions(
      path: path,
      method: method,
      connectTimeout: connectTimeout,
      receiveTimeout: receiveTimeout,
      sendTimeout: sendTimeout,
      cancelToken: cancelToken,
      headers: headers,
      onReceiveProgress: onReceiveProgress,
      responseType: ResponseType.json,
      extra: {
        'showErrorToast': showErrorToast,
      },
    );
  }
}

在基类上面再封装一层,用于抽象具体的请求方法:

abstract class BaseJsonRequest<T> with BaseRequest {
  //dio 需要调用者注入进来
  Dio get dio;
  Set<int> get successCodes => {0};

  Future<ResponsBaseModel> request() async {
    try {
      final response = await dio.request<Map<String, dynamic>>(
        path,
        data: data,
        options: requestOptions(),
      );
      _ResponsBaseModel baseModel = _ResponsBaseModel.fromMap(
        response.data,
        successCodes,
      );
      //添加业务数据结构判断
      if (baseModel.success) {
        return baseModel;
      } else {
        if (showErrorToast) {
          Toast.show(baseModel.message)
        }
        throw error;
      }
    } catch (e) {
      if (showErrorToast) {
        //添加处理暴露异常
      }
      rethrow;
    }
  }

  Future<T> execute() async {
    return null;
  }
}
该工具类不能直接使用,需要被具体业务方继承使用,path不能为空

业务数据结构模型,统一接口返回的数据结构

 class _ResponsBaseModel {
  int code;
  String message;
  dynamic data;
  Set<int> successCodes;
  PDResponsBaseModel({
    this.code,
    this.data,
    this.message,
    this.successCodes,
  });
  bool get success => successCodes != null && successCodes.contains(code);
  factory _PDResponsBaseModel.fromMap(
    Map<String, dynamic> map,
    Set<int> successCodes,
  ) {
    return _PDResponsBaseModel(
      code: (map['code'] as int) ?? -1,
      message: (map['message'] as String) ?? '',
      data: map['data'],
      successCodes: successCodes,
    );
  }
}

具体使用时这么用:
新建一个类用于继承BaseJsonRequest,业务方直接调用execute方法进行网络请求,返回结构为数据模型实例

class MemberInfoRequest extends BaseJsonRequest<MemberInfo> {
  final String identity;
  MemberInfoRequest(this.identity);
  @override
  String get path => '/getMemberInfo';
  @override
  Dio get dio => Dio(); //dio可自行封装成全局单例工具类,并在初始化时添加拦截器等
  @override
  get data => {'identity': identity, 'identityType': 3};

  @override
  Future<MemberInfo> execute() {
    return request().then((value) {
      return MemberInfo.fromJson(value.mapData);
    });
  }
}

拦截器怎么写?

class LoggingInterceptor extends Interceptor {
  LoggingInterceptor();
  @override
  Future onRequest(RequestOptions options) {
    //options.data 进行入参插入操作
    return Future.value(options);
  }
  @override
  Future onResponse(Response response) {
    return Future.value(response);
  }
  @override
  Future onError(DioError err) async {
    return err;
  }
}
//将拦截器设置给dio实例
dio.interceptors.addAll([LoggingInterceptor()]);
以上便是网络请求层的一个简单的封装。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容