iOS NSCache和NSUrlCache缓存类如何实现示例详解 - Swift

NSCache NSCache是Foundation框架提供的缓存类的实现，使用方式类似于可变字典，最重要的是它是线程安全的，而NSMutableDiction

NSCache

NSCache是Foundation框架提供的缓存类的实现，使用方式类似于可变字典，最重要的是它是线程安全的，而NSMutableDictionary不是线程安全的，在多线程环境下使用NSCache是更好的选择。类的基本属性和方法：

#import <Foundation/NSObject.h>
@class NSString;
@protocol NSCacheDelegate;
NS_ASSUME_NONNULL_BEGIN
API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0))
@interface NSCache <KeyType, ObjectType> : NSObject {
@private
    id _delegate;
    void *_private[5];
    void *_reserved;
}
@property (copy) NSString *name;
@property (nullable, assign) id<NSCacheDelegate> delegate;
- (nullable ObjectType)objectForKey:(KeyType)key;
- (void)setObject:(ObjectType)obj forKey:(KeyType)key; // 0 cost
- (void)setObject:(ObjectType)obj forKey:(KeyType)key cost:(NSUInteger)g;
- (void)removeObjectForKey:(KeyType)key;
- (void)removeAllObjects;
@property NSUInteger totalCostLimit;	// limits are imprecise/not strict
@property NSUInteger countLimit;	// limits are imprecise/not strict
@property BOOL evictsObjectsWithDiscardedContent;
@end
@protocol NSCacheDelegate <NSObject>
@optional
- (void)cache:(NSCache *)cache willEvictObject:(id)obj;
@end
NS_ASSUME_NONNULL_END

缓存淘汰策略

通过 GNUstep 提供的源码，我们得知其对于 NSCache 的处理是计算出一个平均访问次数，然后释放的是访问次数较少的对象，直到满足需要释放大小，也就是 LRU 的机制。通过 swift-corelibs-foundation 源码我们得知，其首先存储链表结构中是按对象花费内存大小排序的，然后通过用户有无指定 totalCostLimit 大小限制来依次释放（先释放占用较小的对象），直到满足需要释放大小。然后再通过个数限制来释放，直到满足需要释放大小（依旧是先释放较小的对象）。

GNUstepFoundation 源码地址：github.com/gnustep/lib…

Swift Foundation 源码地址：github.com/apple/swift…

在内存不足时NSCache会自动释放存储的对象。

NSCache的键key不会被复制，所以key不需要实现NSCopying协议。

可以设置缓存的最大数量，当缓存数量满的时候，再添加将先删除先添加的对象再增加。

唯一一个代理方法是一个对象将被删除时调用，调用方式有以下几种:

NSCache缓存对象自身被释放
手动调用removeObjectForKey:方法
手动调用removeAllObjects
缓存中对象的个数大于countLimit，或，缓存中对象的总cost值大于totalCostLimit
程序进入后台后
收到系统的内存警告

基本用法：

@interface NSCacheViewController ()<NSCacheDelegate>
@property(nonatomic,strong) NSCache *cache;
@end
@implementation NSCacheViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    self.cache = [[NSCache alloc] init];
    //设置最大缓存数
    self.cache.countLimit = 5;
    //设置代理，实现代理方法，
    self.cache.delegate = self;
    self.cache.name = @"测试内存";
    for (int i=0; i<10; i++) {
        NSString *str = [NSString stringWithFormat:@"%d",i];
        [self.cache setObject:str forKey:str];
    }
    // Do any additional setup after loading the view.
}
//超出缓存部分会被释放， 收到内存警告时候系统也会释放一部分。
-(void)cache:(NSCache *)cache willEvictObject:(id)obj{
    NSLog(@"%@---%@",cache,obj);
}
@end

实际应用 SDWebImage

SDImageCacheConfig中可以配置是否使用内存做缓存，默认为YES

磁盘缓存的最大时长，默认为一周

SDImage中内存缓存SDMemoryCache继承与NScache，缓存时候会在NSCache和SDMemoryCache的NSMapTable各存一份。读取时候也优先读取系统cache，如果不存在再读取SDMemoryCache，这样做的目标是防止一些系统缓存不可控因素。

// `setObject:forKey:` just call this with 0 cost. Override this is enough
- (void)setObject:(id)obj forKey:(id)key cost:(NSUInteger)g {
    [super setObject:obj forKey:key cost:g];
    if (!self.config.shouldUseWeakMemoryCache) {
        return;
    }
    if (key && obj) {
        // Store weak cache
        SD_LOCK(_weakCacheLock);
        [self.weakCache setObject:obj forKey:key];
        SD_UNLOCK(_weakCacheLock);
    }
}

NSURLCache

