本文转自Shining IO的博客(微博)
Web开发中缓存是个很常见的东西,需要缓存无非是有这样一些目的:
* 支持应用的离线访问
* 减轻服务器的处理负担
* 弱网络下节省流量(中国特色)
iOS下对于缓存的支持有很多,比如Core Data,它可以很方便的建模和操作本地SQLite数据库, NSUserDefaults则可以用来缓存一些用户配置等等。本篇主要谈谈使用Etag标签来解决iOS下的URL缓存问题。
Etag
Etag全称是Entity Tag,一般用于标识URL对象是否发生了改变。 关于Etag详细说明参看Wikipedia Etag
使用Etag一般会出现如下的请求流程:
1. 客户端首次访问一个Rest API,后端返回一串JSON数据,并在请求头中添加一个Etag标签,这个标签对应的是一个用MD5或者SHA1等哈希算法 来生成的信息指纹。
2. 客户端保存这个Etag值,再次发起请求的时候,以If-None-Match作为Key添加到请求头中
3. 服务端校验请求头中的Etag数据,并跟当前将要输出数据的指纹做校验,如果一致,则表明没有更改,返回状态码为304,如果不一致, 则返回200,并将新的Etag同时返回,以便下次客户端请求时使用
简单画了下使用Etag的请求时序图:
etag
实现
服务端
服务端使用的是Tornado,原生支持Etag,而且默认处于开启状态,因此在应用层面基本不需要额外的代码处理。 对于一个Restful Webservice,按正常的方式输出JSON即可,其他的细节处理都交给Tornado来处理。
以下摘取的是Tornado中关于Etag的相关实现代码:
- web.py
- def finish(self, chunk=None):
- ···
- if not self._headers_written:
- if (self._status_code == 200 and
- self.request.method in ("GET", "HEAD") and
- "Etag" not in self._headers):
- self.set_etag_header()
- if self.check_etag_header():
- self._write_buffer = []
- self.set_status(304)
- if self._status_code == 304:
- assert not self._write_buffer, "Cannot send body with 304"
- self._clear_headers_for_304()
- elif "Content-Length" not in self._headers:
- content_length = sum(len(part) for part in self._write_buffer)
- self.set_header("Content-Length", content_length)
- ···
- def compute_etag(self):
- hasher = hashlib.sha1()
- for part in self._write_buffer:
- hasher.update(part)
- return '"%s"' % hasher.hexdigest()
- ···
- def check_etag_header(self):
- etag = self._headers.get("Etag")
- inm = utf8(self.request.headers.get("If-None-Match", ""))
- return bool(etag and inm and inm.find(etag) >= 0)
两个要点:
* 关于Etag值的计算,Tornado是使用SHA1算法。
* 仅处理Get和Head请求中的Etag,对于Post不做处理,猜测是由于Post属于非幂等方法,使用Etag的意义不大。
客户端
客户端使用NSURLCache配合AFNetworking进行网络请求。
关于NSURLCache,这个库的硬盘缓存机制是在iOS5之后引入的,之前仅支持内存缓存。 因此如果你的App需要兼容到iOS4,可以采用
SDURLCache这个第三方库。
NSURLCache有以下一些缓存策略值,在NSMutableURLRequest的cachePolicy可以进行设置。
注:虽然NSURLRequestCachePolicy定义的值有7个,但是其中两个是未实现的(Unimplemented),另外一个已废弃,因此实际可使用的仅有4个值
有关NSURLCache的进一步详细说明,可以参看 Mattt Thompson 的
这篇文章
客户端的实现有以下几个要点:
* 在请求回调的block中加入对Etag值进行固化操作,使用NSKeyedArchiver的形式保存到本地文件,以请求的url后缀作为key
* AFHTTPClient继承自AFHTTPRequestOperationManager,需要重写HTTPRequestOperationWithRequest方法, 根据网络情况设置合适的缓存策略,即在有网络时通过Etag检查缓存一致性,无网络时直接使用缓存
* 在AppDelegate中需要对NSURLCache进行初始化,固化后的缓存文件会放在(App Sandbox)/Library/Caches/(your bundle identifier)/NSURLCache中,以SQLite数据库文件的形式存放
* 在Etag检查一致的情况下,服务端会返回304,此时需要在FailBlock中调用cachedResponseObject方法,取出本地缓存数据
摘取关键代码如下:
- AFHTTPClient.m
- - (AFHTTPRequestOperation *)HTTPRequestOperationWithRequest:(NSURLRequest *)request
- success:(void (^)(AFHTTPRequestOperation *operation,id responseObject))success
- failure:(void (^)(AFHTTPRequestOperation *operation,NSError *error))failure{
- NSMutableURLRequest *modifiedRequest = request.mutableCopy;
- AFNetworkReachabilityManager *reachability = self.reachabilityManager;
- if (!reachability.isReachable){
- modifiedRequest.cachePolicy = NSURLRequestReturnCacheDataElseLoad;
- }else{
- modifiedRequest.cachePolicy = NSURLRequestReloadIgnoringCacheData;
- }
- NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
- if ([request.HTTPMethod isEqualToString:@"GET"]){
- NSString* filename= [[paths objectAtIndex:0] stringByAppendingPathComponent:[NSString stringWithFormat:@"%@",[request.URL suffix]]];
- NSString* etag = [NSKeyedUnarchiver unarchiveObjectWithFile:filename];
- if (etag != nil){
- NSMutableDictionary* mDict = [modifiedRequest.allHTTPHeaderFields mutableCopy];
- [mDict setObject:etag forKey:@"If-None-Match"];
- modifiedRequest.allHTTPHeaderFields = mDict;
- }
- }
- return [super HTTPRequestOperationWithRequest:modifiedRequest
- success:success
- failure:failure];
- }
- - (id)cachedResponseObject:(AFHTTPRequestOperation *)operation{
- NSCachedURLResponse* cachedResponse = [[NSURLCache sharedURLCache] cachedResponseForRequest:operation.request];
- AFHTTPResponseSerializer* serializer = [AFJSONResponseSerializer serializer];
- id responseObject = [serializer responseObjectForResponse:cachedResponse.response data:cachedResponse.data error:nil];
- return responseObject;
- }
- AppDelegate.m
- - (void)initCache {
- NSURLCache *cache = [[NSURLCache alloc] initWithMemoryCapacity:4 * 1024 * 1024
- diskCapacity:20 * 1024 * 1024
- diskPath:@"NSURLCache"];
- [NSURLCache setSharedURLCache:cache];
- }