App架构升级之网络层优化（一）

一、背景

目前，公司里的App基本上采用了MVVM+ReactiveCocoa的模式来开发。所依赖的网络层私有库是DDNetWork。其内部是通过工程里的DDNetWorkManager单例子来进行调用，并且4xx、5xx类的错误直接在网络库内部弹出提示，导致视图层对这部分的错误信息不可控。并且每次在ViewModel里涉及到网络请求的部分，都需要写如下的代码：

- (RACSignal *)signal_waitDoneOrders 
 {
        RACSignal *signal = [RACSignal createSignal:^RACDisposable *(id<RACSubscriber> subscriber) {
        dispatch_async(dispatch_get_global_queue(0, 0), ^{
            DDRequestInfo *request = [DDRequestInfo createDDStaffRequestTransporterWaitDoneOrderNum];
            dispatch_async(dispatch_get_main_queue(), ^{
                [[DDNetWorkManager defaultManger] sendGETRequest:request success:^(id response) {
                    dispatch_async(dispatch_get_global_queue(0, 0), ^{
                        if (response)
                        {
                            [subscriber sendNext:response];
                            [subscriber sendCompleted];
                        }
                        else
                        {
                            NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:errorCode userInfo:userInfo];
                            [subscriber sendError:error];
                        }
                    });
                } andFalilur:^(NSError *error, NSInteger errCode) {
                    [subscriber sendError:error];
                }];
            });
        });
        
        return [RACDisposable disposableWithBlock:^{
            // 需要cancel网络请求。
        }];
    }];
 
    return [[signal replayLazily] setNameWithFormat:@"-signalWaitDoneOrders:%@", @"red_point"];
}
  • 一是网络请求比较多的模块，就会造成重复代码的急剧增加。
  • 另外一个是每创建一个新的请求，工程师就要去写这么长的一段代码，心累。
  • 重新封装一个网络库，费时费力，也没有必要。

于是，决定在原来网络库的基础上，参照octokit.objc进行网络请求封装的优化，使其增加RAC的能力。

二、改造网络库

1、向外传递NSURLSessionDataTask。

这一步的目的是为了可以在发起网络请求的对象里面方便地取消请求。即将上面代码部分的：

return [RACDisposable disposableWithBlock:^{
            // 需要cancel网络请求。
}];

修改为：

return [RACDisposable disposableWithBlock:^{
    // 需要cancel网络请求。
    if (task.state != NSURLSessionTaskStateCompleted) {
        [task cancel];
    }
}];

这样，外部就可以通过这个RACDisposable对象来及时地取消对应的请求。
所以DDNetwork的每一个消息由返回void修改为返回NSURLSessionDataTask，如GET请求：

- (void)sendGETRequest:(DDRequestInfo *)request HTTPHeader:(NSDictionary *)headerDictionary success:(successHandler)success andFalilur:(failurHandler)failur;

修改为：

- (NSURLSessionDataTask *)sendGETRequest:(DDRequestInfo *)request HTTPHeader:(NSDictionary *)headerDictionary success:(successHandler)success andFalilur:(failurHandler)failur;

2、向外传递NSHTTPURLResponse

在请求结束、获取返回信息的时候。可通过NSHTTPURLResponse的statusCode来决定是否处理返回的数据。比如statusCode为304的时候，subscriber可以直接调用sendCompleted结束。
那么DDNetwork消息的success参数数据类型successHandler：

typedef void (^successHandler)(id responseObject);

修改为：

typedef void (^successHandler)(NSHTTPURLResponse *response, id responseObject);

则GET请求的返回：

NSURLSessionDataTask *task = [manager GET:url parameters:request.requestParameters progress:nil success:^(NSURLSessionDataTask *task, id responseObject) {
    if (success) {
        success(responseObject);
    }
}];

修改为：

NSURLSessionDataTask *task = [manager GET:url parameters:request.requestParameters progress:nil success:^(NSURLSessionDataTask *task, id responseObject) {
    if (success) {
        success((NSHTTPURLResponse *)task.response,responseObject);
    }
}];

3、向外传递 NSError

第一步、将错误分域。

因为API返回的错误code有可能也是4xx、5xx等，但是所表示的错误信息和服务器的4xx、5xx等是不一样的。为了区别对待。将所有API返回的错误划分为：DDAPIErrorDomain。其他情况产生的域保持不变。
DDNetWorkModel.h

extern NSString * const DDAPIErrorDomain;

DDNetWorkModel.m

NSString * const DDAPIErrorDomain = @"DDAPIErrorDomain";

然后在构造NSError的时候：

