封装第三方库的必要性

作者: 番茄冰 | 来源:发表于2016-06-28 15:42 被阅读1337次

我最近在做一个表情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版本,又改了一大堆的接口调用方式呢?所以能封装起来,尽量还是封装起来比较好。

相关文章

  • iOS网络库-JJNetwork

    JNetwork 封装网络通信的必要性,对于一般应用封装下第三方的网络库,提供常用的POST和GET方法,然后Ca...

  • iOS网络库-JJNetwork

    JJNetwork 封装网络通信的必要性,对于一般应用封装下第三方的网络库,提供常用的POST和GET方法,然后C...

  • 封装第三方库的必要性

    我最近在做一个表情SDK的项目,SDK本身已经打包完成了,但是在与第三方开发者对接的时候,遇到了一些问题。我之前没...

  • swift 网络工具类的分装 【转载XMG】

    网络常用第三方库:AFNetworking项目中一般不直接使用第三方库,需要自己进行封装,封装步骤如下 新建一个类...

  • iOS开发常用第三方库

    第三方库 ?AFNetworking 网络操作封装ASIHttpRequestMKNetworkKit?S...

  • 框架的封装

    对于第三方库的封装 MJExtension AFNetworking 使用Category进行封装 唯一要注意的地...

  • 【转】把第三方.a或.framework添加到自己的静态库中

    iOS静态库SDK制作(包含第三方静态库) iOS Xcode9 封装生成.framework

  • iOS-数据库-FMDB

    ios数据库:CoreData : 自带的框架SQLite :FMDB :第三方类库,封装SQLite的框架 F...

  • 【iOS】加载SVG图片

    一、导入 SVGKit 第三方库 二、使用 SVGKit 库 新建 UIImage+SVG 分类,二次封装SVGK...

  • iOS 制作静态库.a

    一、简介: 关于库的基本介绍:库,是实现相关功能的代码文件集合,是对某项功能的封装.库分为系统库和第三方库. 开源...

网友评论

    本文标题:封装第三方库的必要性

    本文链接:https://www.haomeiwen.com/subject/pvxpdttx.html