image.png
2.首先从YYCache类来看
所用的宏的简要说明:
__has_include:判断文件是否存在，再导入使用，避免文件不存在的情况。一个异常保护机制。
FOUNDATION_EXPORT:FOUNDATION_EXPORT 与 ＃define 都可以用来定义常量,但是FOUNDATION_EXPORT在比较字符串是否相等的时候更快.
NS_ASSUME_NONNULL_BEGIN， NS_ASSUME_NONNULL_END。在这两个宏之间的代码，所有简单指针对象都被假定为nonnull，因此我们只需要去指定那些nullable的指针。
NS_DESIGNATED_INITIALIZER:实现指定构造器的,用这个宏，往往是想告诉调用者要用这个方法去初始化（构造）类对象.
UNAVAILABLE_ATTRIBUTE:告诉编译器该方法不可用，如果强行调用编译器会提示错误。比如某个类在构造的时候不想直接通过init来初始化，只能通过特定的初始化方法()比如单例，就可以将init方法标记为unavailable。
#import <Foundation/Foundation.h>
#if __has_include(<YYCache/YYCache.h>)
FOUNDATION_EXPORT double YYCacheVersionNumber;
FOUNDATION_EXPORT const unsigned char YYCacheVersionString[];
#import <YYCache/YYMemoryCache.h>
#import <YYCache/YYDiskCache.h>
#import <YYCache/YYKVStorage.h>
#elif __has_include(<YYWebImage/YYCache.h>)
#import <YYWebImage/YYMemoryCache.h>
#import <YYWebImage/YYDiskCache.h>
#import <YYWebImage/YYKVStorage.h>
#else
#import "YYMemoryCache.h"
#import "YYDiskCache.h"
#import "YYKVStorage.h"
#endif
// 1.宏表明所有对象都为非空
NS_ASSUME_NONNULL_BEGIN
/**
YYMemoryCache存储小数据以及快速的内存缓存，YYDiskCache：适合存储较大的数据以及数据的持久化到磁盘
*/
@interface YYCache : NSObject
// 缓存的名称
@property (copy, readonly) NSString *name;
/** YYMemoryCache属性 */
@property (strong, readonly) YYMemoryCache *memoryCache;
/** YYDiskCache属性 */
@property (strong, readonly) YYDiskCache *diskCache;
/**
用输入的名称创建一个新的实例，具有相同名称的多个实例将使缓存不稳。会根据传入的缓存名称会在本地磁盘上创建一个缓存的目录，一旦初始化完成你最好不要读写这个目录
*/
- (nullable instancetype)initWithName:(NSString *)name;
/**
指定的初始化方法，根据传入的路径来创建缓存目录
*/
- (nullable instancetype)initWithPath:(NSString *)path NS_DESIGNATED_INITIALIZER;
/**
简便的初始化方式
*/
+ (nullable instancetype)cacheWithName:(NSString *)name;
/**
简便的初始化方式
*/
+ (nullable instancetype)cacheWithPath:(NSString *)path;
// 不可使用的初始化方式
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
+ (instancetype)new UNAVAILABLE_ATTRIBUTE;
#pragma mark - Access Methods
///=============================================================================
/// @name Access Methods
///=============================================================================
/**
返回一个布尔值，该值指示某个给定的键是否在缓存中。
*/
- (BOOL)containsObjectForKey:(NSString *)key;
/**
返回一个布尔值，该值指示某个给定的键是否在缓存中,完成后执行block里面的内容
*/
- (void)containsObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, BOOL contains))block;
/**
根据传入的key获取缓存的内容
*/
- (nullable id<NSCoding>)objectForKey:(NSString *)key;
/**
获取缓存数值后，执行block里面的动作
*/
- (void)objectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, id<NSCoding> object))block;
/**
根据键缓存对应的对象
*/
- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key;
/**
根据键缓存对应的对象完成后执行block的操作
*/
- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key withBlock:(nullable void(^)(void))block;
/**
清除缓存中指定的键对应的数值
*/
- (void)removeObjectForKey:(NSString *)key;
/**
清除缓存中指定的键对应的数值后执行block中的内容
*/
- (void)removeObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key))block;
/**
清空缓存
*/
- (void)removeAllObjects;
/**
清空缓存后，执行block里面的内容
*/
- (void)removeAllObjectsWithBlock:(void(^)(void))block;
/**
清空缓存，在清空的时候调用progress里面的内容，完成后执行end的block中的内容
*/
- (void)removeAllObjectsWithProgressBlock:(nullable void(^)(int removedCount, int totalCount))progress
endBlock:(nullable void(^)(BOOL error))end;
@end
NS_ASSUME_NONNULL_END
PS：在使用YYCache操作缓存的时候他会同时向内存以及本地磁盘写入缓存数据信息。