- (NSError *)errorFromServerResponse:(id)responseObject
{
    NSString *errMessage = stringFromObject(responseObject, @"errorMsg");
    NSInteger errorCode = [stringFromObject(responseObject, @"errorCode") integerValue];
    
    NSDictionary *userInfo = @{NSLocalizedFailureReasonErrorKey:errMessage};
    NSError *error = [NSError errorWithDomain:DDAPIErrorDomain code:errorCode userInfo:userInfo];
    return error;
}
第二步、改造网络请求的failure:^(NSURLSessionDataTask *task, NSError *error) {}
__weak typeof(self) wself = self;
    NSURLSessionDataTask *task = [manager POST:url parameters:request.requestParameters progress:nil success:^(NSURLSessionDataTask *task, id responseObject) {
        // 处理请求成功。
    } failure:^(NSURLSessionDataTask *task, NSError *error) {
        __strong typeof(wself) sself = wself;
        [sself changeTerminateRequestModelWhenErrorWihtAddress:request.actionAddress andError:error];
        if ([sself isShowErrorProcessInfoWithAddress:request.actionAddress] == YES)
        {
            NSString *errorMsg  = [sself cuteMessageWithErrorCode:[sself errorCodeWithError:error]];
            NSString *errMessage = errorMsg.length > 0 ? errorMsg : (error.localizedFailureReason.length > 0 ? error.localizedFailureReason:@"");
            // 直接toas展示errMessage
        }
        else
        {
            if (failur) {
                failur(nil, error.code);
            }
        }
    }];

修改为：

__weak typeof(self) wself = self;
    NSURLSessionDataTask *task = [manager POST:url parameters:request.requestParameters progress:nil success:^(NSURLSessionDataTask *task, id responseObject) {
        // 处理请求成功。
    } failure:^(NSURLSessionDataTask *task, NSError *error) {
        __strong typeof(wself) sself = wself;
        [sself changeTerminateRequestModelWhenErrorWihtAddress:request.actionAddress andError:error];
        if ([sself isShowErrorProcessInfoWithAddress:request.actionAddress] == YES)
        {
            NSString *errorMsg  = [sself cuteMessageWithErrorCode:[sself errorCodeWithError:error]];
            NSString *errMessage = errorMsg.length > 0 ? errorMsg : (error.localizedFailureReason.length > 0 ? error.localizedFailureReason:@"");
            // 向外传递到外部视图展示。
            NSError *tError = [NSError errorWithDomain:error.domain code:error.code userInfo:@{NSLocalizedFailureReasonErrorKey:errMessage}];
            if (failur) {
                failur(tError, tError.code);
            }
        }
        else
        {
            if (failur) {
                failur(nil, error.code);
            }
        }
    }];
第三步、网络不可达，及时返回

如果网络本身不可达。那么需要在请求发出去之前就返回错误，通知上层发生网络连接错误。
首先、在DDNetWorkModel初始化的时候，开启网络状态的嗅探。

- (instancetype)init
{
    if (self = [super init])
    {        
        NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
        self.httpSessionManager = [[AFHTTPSessionManager alloc] initWithSessionConfiguration:configuration];
        // 开始网络状态嗅探
        [self.httpSessionManager.reachabilityManager startMonitoring];
        // 其他处理
    }
    return self;
}

其次、在每个网络请求的第一步，判断网络是否可达。

- (NSURLSessionDataTask *)sendGETRequest:(DDRequestInfo *)request
            HTTPHeader:(NSDictionary *)headerDictionary
               success:(successHandler)success
            andFalilur:(failurHandler)failur
{
    // 先判断网络是否ok。
    if (self.httpSessionManager.reachabilityManager.networkReachabilityStatus == AFNetworkReachabilityStatusNotReachable)
    {
        NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"无法连接到网络", @"")];
        //  构造连接失败的error。
        NSError *error = [self connectErrorWithFailureReason:failureReason];
        if (failur) {
            failur(error, error.code);
        }
        return nil;
    }
    // 创建 AFHTTPSessionManager 对象，以及发起 GET 请求。
    NSURLSessionDataTask *task = [manager GET:url parameters:request.requestParameters progress:nil success:^(NSURLSessionDataTask *task, id responseObject) {
        // xxxx
    }  failure:^(NSURLSessionDataTask *task, NSError *error) {
        // xxxx
    }];
    return task;
}

因为这一步是客户端主动判断网络是否可达。定义其错误域为：DDClientErrorDomain，错误码为：668。
DDNetWorkModel.h

extern NSString * const DDClientErrorDomain;

DDNetWorkModel.m

NSString * const DDClientErrorDomain = @"DDClientErrorDomain";

经过以上的修改，成功地将网络库里的NSURLSessionDataTask、NSHTTPURLResponse以及错误信息传递到了外部。并且网络库只提供网络请求相关的功能，不再提供错误信息的toast提示。

三、DDNetWorkManager增加RAC扩展

@interface DDNetWorkManger (RAC)

