封装第三方库的必要性

我最近在做一个表情SDK的项目,SDK本身已经打包完成了,但是在与第三方开发者对接的时候,遇到了一些问题。我之前没有考虑到这样的问题,所以就写一篇文章记录一下。
  很多人开发的时候都会用到第三方库,尤其是像AFNetWorking这样的库。接入第三方库可以让我们不必重复造轮子,缩短开发周期。而且对于某些已经成熟的第三方库,想要造一个比它更好的轮子是需要下一番苦功夫的,对于初学者来说,没有那个精力,也没有那个能力去造这么庞大的一个轮子。
  我遇到的问题就是关于第三方库AFNetworking的,我在SDK里面的HTTP请求都是依靠AFNetworking实现的,而和我对接的第三方开发者也同样是调用了AFNetworking来实现HTTP请求,本来这并没有什么问题。但是,众所周知,去年AFNetworking发布了3.0版本。3.0版本是一次大升级,很多接口的调用都不一样了,内部实现原理也改变了很多。不巧的是,我用的是3.0的版本,而对方用的是2.0的版本。而且对方因为某些原因,暂时不能升级到3.0,要求我们提供一个降级的版本,这下可让我头大了。
  由于之前我没有对AFNetworking进行封装,代码里大量充斥着AFNetworking的函数,如果要降级,涉及到这些函数的地方我都得花精力去修改。并且,由于SDK未来还要和其他开发者对接,所以我必须要同时维护两份代码,来分别应对调用了3.0版本的开发者和2.0版本的开发者,这实在是太消耗时间精力了。
  此时此刻我才意识到封装第三方库是有多么的重要,如果我之前封装过AFNetworking的话,那我只需要将封装的那个类里的每个函数修改一下就足够了。
  因此,我创建了一个类,用来封装第三方库,就拿AFNetworking来举例好了。我将常用的HTTP请求函数封装了起来,如下所示。

+ (void)sendGetWithURL:(NSString *)url parameterDic:(NSDictionary *)parameterDic completionHandler:(send_request_completed_block)block;

+ (void)sendPostWithURL:(NSString *)url parameterDic:(NSDictionary *)parameterDic completionHandler:(send_request_completed_block)block;

+ (void)sendPutWithURL:(NSString *)url parameterDic:(NSDictionary *)parameterDic completionHandler:(send_request_completed_block)block;

+ (void)sendDeleteWithURL:(NSString *)url parameterDic:(NSDictionary *)parameterDic completionHandler:(send_request_completed_block)block;

回调定义如下所示,返回两个参数。一个是自定义的错误码,另一个则是解析好的JSON字典。

typedef void(^send_request_completed_block)(ECApiErrorCode errorCode,NSDictionary *resultDic);

这是Get请求封装的具体实现

+ (void)sendGetWithURL:(NSString *)url parameterDic:(NSDictionary *)parameterDic completionHandler:(send_request_completed_block)block {
    AFHTTPRequestOperationManager *manager = [self getOperationManager];
    [manager GET:url
      parameters:parameterDic
         success:^(AFHTTPRequestOperation *operation, id responseObject) {
             block(ECApiErrorCode_Success,responseObject);
         }
         failure:^(AFHTTPRequestOperation *operation, NSError *error) {
             ECApiErrorCode errorCode = [self errorCodeTransformFromHTTPCode:operation.response.statusCode];
             block(errorCode,nil);
         }];
//    AFHTTPSessionManager *manager = [self getSessionManager];
//    [manager GET:url
//      parameters:parameterDic
//        progress:nil
//         success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
//             if (IS_NOT_A_VALID_DIC(responseObject)) {
//                 block(ECApiErrorCode_ServerDataError,nil);
//             } else {
//                 block(ECApiErrorCode_Success,responseObject);
//             }
//         }
//         failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
//             NSHTTPURLResponse *response = (NSHTTPURLResponse *)task.response;
//             ECApiErrorCode errorCode = [self errorCodeTransformFromHTTPCode:response.statusCode];
//             block(errorCode,nil);
//         }];
}

我还定义了一个单例用来管理这些请求的基本设置,例如超时时间,解析方式等。

//static AFHTTPSessionManager * s_manager = nil;
static AFHTTPRequestOperationManager * s_manager = nil;

//+ (AFHTTPSessionManager *)getSessionManager {
//    static dispatch_once_t onceToken;
//    dispatch_once(&onceToken, ^{
//        s_manager = [AFHTTPSessionManager manager];
//        s_manager.responseSerializer = [AFJSONResponseSerializer serializer];
//        s_manager.requestSerializer = [AFJSONRequestSerializer serializer];
//        s_manager.requestSerializer.timeoutInterval = 10;
//    });
//    
//    return s_manager;
//}

+ (AFHTTPRequestOperationManager *)getOperationManager {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        s_manager = [AFHTTPRequestOperationManager manager];
        s_manager.responseSerializer = [AFJSONResponseSerializer serializer];
        s_manager.requestSerializer = [AFJSONRequestSerializer serializer];
        s_manager.requestSerializer.timeoutInterval = 10;
    });
    
    return s_manager;
}

这样就封装好了。在我贴出来的这几张图里,未注释的部分就是调用了AFNetworking2.0的做法,而注释的部分就是调用了3.0的做法。如果我想要切换版本,只需要修改一下注释的位置就可以了,十分方便。
  也许有人会问:“如果我开发的项目不需要与其他开发者对接,那还有必要这样封装吗?”。我的建议是,如果调用第三方库的地方很多的话,还是要封装起来比较好。我还是拿AFNetworking举例子吧。万一以后出了个4.0版本,又改了一大堆的接口调用方式呢?所以能封装起来,尽量还是封装起来比较好。

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

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,016评论 4 62
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,426评论 25 707
  • 身为九零后的我们,完全成为了腾讯的奴仆,从上初中开始,我被QQ包养,每天充斥着各种杀马特二次元,我乐在其中,只要小...
    阳台姑娘阅读 445评论 0 1
  • 第四话: 第二节:你仍是我的软肋,却不再是我的盔甲 赵宏博驾车一路直奔酒吧,他急需酒精麻醉自己,这道坎 这辈子过不...
    郭㿟告阅读 414评论 0 6