YYCache 原始碼分析(一)

發表於2016-06-11

iOS 開發中總會用到各種快取，YYCache或許是你最好的選擇。效能上有優勢，用法也很簡單。作者`ibireme`曾經對比過同類輪子：http://blog.ibireme.com/2015/10/26/yycache/

1.簡單架構圖

2.YYCache.h方法分析

@interface YYCache : NSObject
// 讀取當前資料庫名稱
@property (copy, readonly) NSString *name;

// memoryCache記憶體快取，diskCache檔案快取
@property (strong, readonly) YYMemoryCache *memoryCache;
@property (strong, readonly) YYDiskCache *diskCache;

// 可通過下面三種方法來例項化YYCache物件
- (nullable instancetype)initWithName:(NSString *)name;
- (nullable instancetype)initWithPath:(NSString *)path NS_DESIGNATED_INITIALIZER;
+ (nullable instancetype)cacheWithPath:(NSString *)path;

// 禁止通過下面兩個方式例項化物件
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
+ (instancetype)new __attribute__((unavailable("new方法不可用，請用initWithName:")));

// 通過key判斷是否快取了某個東西，第二個法是非同步執行,非同步回撥
- (BOOL)containsObjectForKey:(NSString *)key;
- (void)containsObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, BOOL contains))block;

// 讀--通過key讀取快取，第二個法是非同步執行,非同步回撥
- (nullable id<NSCoding>)objectForKey:(NSString *)key;
- (void)objectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, id<NSCoding> object))block;

// 增、改--快取物件(可快取遵從NSCoding協議的物件)，第二個法是非同步執行,非同步回撥
- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key;
- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key withBlock:(nullable void(^)(void))block;

// 刪--刪除快取
- (void)removeObjectForKey:(NSString *)key;
- (void)removeObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key))block;
- (void)removeAllObjects;
- (void)removeAllObjectsWithBlock:(void(^)(void))block;
- (void)removeAllObjectsWithProgressBlock:(nullable void(^)(int removedCount, int totalCount))progress
                                 endBlock:(nullable void(^)(BOOL error))end;

@end

@interface YYCache : NSObject

// 讀取當前資料庫名稱

@property (copy, readonly) NSString *name;

// memoryCache記憶體快取，diskCache檔案快取

@property (strong, readonly) YYMemoryCache *memoryCache;

@property (strong, readonly) YYDiskCache *diskCache;

// 可通過下面三種方法來例項化YYCache物件

- (nullable instancetype)initWithName:(NSString *)name;

- (nullable instancetype)initWithPath:(NSString *)path NS_DESIGNATED_INITIALIZER;

+ (nullable instancetype)cacheWithPath:(NSString *)path;

// 禁止通過下面兩個方式例項化物件

- (instancetype)init UNAVAILABLE_ATTRIBUTE;

+ (instancetype)new __attribute__((unavailable("new方法不可用，請用initWithName:")));

// 通過key判斷是否快取了某個東西，第二個法是非同步執行,非同步回撥

- (BOOL)containsObjectForKey:(NSString *)key;

- (void)containsObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, BOOL contains))block;

// 讀--通過key讀取快取，第二個法是非同步執行,非同步回撥

- (nullable id<NSCoding>)objectForKey:(NSString *)key;

- (void)objectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key, id<NSCoding> object))block;

// 增、改--快取物件(可快取遵從NSCoding協議的物件)，第二個法是非同步執行,非同步回撥

- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key;

- (void)setObject:(nullable id<NSCoding>)object forKey:(NSString *)key withBlock:(nullable void(^)(void))block;

// 刪--刪除快取

- (void)removeObjectForKey:(NSString *)key;

- (void)removeObjectForKey:(NSString *)key withBlock:(nullable void(^)(NSString *key))block;

- (void)removeAllObjects;

- (void)removeAllObjectsWithBlock:(void(^)(void))block;