- (RACSignal *)enqueueRequest:(DDRequestInfo *)request method:(DDHTTPMethod)method resultClass:(Class)resultClass;

@end

这里只提供一个对外的接口。将请求加入队列中。
其中DDHTTPMethod目前支持三种请求类型：

typedef NS_ENUM(NSUInteger, DDHTTPMethod) {
    DDHTTPMethodGET,
    DDHTTPMethodPOST,
    DDHTTPMethodPUT
};

resultClass参数用来支持将返回的json数据直接转换为指定的数据模型（resultClass）。
目前，只提供基础的result数据模型DDAPIResult:

@interface DDAPIResult : DDObject

@property (nonatomic, copy) NSString *status;
// 请求结果
@property (nonatomic, copy) id content;
@property (nonatomic, copy) NSString *errorCode;
@property (nonatomic, copy) NSString *errorMsg;

// 用于检查JSON是否合法
- (id)jsonValidator;

@end

该接口的具体实现为：

- (RACSignal *)enqueueRequest:(DDRequestInfo *)request method:(DDHTTPMethod)method resultClass:(Class)resultClass
{
    @weakify(self);
    // 封装请求
    return [[[self enqueueRequest:request method:method] reduceEach:^id _Nullable(NSHTTPURLResponse *response, id responseObject){
        @strongify(self);
        // 解析请求结果
        return [[[self parsedResponseOfClass:resultClass fromJSON:responseObject] map:^id(id parsedResult) {
            // 将结果封装成DDResponse返回
            DDResponse *parsedResponse = [[DDResponse alloc] initWithHTTPURLResponse:response parsedResult:parsedResult];
            NSAssert(parsedResponse != nil, @"Could not create DDResponse with response %@ and parsedResult %@", response, parsedResult);
            return parsedResponse;
        }] doNext:^(DDResponse *parsedResponse) {
            DDLOG(@"%@ => %li ", response.URL, (long)response.statusCode,);
        }];
    }] concat];
}

其中DDResponse为：

@interface DDResponse : NSObject
@property (nonatomic, strong, readonly) id parsedResult;
@property (nonatomic, assign, readonly) NSInteger statusCode;
- (instancetype)initWithHTTPURLResponse:(NSHTTPURLResponse *)response parsedResult:(id)parsedResult;

@end

封装请求的实现如下：

- (RACSignal *)enqueueRequest:(DDRequestInfo *)request method:(DDHTTPMethod)method
{
    @weakify(self);
    RACSignal *signal = [RACSignal createSignal:^RACDisposable *(id<RACSubscriber> subscriber) {
        @strongify(self);
        NSURLSessionDataTask *task = nil;
        if (DDHTTPMethodGET == method)
        {
            task = [self sendGETRequest:request success:^(NSHTTPURLResponse *response, id responseObject) {
                if (response.statusCode == DDAPINotModifiedStatusCode)
                {
                    [subscriber sendCompleted];
                    return ;
                }
                [[RACSignal return:RACTuplePack(response, responseObject)] subscribe:subscriber];
            } andFalilur:^(NSError *error, NSInteger errCode) {
                // 将网络层的错误向外传递
                [subscriber sendError:error];
            }];
        }
        else if (DDHTTPMethodPOST == method)
        {
            task = [self sendPOSTRequest:request success:^(NSHTTPURLResponse *response, id responseObject) {
                if (response.statusCode == DDAPINotModifiedStatusCode)
                {
                    [subscriber sendCompleted];
                    return ;
                }
                
                RACSignal *nextPageSignal = [RACSignal empty];
                [[RACSignal return:RACTuplePack(response, responseObject)] subscribe:subscriber];
            } andFalilur:^(NSError *error, NSInteger errCode) {
                [subscriber sendError:error];
            }];
        }
        return [RACDisposable disposableWithBlock:^{
            // 需要cancel网络请求。
            if (task.state != NSURLSessionTaskStateCompleted) {
                [task cancel];
            }
        }];
    }];
    return [[signal replayLazily] setNameWithFormat:@"-enqueueRequest:%@", request];
}

这里，第一、实现了将网络层的错误向外传递到视图层。第二、实现了支持cancel网络请求的功能。

解析请求结果的实现：