使用缓存的目的是为了使应用程序能更快速的响应用户输入，是程序高效的运行。有时候我们需要将远程web服务器获取的数据缓存起来，以空间换取时间，减少对同一个url多次请求，减轻服务器的压力，优化客户端网络，让用户体验更良好。

背景：NSURLCache : 在iOS5以前，apple不支持磁盘缓存，在iOS5的时候，允许磁盘缓存，（NSURLCache 是根据NSURLRequest 来实现的）只支持http，在iOS6以后，支持http和https。

缓存的实现说明：由于GET请求一般用来查询数据，POST请求一般是发大量数据给服务器处理（变动性比较大），因此一般只对GET请求进行缓存，而不对POST请求进行缓存。

缓存原理：一个NSURLRequest对应一个NSCachedURLResponse

Etag全称是Entity Tag，一般用于标识URL对象是否发生了改变。使用Etag一般会出现如下的请求流程：

Etag有点类似于文件hash或者说是信息摘要。

当进行一次URL请求，服务端会返回'Etag'响应头，下次浏览器请求相同的URL时，浏览器会自动将它设置为请求头'If-None-Match'的值。服务器收到这个请求之后，就开始做信息校验工作将自己本次产生的Etag与请求传递过来的'If-None-Match'对比，如果相同，则返回HTTP状态码304，并且response数据体中没有数据。

第二次请求的时候从哪里获取到'Etag'的值并赋给请求头'If-None-Match'的？自然是浏览器的缓存中取出的。那么浏览器收到304状态码之后又干了什么？刚才说到response数据体中没有数据，但是浏览器仍需加载页面，它会从缓存中读取上次缓存的页面。

//
//  NSURLCacheViewController.m
//  DemoTest2022
//
//  Created by wy on 2022/10/19.
//
#import "NSURLCacheViewController.h"
@interface NSURLCacheViewController ()
//去服务器比对资源是否需要更新
@property (nonatomic, strong) NSString *lastModified;
@property (nonatomic, strong) NSString *etag;
@property(nonatomic,strong) UIImageView *imagev;
@end
@implementation NSURLCacheViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    self.imagev = [[UIImageView alloc] initWithFrame:CGRectMake(0, 100, 100, 100)];
    [self.view addSubview:self.imagev];
    // Do any additional setup after loading the view.
}
-(void)requestTest{
    NSURL *url = [NSURL URLWithString:@"http://via.placeholder.com/50x50.png"];
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url cachePolicy:(NSURLRequestReloadIgnoringCacheData) timeoutInterval:15] ;
    if (self.lastModified) {
        [request setValue:self.lastModified forHTTPHeaderField:@"If-Modified-Since"];
    }
    if (self.etag) {
        [request setValue:self.etag forHTTPHeaderField:@"If-None-Match"];
    }
    [[[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
            if (error) {
                NSLog(@"error---%@",error);
            }else{
                NSData *tempData = data;
                NSString *responseStr = [[NSString alloc] initWithData:tempData encoding:NSUTF8StringEncoding];
                self.lastModified = [(NSHTTPURLResponse *)response  allHeaderFields][@"Last-Modified"];
                self.etag =[(NSHTTPURLResponse *)response allHeaderFields][@"etag"];
                NSLog(@"response:%@", response);
                dispatch_sync(dispatch_get_main_queue(), ^{
                    self.imagev.image = [UIImage imageWithData:tempData];
                });
            }
        }] resume] ;
}
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event{
    [self requestTest];
}
@end

这样每次请求都使用忽略缓存的策略，但是要附带着"If-None-Match"头，它的值是上次请求的响应头"Etag"的值，于是服务器会每次都实时检查文件的修改状态，得到一个准确的状态值，最后决定返回304还是200。若是200，iOS则直接使用新的response和新的数据;如果是304，则使用新的response和缓存中的data。

这样既能够获取到最新的数据有能够节约带宽。两全其美。

iOS中定以的URLRequest缓存策略有以下几种：

typedef NS_ENUM(NSUInteger, NSURLRequestCachePolicy)
{
    NSURLRequestUseProtocolCachePolicy = 0,
    // 从不读取缓存，但请求后将response缓存起来
    NSURLRequestReloadIgnoringLocalCacheData = 1,
    NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4,
    NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData,
    // 以下两种在取缓存时，可能取到的是过期数据
    NSURLRequestReturnCacheDataElseLoad = 2,// 缓存中没有才去发起请求加载，有就不进行网络请求了
    NSURLRequestReturnCacheDataDontLoad = 3,// 缓存中没有不加载，绝不发起网络请求,缓存中没有则返回错误
    NSURLRequestReloadRevalidatingCacheData = 5,//Unimplemented
};

官方文档解释：