- (void)removeAllObjectsWithProgressBlock:(nullable void(^)(int removedCount, int totalCount))progress

endBlock:(nullable void(^)(BOOL error))end;

@end

3.YYCache使用

// 0.初始化YYCache
    YYCache *cache = [YYCache cacheWithName:@"mydb"];
    // 1.快取普通字元
    [cache setObject:@"漢斯哈哈哈" forKey:@"name"];
    NSString *name = (NSString *)[cache objectForKey:@"name"];
    NSLog(@"name: %@", name);
    // 2.快取模型
    [cache setObject:(id<NSCoding>)model forKey:@"user"];
    // 3.快取陣列
    NSMutableArray *array = @[].mutableCopy;
    for (NSInteger i = 0; i < 10; i ++) {
        [array addObject:model];
    }
    // 非同步快取
    [cache setObject:array forKey:@"user" withBlock:^{
        // 非同步回撥
        NSLog(@"%@", [NSThread currentThread]);
        NSLog(@"array快取完成....");
    }];
    // 延時讀取
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
        // 非同步讀取
        [cache objectForKey:@"user" withBlock:^(NSString * _Nonnull key, id<NSCoding>  _Nonnull object) {
            // 非同步回撥
            NSLog(@"%@", [NSThread currentThread]);
            NSLog(@"%@", object);
        }];
    });

// 0.初始化YYCache

YYCache *cache = [YYCache cacheWithName:@"mydb"];

// 1.快取普通字元

[cache setObject:@"漢斯哈哈哈" forKey:@"name"];

NSString *name = (NSString *)[cache objectForKey:@"name"];

NSLog(@"name: %@", name);

// 2.快取模型

[cache setObject:(id<NSCoding>)model forKey:@"user"];

// 3.快取陣列

NSMutableArray *array = @[].mutableCopy;

for (NSInteger i = 0; i < 10; i ++) {

[array addObject:model];

}

// 非同步快取

[cache setObject:array forKey:@"user" withBlock:^{

// 非同步回撥

NSLog(@"%@", [NSThread currentThread]);

NSLog(@"array快取完成....");

}];

// 延時讀取

dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{

// 非同步讀取

[cache objectForKey:@"user" withBlock:^(NSString * _Nonnull key, id<NSCoding> _Nonnull object) {

// 非同步回撥

NSLog(@"%@", [NSThread currentThread]);

NSLog(@"%@", object);

}];

});

列印：

2016-06-09 11:35:44.069 YYCache原始碼分析[13546:949048] <NSThread: 0x7ffd43f14840>{number = 2, name = (null)}
2016-06-09 11:35:44.069 YYCache原始碼分析[13546:949048] array快取完成....
2016-06-09 11:35:44.386 YYCache原始碼分析[13546:949052] <NSThread: 0x7ffd43e01900>{number = 3, name = (null)}
2016-06-09 11:35:44.386 YYCache原始碼分析[13546:949052] (
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>",
    "<UserModel: 0x7ffd44014310>"
)

2016-06-09 11:35:44.069 YYCache原始碼分析[13546:949048] <NSThread: 0x7ffd43f14840>{number = 2, name = (null)}

2016-06-09 11:35:44.069 YYCache原始碼分析[13546:949048] array快取完成....

2016-06-09 11:35:44.386 YYCache原始碼分析[13546:949052] <NSThread: 0x7ffd43e01900>{number = 3, name = (null)}

2016-06-09 11:35:44.386 YYCache原始碼分析[13546:949052] (

"<UserModel: 0x7ffd44014310>",

"<UserModel: 0x7ffd44014310>"

)

// 快取實現，預設同時進行記憶體快取與檔案快取
- (void)setObject:(id<NSCoding>)object forKey:(NSString *)key {
    [_memoryCache setObject:object forKey:key];
    [_diskCache setObject:object forKey:key];
}

// 快取實現，預設同時進行記憶體快取與檔案快取

