iOS利用NSURLCache给接口最方便最简单的做上缓存

在最近的版本迭代中,自己做了一些接口拉取数据方面的优化,由于我们是以长篇内容为主体的app,对于长篇富文本文章,客户端这边并没有直接接入webview实现,而是通过接口拉取并解析文章主体的html代码,通过native的方法实现文章富文本,以后会写一些文章关于这方面的实现。由于文章发布完了之后,不会经常的改动,那么客户端要是每次去拉取文章的html代码然后解析,会浪费大量的网络资源,所以在这个版本里,我跟后端配合用etag来实现文章接口的缓存,由于网上讲这方面的文章不多,这篇文章就讲讲网络接口缓存的实现方法

实现思路

首先讲下实现的思路,很简单,接口在response的header里放入Etag字段,客户端抓取到Etag的值并存取到本地,然后存取接口内容到本地。之后客户端在call这个接口的时候,在request的header里放入If-None-Match,对应的值是之前存取的Etag的值,后端status code返回304告诉客户端接口内容没有改变,客户端使用该接口缓存在本地的内容

Etag

Etag是什么?Etag能告知客户端实体表示,它是一种可将资源以字符串形式做唯一性标识的方式。服务器会为每份资源分配对应的Etag值。另外,当资源更新时,Etag值也需要更新

NSURLCache

实现方法里,最烦的一件事就是怎么缓存接口内容,一种方法是自己写一套代码来实现缓存功能,SDWebImage就是这么实现缓存机制的,其实对于接口请求,iOS 系统已经帮你做好了缓存,而且非常完善简单,这个方式叫NSURLCache。这种方式只需两个步骤就能缓存网络接口返回内容:

  • 第一步:客户端设置缓存大小
AppDelegate.m

NSURLCache *urlCache = [[NSURLCache alloc] initWithMemoryCapacity:4*1024*1024 diskCapacity:100*1024*1024 diskPath:nil];
NSURLCache.sharedURLCache = urlCache;
  • 第二步:客户端发出 GET请求
  • 第三步:Done,通过NSCachedURLResponse *cachedResponse = [[NSURLCache sharedURLCache] cachedResponseForRequest:request]; 可以获取接口缓存

这两个步骤之后,GET请求的内容会被系统自动缓存了,无需自己去实现内容缓存,对于这种方法,Mattt大神说过“无数开发者尝试自己做一个简陋而脆弱的系统来实现网络缓存的功能,殊不知 NSURLCache 只要两行代码就能搞定且好上 100 倍。”

Demo(NSURLSession)

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.

    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
    NSURLSession *session = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"url"] cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:30.f];
    if (self.etag) {
        [request setValue:self.etag forHTTPHeaderField:@"If-None-Match"];
    }
    
    NSURLSessionDataTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        NSHTTPURLResponse *urlResponse = (NSHTTPURLResponse *)response;
        if (urlResponse.statusCode == 304) {
            NSCachedURLResponse *cachedResponse = [[NSURLCache sharedURLCache] cachedResponseForRequest:request];
            if (cachedResponse) {
                data = cachedResponse.data;
            }
        } else {
            if (urlResponse.allHeaderFields[@"Etag"]) {
                NSString *etag = urlResponse.allHeaderFields[@"Etag"];
                if (etag && etag.length > 0) {
                    [self saveEtag:etag];
                }
            }
        }
    }];
    [task resume];
}

Demo(AFNetworking)

AFHTTPSessionManager *sessionManager = [[AFHTTPSessionManager alloc] initWithBaseURL:[NSURL URLWithString:baseURL] sessionConfiguration:config];
sessionManager.requestSerializer = [CustomJSONRequestSerializer serializer];
sessionManager.responseSerializer = [CustomJSONResponseSerializer serializer];
@interface CustomJSONRequestSerializer : AFJSONRequestSerializer
@end

@implementation CustomJSONRequestSerializer

- (NSMutableURLRequest *)requestWithMethod:(NSString *)method URLString:(NSString *)URLString parameters:(id)parameters error:(NSError *__autoreleasing  _Nullable *)error
{
    NSMutableURLRequest *request = [super requestWithMethod:method URLString:URLString parameters:parameters error:error];
   
    // add request If-None-Match header
    NSString *absoluteUrl = request.URL.absoluteString;
    NSString *directory = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject stringByAppendingPathComponent:@"etags"];
    NSString *fileName = [directory stringByAppendingPathComponent:[self cachedFileNameForKey:absoluteUrl]];
    if ([[NSFileManager defaultManager] fileExistsAtPath:fileName]) {
        NSString *etag = [NSKeyedUnarchiver unarchiveObjectWithFile:fileName];
        if (etag && etag.length > 0) {
            [request addValue:etag forHTTPHeaderField:@"If-None-Match"];
        }
    }
    
    return request;
}

@end
@interface CustomJSONResponseSerializer : AFJSONResponseSerializer
@end

@implementation CustomJSONResponseSerializer

- (nullable id)responseObjectForResponse:(NSURLResponse *)response data:(NSData *)data error:(NSError *__autoreleasing  _Nullable *)error
{
    NSUInteger responseStatusCode = 200;
    if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
        responseStatusCode = (NSUInteger)[(NSHTTPURLResponse *)response statusCode];
    }
    
    id responseObject;
    
    if (responseStatusCode == 304) {
        // fetch cached contents
        NSCachedURLResponse *cachedResponse = [[NSURLCache sharedURLCache] cachedResponseForRequest:task.currentRequest];
        
        if (cachedResponse) {
            responseObject = [super responseObjectForResponse:cachedResponse.response data:cachedResponse.data error:error];
        } else {
            // cached response was cleared, need to clear cached etag
            NSString *directory = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject stringByAppendingPathComponent:@"etags"];
            NSString *fileName = [self cachedFileNameForKey:response.URL.absoluteString];
            NSString *cachedFileName = [directory stringByAppendingPathComponent:fileName];
            [[NSFileManager defaultManager] removeItemAtPath:cachedFileName error:nil];
        }
        
        return responseObject;
    } else if (responseStatusCode >= 200 && responseStatusCode <= 299) {
        if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
            if (httpResponse.allHeaderFields[@"Etag"]) {
                NSString *etag = httpResponse.allHeaderFields[@"Etag"];
                if (etag && etag.length > 0) {
                    NSString *directory = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject stringByAppendingPathComponent:@"etags"];
                    if (![[NSFileManager defaultManager] fileExistsAtPath:directory]) {
                        [[NSFileManager defaultManager] createDirectoryAtPath:directory withIntermediateDirectories:NO attributes:nil error:nil];
                    }
                    NSString *fileName = [self cachedFileNameForKey:response.URL.absoluteString];
                    NSString *cachedFileName = [directory stringByAppendingPathComponent:fileName];
                    BOOL success = [NSKeyedArchiver archiveRootObject:etag toFile:cachedFileName];
                }
            }
        }
        responseObject = [super responseObjectForResponse:response data:data error:error];
        
        return responseObject;
    } else {
        id responseObject = [super responseObjectForResponse:response data:data error:error];
        
        if ([responseObject isKindOfClass:[NSDictionary class]]) {
            *error = [NSError errorWithDomain:NSURLErrorDomain code:responseStatusCode userInfo:responseObject];
        } else {
            *error = [NSError errorWithDomain:NSURLErrorDomain code:responseStatusCode userInfo:nil];
        }
        return nil;
    }
}

@end

转载请注明出处,原文地址:http://kobedai.me/p9rsts-6o/

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

推荐阅读更多精彩内容