基于AFNetworking的网络请求管理-YRequestManager

移步Github:YRequestManager

Logo


YRequestManager

Base AFNetworking Core Network Request Framework

Description


简介

基于AFNetworking作为网络请求核心,封装的网络请求管理工具。通过Api类作为请求配置描述,Manager做为管理发送方来发出请求;默认提供了三个拦截器:NetworkProtocalInterceptor(错误后处理状态码,网络层),ReqLogInterceptor(发起请求前打印日志),RespSucInterceptor(响应成功后做数据转实体,可用第三方转换工具);RequestManager提供了默认实例化方法:defaultMamanger,会把默认的三个拦截器加入进来,如果项目中不想用这三个拦截器,或不满足需求,可继承他们的父类自己重写,当然,RequestManager的实例化方法也要改为:initManagerWithYDelegate。

pod 使用

pod search YRequestManager
pod 'YRequestManager'

结构概览

1.ApiDelegate
2.AbsApi
3.BaseApi
4.BaseServiceManager
5.RequestManager

详解

1.ApiDelegate Protocal协议

该协议规范了凡遵守该协议的Api对象都拥有getReqUrl,getReqHeader,getReqBody,getRequestMethod,getTimeOut方法。这种设计方式借鉴了Java,C#语法的Interface接口的设计思想。

  • getReqUrl 用来配置请求地址Url,遵守者实现该方法需返回一个NSString对象。
  • getReqHeader 用来配置请求Header,遵守者实现该方法需返回一个NSDictionary对象。
  • getReqBody 用来配置请求Body,遵守者实现该方法需返回一个NSDictionary对象。
  • getRequestMethod用来配置该请求方式,用enum枚举RequestMethod来区分,可返回RequestMethodPOST(Post请求)、RequestMethodGET(Get请求)RequestMethodPUT(Put请求)、RequestMethodDELETE(Delete请求)。
  • getTimeOut 用来配置请求超时时间。


2.AbsApi abstract抽象类

请求抽象类,规范了继承自AbsApi需要实现的方法。这种设计方式借鉴了Java,C#语法的abstract抽象类的设计思想。

  • getRootUrl 请求域名url。默认为nil,遵守实现者必须实现。
  • getPath 请求url后半部分。默认为nil,遵守实现者必须实现。
  • getBaseHeader 基本header。默认为nil,若有每个请求必填的header字段,请实现此方法。
  • getHeader 基本header以外的请求header。默认为nil,遵守实现者必须实现。
  • getBaseBody 基本body。默认为nil,若有每个请求必填的body字段,请实现此方法。
  • getBody 基本body以外的请求body。默认为nil,遵守实现者必须实现
  • getRespClass 用来指定该请求返回的数据实体Class,遵守者重写该方法需返回一个Class类型[Entity class],将返回的数据转换成指定数据实体对象。同时在同一页面中发起n个不同api请求后,返回的数据,我们可以通过class来区别。


3.BaseApi 请求Api基类

请求基类,继承自AbsApi,且遵守了ApiDelegate协议。
内部实现了ApiDelegate协议的方法,大家使用时直接继承BaseApi。而如果BaseApi如果不符合你的口味,你可以来自定义一个继承AbsApi又遵守BaseApiDelegate协议的对象


4.BaseServiceManager

用来使用AFNetWorking发送请求,只是个管理者,本身并不具备发送请求能力;目前依赖于AFNetWorking来发送网络请求;在内部封装了一些默认创建AFHTTPSessionManager的方法。

/// 使用block方式发送数据请求;api:发送参数,sucBlock:成功回调,failBlock:失败回调
- (void)request:(AbsApi<ApiDelegate>*)api
       sucBlock:(RespSucBlock)sucBlock
      failBlock:(RespFailBlock)failBlock;

该方法使用Block回调来发送请求,api参数为继承AbsApi抽象类,且遵守ApiDelegate协议的对象,(PS:BaseApi就符合该约束,凡继承BaseApi的对象都符合该参数约束) BaseServiceManager内部通过api对象配置来发送请求。sucBlockfailBlock为请求成功/失败回调。


5.RequestManager