- (void)setObject:(id<NSCoding>)object forKey:(NSString *)key {

[_memoryCache setObject:object forKey:key];

[_diskCache setObject:object forKey:key];

}

// 如果只想記憶體快取，可以直接呼叫`memoryCache`物件
    YYCache *cache2 = [YYCache cacheWithName:@"mydb"];
    [cache2.memoryCache setObject:@24 forKey:@"age"];
    NSLog(@"age快取在記憶體：%d", [cache2.memoryCache containsObjectForKey:@"age"]);
    NSLog(@"age快取在檔案：%d", [cache2.diskCache containsObjectForKey:@"age"]);

// 如果只想記憶體快取，可以直接呼叫`memoryCache`物件

YYCache *cache2 = [YYCache cacheWithName:@"mydb"];

[cache2.memoryCache setObject:@24 forKey:@"age"];

NSLog(@"age快取在記憶體：%d", [cache2.memoryCache containsObjectForKey:@"age"]);

NSLog(@"age快取在檔案：%d", [cache2.diskCache containsObjectForKey:@"age"]);

列印：

2016-06-09 21:23:24.326 YYCache原始碼分析[14512:1085375] age快取在記憶體：1
2016-06-09 21:23:24.326 YYCache原始碼分析[14512:1085375] age快取在檔案：0

1 2	2016-06-09 21:23:24.326 YYCache原始碼分析[14512:1085375] age快取在記憶體：1 2016-06-09 21:23:24.326 YYCache原始碼分析[14512:1085375] age快取在檔案：0

4.YYCache.h tips

#if __has_include(<YYCache/YYCache.h>)
#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

#if __has_include(<YYCache/YYCache.h>)

#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

__has_include：用來檢查Frameworks是否引入某個類，
像YYWebImage已經整合YYCache,如果匯入過YYWebImage則無需重新匯入YYCache

NS_ASSUME_NONNULL_BEGIN
@interface YYCache : NSObject
...
- (nullable instancetype)initWithName:(NSString *)name;
...
@end
NS_ASSUME_NONNULL_END

NS_ASSUME_NONNULL_BEGIN

@interface YYCache : NSObject

...

- (nullable instancetype)initWithName:(NSString *)name;

...

@end

NS_ASSUME_NONNULL_END

介面中 nullable 的是少數,一般都為nonnull,為了防止寫一大堆 nonnull，Foundation供了一對巨集NS_ASSUME_NONNULL_BEGIN、NS_ASSUME_NONNULL_END，包在裡面的物件預設加 nonnull 修飾符，如果是nullable的,只需要把 nullable 的指出來就行

- (instancetype)init UNAVAILABLE_ATTRIBUTE;
+ (instancetype)new UNAVAILABLE_ATTRIBUTE;

1 2	- (instancetype)init UNAVAILABLE_ATTRIBUTE; + (instancetype)new UNAVAILABLE_ATTRIBUTE;

command+滑鼠左鍵UNAVAILABLE_ATTRIBUTE，
發現巨集定義#define UNAVAILABLE_ATTRIBUTE __attribute__((unavailable)),
__attribute__是Clang提供的一種原始碼註解，方便開發者向編譯器表達某種要求,括號裡是傳達某種命令.
為方便使用，一些常用屬性也被Cocoa定義成巨集,
比如UNAVAILABLE_ATTRIBUTE、NS_CLASS_AVAILABLE_IOS(9_0).
unavailable告訴編譯器該方法失效.
在封裝單例或初始化某個類前必須做一些事時,對一些方法禁用是非常不錯的選擇.
還可以給個message提示:

Objective-C

+ (instancetype)alloc __attribute__((unavailable("alloc方法不可用，請用initWithName:"))); - (instancetype)init __attribute__((unavailable("init方法不可用，請用initWithName:"))); + (instancetype)new __attribute__((unavailable("new方法不可用，請用initWithName:"))); - (instancetype)copy __attribute__((unavailable("copy方法不可用，請用initWithName:")));

