Block类型变量 - 缓存Http请求与回调

原文出自:http://tutuge.me/2015/02/19/Block类型变量-缓存Http请求与回调/#more

Block类型变量-缓存Http请求与回调

##前言
Objective-C中的Blocks实在是太好用了，有了它，我们就可以将“代码块”封装起来，当成变量使用、传递，所以，在Objective-C中，iOS中，许多的回调是用Block来完成的。

##问题
我自己在之前的项目中，就遇到过一个问题。因为项目的需要，手机端所有的跟服务器的通信都需要“加密”，在经过一番调研后，我们使用的是类似OAuth机制（至于什么是OAuth，各位Google一下就明白了，大部分的公共API都用到了这种机制）。

###缓存Http请求后的回调代码块
既然是OAuth机制，就是说我们每次向服务器发起的请求，除了跟业务相关的参数，还需要带上AccessToken、UserToken这类的授权参数，而AccessToken在本次请求中是否会过期，在结果返回前是不知道的，所以，为了更好地用户体验，不至于让用户在某个时刻的操作，因为授权过期了而“没有响应”，我们的每次Http请求都必须缓存起来。

这里的缓存可不是单单指缓存请求的参数、URL，更重要的是缓存Http请求成功或者失败时的“回调代码块”。

##实现

###AFNetworking的Get方法
在iOS的项目中，AFNetworking应该算是使用的最多的网络库了，它的Get请求的方法接口如下：

- (AFHTTPRequestOperation *)GET:(NSString *)URLString
                     parameters:(id)parameters
                        success:(void (^)(AFHTTPRequestOperation *operation, id responseObject))success
                        failure:(void (^)(AFHTTPRequestOperation *operation, NSError *error))failure

只有四个参数，分别是Url、参数、成功的回调Block，失败的回调Block，看，这里，回调的代码块就被封装到了Block里面，并当成参数传入。

###再次封装
介于AFNetworking只提供了最基本的Get、Post、Put这些方法，所以，我们往往根据业务的接口做了封装，如先定义了请求的类型枚举：

//Http type, for execute
typedef NS_ENUM(NSUInteger, HTTP_REQUEST_TYPE) {
    ICG_GET = 0,
    ICG_POST
};

然后定义了统一的请求入口与回调参数Block：

//请求成功后的回调
typedef void (^http_success)(id result);
//请求失败后的回调
typedef void (^http_fail)();

//统一的请求入口
+ (void)executeWithType:(HTTP_REQUEST_TYPE)type api:(NSString *)api
            parameters:(NSDictionary *)parameters success:                (http_success)success fail:(http_fail)fail {    

    //为每个请求增加AccessToken、UserToken等公共参数
    //...

    //缓存Http请求
    //...

    //根据type区分具体是哪一种Http请求。
    switch (type) {
        case ICG_GET:
            [HttpUtil get:url parameters:paras success:success fail:fail];
            break;    
        case ICG_POST:
            [HttpUtil post:url parameters:paras success:success fail:fail];
            break;    
        default:
            break;
    }
}

###再次封装的好处
为什么要再次做封装，将基本的Http请求统一入口？道理很简单，就是为了能方便的对每次请求增加额外的处理，并且对上层调用透明。如:

• 统一为每个请求增加Log。
• 统一为每个请求增加如AccessToken这些额外的参数。
• 方便对Http请求做缓存！

###缓存Http请求的数据结构
既然我们已经有了统一的请求入口，为了缓存，所需要做的就是将能代表一次请求的所有参数缓存起来就行了，如URL、请求参数等，如下数据结构：

@interface RequestHolder : NSObject

//URL地址
@property(strong, nonatomic) NSString *url;
//请求参数
@property(strong, nonatomic) NSMutableDictionary *paras;
//请求类型，如Get、Post
@property(assign, nonatomic) HTTP_REQUEST_TYPE type;
//请求成功回调
@property(copy) http_success success;
//请求失败回调
@property(copy) http_fail fail;
@end

这几个参数，就可以完整的“代表、重现”一次具体的Http请求。

###如何缓存
只要App开启，Http请求就会不停地产生，会有源源不断的请求，难道我们把每次请求都缓存起来？

全部都缓存肯定是不行的，所以我们需要一个缓存策略。

一个App中，所有的Http请求的路径，也就是Url，不包括参数，应该是数量固定的，如“/user, /comment”，并且，一个请求往往对应的操作、功能也是唯一的，所以，完全可以以请求的Url为Key，以本次请求的“RequestHolder”为Value，用Objective-C中的NSDictionary来缓存Http请求。

所以，缓存请求的方法大致如下：

//缓存Http请求

- (void)cacheHttpRequest:(HTTP_REQUEST_TYPE)type url:(NSString *)url
                parameters:(NSMutableDictionary *)parameters success:(http_success)success fail:(http_fail)fail {

    //创建缓存数据结构，保存本次请求的参数、回调
    ICGRequestHolder *requestHolder = [ICGRequestHolder new];
    requestHolder.url = url;
    requestHolder.paras = parameters;
    requestHolder.success = [success copy];
    requestHolder.fail = [fail copy];
    requestHolder.type = type;

    //保存本次请求
    [_operationQueue addOperationWithBlock:^{
        _cachedRequests[url] = requestHolder;
    }];
}

这样，就能完整的缓存Http请求了。

###从缓存中恢复Http请求
恢复请求很简单，直接遍历所有缓存的请求，再次发起Http请求即可，就不再贴代码了。

###删除成功的Http请求
缓存的目的是在请求失败时，如AccessToken超时时，我们可以在重新获取AccessToken后重现上次失败的请求，所以，一旦请求成功时，我们还需要将成功的请求删除，当然，也是利用Url，如下：

- (void)removeRequestForKey:(NSString *)url {
    //放入队列执行
    [_operationQueue addOperationWithBlock:^{
        //删除Url对应的请求
        [_cachedRequests removeObjectForKey:url];
    }];
}

##总结
本文只是简单地利用Objective-C中的Block特性，实现了Http请求的缓存。目的不是介绍Block，是为了分享我自己在项目中运用Block的例子，如果读者有更好的方法，欢迎留言啊~~

##参考、推荐阅读

• Working with Blocks