继承自BaseServiceManager;设计此Manager主要目的是,后期不采用AFNetWorking时,可在本类的发送方法sendRequest...中切换其他第三方请求框架即可,而不需要项目中到处修改AFNetWorking请求为其他方式请求,同时担任着控制第三方请求的角色;因此,即使看不惯本类,也不要修改;另外,本类增加了Protocal回调数据方式请求。

/// ResponseDelegate 数据响应回调协议
@property (nonatomic,assign) id<YResponseDelegate> ydelegate;

+ (id)initManagerWithDelegate:(id<ResponseDelegate>)delegate;
/// 发送数据请求,参数为继承AbsApi抽象类,且遵守BaseApiDelegate协议 的对象
- (void)sendRequest:(AbsApi<ApiDelegate>*)api;

我们可以直接使用initManagerWithYDelegate:或者defaultManager方法来初始化RequestManager对象,将数据回调协议delegate传入。

使用request:方法来发送请求,同父类一致,api参数为继承AbsApi抽象类,且遵守BaseApiDelegate协议的对象。而上述BaseApi就符合这一点,而BaseApi如果不符合你的口味,你可以来自定义一个继承AbsApi又遵守BaseApiDelegate协议的对象。









使用方式

1.Api配置类

  • Api配置类使用
// 导入
#import "BaseApi.h"

// PokemonBaseApi继承自BaseApi
@implementation PokemonBaseApi

- (NSString *)getRootUrl
{
    return @"https://pokevision.com/";
}

- (int)getTimeOut
{
    return 30;
}

- (int)getRequestMethod
{
    return RequestMethodGET;
}

- (NSString *)checkRespData:(id)data
{
    PokemonBaseDo *pokemon = data;
    NSString *status = pokemon.status;
    if(![status isEqualToString:@"success"]){
        return @"查询失败";
    }
    return nil;
}
@end
// PokemonPositionApi继承自PokemonBaseApi
@implementation PokemonPositionApi

- (NSString *)getPath
{
    return @"map/data/34.00/-118.5";
}

- (NSDictionary *)getBody
{
    return @{@"User":_user,@"Pwd":_pwd};
}

- (Class)getRespClass
{
    return [PkPositionDo class];
}

- (int)getRequestMethod
{
    return RequestMethodGET;
}

@end

  • Api配置类的实例化

// 初始化要请求的接口配置
PokemonPositionApi *api = [[PokemonPositionApi alloc]init];
// 设置配置:请求body参数
api.user = @"andy";
api.pwd = @"pwd";







2.RequestManager请求

  • RequestManager请求

#import "RequestManager.h"

// 初始化请求管理类
RequestManager *reqManager = [RequestManager defaultManager:self];
// 添加响应成功后,数据转换实体方式拦截器
[reqManager setInterceptorForSuc:[DataConvertInterceptor new]];
// 发送请求:Protocol方式接收数据
[reqManager request:api];

// 发送请求:Block方式接收数据
[reqManager request:api sucBlock:^(CentaResponse *result) {
        if(result.suc){
            PkPositionDo *position = result.data;
            NSString *status = position.status;
            NSLog(status);
        }else{
            NSLog(result.msg);
        }
    } failBlock:^(CentaResponse *error) {
        NSLog(error.msg);
    }];



  • DataConvertInterceptor (继承自InterceptorForRespSuc)

    DataConvertInterceptor并非框架自带,因为框架不应该绑架业务层使用什么做数据转换,
    因此,这个过程开放出来,自行决定。(示例代码中是使用yyModel转换)


@implementation DataConvertInterceptor

- (CentaResponse *)convertData:(id)task andRespData:(id)respData andApi:(AbsApi<ApiDelegate> *)api
{
    CentaResponse *resp =  [super convertData:task andRespData:respData andApi:api];
    NSDictionary *dic = resp.data;
    
    // 使用yymodel转换成目标实体
    Class cls = api.getRespClass;
    resp.data = [cls yy_modelWithDictionary:dic];
    
    return resp;
}
@end

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • *面试心声:其实这些题本人都没怎么背,但是在上海 两周半 面了大约10家 收到差不多3个offer,总结起来就是把...
    Dove_iOS阅读 27,107评论 29 470
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,802评论 6 13
  • 你是有名的实干家,朝五晚九,马不停蹄,无私奉献,呕心沥血,很用力很用力的仿佛要把一切的一切做到“完美”(这...
    舒骅阅读 142评论 0 0