1
2
3
4

+ (instancetype)alloc __attribute__((unavailable("alloc方法不可用，請用initWithName:")));
- (instancetype)init __attribute__((unavailable("init方法不可用，請用initWithName:")));
+ (instancetype)new __attribute__((unavailable("new方法不可用，請用initWithName:")));
- (instancetype)copy __attribute__((unavailable("copy方法不可用，請用initWithName:")));

本文只是簡單剖析，接下來會分析YYMemoryCache實現原理.

References

http://blog.sunnyxx.com/2016/05/14/clang-attributes/
http://blog.sunnyxx.com/2015/06/12/objc-new-features-in-2015/

文章同步到微信公眾號：hans_iOS 有疑問可以在公眾號裡直接發

YYCache 原始碼分析(二)
2016-06-11
原始碼
YYCache 原始碼分析(三)
2016-06-16
原始碼
原始碼解析 — YYCache
2016-12-31
原始碼
YYCache 原始碼解析
1970-01-01
原始碼
YYCache 原始碼剖析：一覽亮點
2019-07-30
原始碼
YYCache原始碼筆記2
2017-12-13
原始碼筆記
YYCache原始碼筆記1
2017-12-13
原始碼筆記
從 YYCache 原始碼 Get 到如何設計一個優秀的快取
2017-10-30
原始碼快取
深度 Mybatis 3 原始碼分析（一）SqlSessionFactoryBuilder原始碼分析
2019-06-06
MyBatis原始碼SQLSessionUI
原始碼|jdk原始碼之HashMap分析(一)
2019-01-19
原始碼JDKHashMap
MyBatis原始碼分析(一)
2020-07-07
MyBatis原始碼
preact原始碼分析(一)
2019-03-24
React原始碼
Redux原始碼分析(一)
2019-04-19
Redux原始碼
RecyclerView 原始碼分析(一)
2020-12-07
View原始碼
AFL原始碼分析（一）
2022-11-23
原始碼
原始碼分析一：EventBus
2018-03-01
原始碼
Backbone原始碼分析（一）
2016-04-10
原始碼
Cobar 原始碼分析（一）
2013-09-16
原始碼
LinkedList原始碼分析（一）
2018-11-19
原始碼
DelayQueue系列（一）：原始碼分析
2018-12-23
原始碼
YYCache理解
2019-03-04
Retrofit原始碼分析三原始碼分析
2018-05-17
原始碼
《YYModel原始碼分析（一）YYClassInfo》
2019-04-14
原始碼
Netty原始碼分析--NIO（一）
2019-06-29
Netty原始碼
DataTable.js原始碼分析(一)
2018-10-22
JS原始碼
Volcano 原理、原始碼分析（一）
2023-12-29
原始碼
Retrofit原始碼分析一概覽
2018-04-17
原始碼
AFNetworking 原始碼分析（一）
2018-05-21
原始碼
Tinker接入及原始碼分析（一）
2017-02-10
原始碼
Zookeeper原始碼分析（一） ----- 原始碼執行環境搭建
2018-04-30
原始碼
Spring事務原始碼分析專題（一）JdbcTemplate使用及原始碼分析
2020-07-21
Spring原始碼JDBC
集合原始碼分析[2]-AbstractList 原始碼分析
2019-04-11
原始碼
集合原始碼分析[1]-Collection 原始碼分析
2019-03-23
原始碼
集合原始碼分析[3]-ArrayList 原始碼分析
2019-04-12
原始碼
Guava 原始碼分析之 EventBus 原始碼分析
2018-08-01
Guava原始碼
RxJava2原始碼分析（一）：基本流程分析
2019-01-06
RxJava原始碼
jQuery 原始碼分析第一篇之入口原始碼
2015-08-17
jQuery原始碼
深入OKHttp原始碼分析（一）----同步和非同步請求流程和原始碼分析
2018-04-12
HTTP原始碼非同步