- (RACSignal *)parsedResponseOfClass:(Class)resultClass fromJSON:(id)responseObject
{
    @weakify(self);
    return [RACSignal createSignal:^ id (id<RACSubscriber> subscriber) {
        @strongify(self);
        void (^parseJSONDictionary)(NSDictionary *) = ^(NSDictionary *JSONDictionary) {
            @strongify(self);
            if (resultClass == nil)
            {
                DDAPIResult *parsedObject = [[DDAPIResult class] mj_objectWithKeyValues:JSONDictionary];
                // 检查返回值的合法性
                BOOL success = [self checkResult:JSONDictionary response:parsedObject];
                if (success)
                {
                    NSAssert([parsedObject isKindOfClass:DDObject.class], @"Parsed model object is not an DDObject: %@", parsedObject);
                    // 检查API返回的错误信息
                    if (parsedObject.errorCode > 0 || ![parsedObject.status isEqualToString:DDAPIResultStatusOK])
                    {
                        [subscriber sendError:[self errorFromServerResponse:JSONDictionary]];
                        return;
                    }
                    [subscriber sendNext:JSONDictionary];
                }
                else
                {
                    NSString *failureReason = parsedObject.errorMsg.length > 0 ?parsedObject.errorMsg:[NSString stringWithFormat:NSLocalizedString(@"服务器返回的数据格式错误! (%@): %@", @""), [responseObject class], responseObject];
                    [subscriber sendError:[self errorWithParsingFailureReason:failureReason]];
                }
                return;
            }
            DDAPIResult *parsedObject = [resultClass mj_objectWithKeyValues:JSONDictionary];
            // 检查返回值的合法性
            BOOL success = [self checkResult:JSONDictionary response:parsedObject];
            if (success)
            {
                NSAssert([parsedObject isKindOfClass:DDObject.class], @"Parsed model object is not an DDObject: %@", parsedObject);
                // 检查API返回的错误信息
                if (parsedObject.errorCode > 0 || ![parsedObject.status isEqualToString:DDAPIResultStatusOK])
                {
                    [subscriber sendError:[self errorFromServerResponse:JSONDictionary]];
                    return;
                }
                [subscriber sendNext:parsedObject];
            }
            else
            {
                NSString *failureReason = parsedObject.errorMsg.length > 0 ?parsedObject.errorMsg:[NSString stringWithFormat:NSLocalizedString(@"服务器返回的数据格式错误! (%@): %@", @""), [responseObject class], responseObject];
                [subscriber sendError:[self errorWithParsingFailureReason:failureReason]];
                return;
            }
        };
        
        if ([responseObject isKindOfClass:NSArray.class])
        {
            for (NSDictionary *JSONDictionary in responseObject)
            {
                if (![JSONDictionary isKindOfClass:NSDictionary.class])
                {
                    NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Invalid JSON array element: %@", @""), JSONDictionary];
                    [subscriber sendError:[self errorWithParsingFailureReason:failureReason]];
                    return nil;
                }
                parseJSONDictionary(JSONDictionary);
            }
            [subscriber sendCompleted];
        }
        else if ([responseObject isKindOfClass:NSDictionary.class])
        {
            parseJSONDictionary(responseObject);
            [subscriber sendCompleted];
        }
        else if (responseObject == nil)
        {
            [subscriber sendNext:nil];
            [subscriber sendCompleted];
        }
        else
        {
            NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Response wasn't an array or dictionary (%@): %@", @""), [responseObject class], responseObject];
            [subscriber sendError:[self errorWithParsingFailureReason:failureReason]];
        }
        return nil;
    }];
}

其中，DDObject为DDAPIResult的父类。json自动转model需要作传入数据模型类型合法性检查。
以上、网络请求具备了RAC的能力。下一步就是在发起网络请求的ViewModel中订阅这些信号即可。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 159,569评论 4赞 363
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,499评论 1赞 294
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 109,271评论 0赞 244
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,087评论 0赞 209
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,474评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,670评论 1赞 222
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,911评论 2赞 313
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,636评论 0赞 202
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,397评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2赞 246
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1赞 261
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,418评论 2赞 254
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,074评论 3赞 237
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0赞 196
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2赞 276
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2赞 270

推荐阅读更多精彩内容

  • iOS网络编程--基础使用
    iOS中发送http请求的方案 苹果原生NSURLConnection 03年推出的古老技术NSURLSessio...
    搁浅的青蛙阅读 620评论 0赞 4
  • 网络
    13.服务器图片改了，url没有变，需求，服务器的图片变了，就从服务器加载图片，如果服务器的没变，就从本地加载 1...
    AlanGe阅读 1,088评论 0赞 1
  • HTTP协议
    HTTP概述 超文本传输协议(HTTP，HyperText Transfer Protocol) 是互联网上应用最...
    曹渊说创业阅读 3,790评论 2赞 61
  • iOS网络编程读书笔记
    iOS网络编程读书笔记 Facade Tester客户端门面模式的实例(被动版本化) 被动版本化，所以硬编码URL...
    melouverrr阅读 1,575评论 3赞 7
  • iOS开发--HTTP的网络请求状态代码详解
    网络请求是iOS项目的一个大部分,而且大部分的iOS的项目的网络请求是根据AFN进行的二次封装,我们查看返回的结果...
    FR_Zhang阅读 6,728评论 15赞 46