在手機應用程序開發中，為了減少與服務端的交互次數，加快用戶的響應速度，一般都會在iOS設備中加一個緩存的機制.

AD：2013雲計算架構師峰會課程資料下載

前面一篇文章介紹了iOS設備的內存緩存，這篇文章將設計一個本地緩存的機制。

功能需求

這個緩存機制滿足下面這些功能。

1、可以將數據緩存到本地磁盤。

2、可以判斷一個資源是否已經被緩存。如果已經被緩存，在請求相同的資源，先到本地磁盤搜索。

3、可以判斷文件緩存什麼時候過期。這裡為了簡單起見這裡，我們在請求url資源的時候，給每次請求的文件設定一個過期的時間。

4、可以實現：如果文件已經被緩存，而且沒有過期，這將本地的數據返回，否則重新請求url。

5、可以實現：如果文件下載不成功或者下載沒有完成，下次打開程序的時候，移除這些沒有成功或者沒有下載完成的文件。

6、可以實現：同時請求或者下載多個資源。

設計實現：

1、設計一個CacheItem類，用來請求一個web連接，它的一個實例表示一個緩存項。這個CacheItem類，需要一個url創建一個NSURLConnection，去請求web資源。使用CacheItem類主要用來請求web資源。

1. /* ---------緩存項-------------- */
3. @interface CacheItem : NSObject {
4. @public
5. id delegate;
6. //web地址
7. NSString *remoteURL;
8. @private
9. //是否正在下載
10. BOOL isDownloading;
11. //NSMutableData對象
12. NSMutableData *connectionData;
13. //NSURLConnection對象
14. NSURLConnection *connection;
15. }
17. /* -------------------------- */
19. @property (nonatomic, retain) id delegate;
20. @property (nonatomic, retain) NSString *remoteURL;
21. @property (nonatomic, assign) BOOL isDownloading;
22. @property (nonatomic, retain) NSMutableData *connectionData;
23. @property (nonatomic, retain) NSURLConnection *connection;
25. /* ----------開始下載方法----------- */
27. - (BOOL) startDownloadingURL:(NSString *)paramRemoteURL;
29. @end

    2、在NSURLConnection開始請求之前，調用CachedDownloadManager類，來搜索和管理本地的緩存文件。將緩存文件的情況保存到一個字典類中。這個字典設計如下：

    1. {
    3. "http://www.cnn.com" = {
    5. DownloadEndDate = "2011-08-02 07:51:57 +0100";
    7. DownloadStartDate = "2011-08-02 07:51:55 +0100";
    9. ExpiresInSeconds = 20;
    11. ExpiryDate = "2011-08-02 07:52:17 +0100";
    13. LocalURL = "/var/mobile/Applications/ApplicationID/Documents/
    15. httpwww.cnn.com.cache";
    17. };
    19. "http://www.baidu.com" = {
    21. DownloadEndDate = "2011-08-02 07:51:49 +0100";
    23. DownloadStartDate = "2011-08-02 07:51:44 +0100";
    25. ExpiresInSeconds = 20;
    27. ExpiryDate = "2011-08-02 07:52:09 +0100";
    29. LocalURL = "/var/mobile/Applications/ApplicationID/Documents/
    31. httpwww.oreilly.com.cache";
    33. };
    35. }

        
        

        上面這個字典裡面嵌套了字典。裡面那層字典表示一個緩存項的緩存信息：下載結束時間、下載開始時間、緩存有效時間、緩存過期時間、緩存到本地的路徑。

        下面看下CachedDownloadManager類。用它來實現和封裝我們的緩存策略。

        1. /* -----------CachedDownloadManager-------------- */
        3. @interface CachedDownloadManager : NSObject
        5. {
        7. @public
        9. id delegate;
        11. @private
        13. //記錄緩存數據的字典
        15. NSMutableDictionary *cacheDictionary;
        17. //緩存的路徑
        19. NSString *cacheDictionaryPath;
        21. }
        23. @property (nonatomic, assign)
        25. id delegate;
        27. @property (nonatomic, copy)
        29. NSMutableDictionary *cacheDictionary;
        31. @property (nonatomic, retain)
        33. NSString *cacheDictionaryPath;
        35. /* 保持緩存字典 */
        37. - (BOOL) saveCacheDictionary;
        39. /* 公有方法：下載 */
        41. - (BOOL) download:(NSString *)paramURLAsString
        43. urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds
        45. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache;
        47. /* -------------------------- */
        49. @end

        50. 從上面代碼可以看出，這個管理緩存的類中，有一個緩存字典：cacheDictionary，用來表示所有資源的緩存情況;cacheDictionaryPath用來表示緩存的路徑;saveCacheDictionary用來將緩存字典歸檔到本地文件中。download：urlMustExpireInSeconds：updateExpiryDateIfInCache是一個公共接口，通過傳遞url、緩存過期時間、是否更新緩存過期時間三個參數來方便的使用，實現我們的緩存策略。

            
            

            
            

            3、如果這個文件已經被下載，而且沒有過期，則從本地獲取文件的數據。如果文件已經過期，則重新下載。我們通過download：urlMustExpireInSeconds：updateExpiryDateIfInCache方法來實現，主要看這個方法的代碼：

            1. /* ---------下載-------------- */
            3. - (BOOL) download:(NSString *)paramURLAsString
            5. urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds
            7. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache{
            9. BOOL result = NO;
            11. if (self.cacheDictionary == nil ||
            13. [paramURLAsString length] == 0){
            15. return(NO);
            17. }
            19. paramURLAsString = [paramURLAsString lowercaseString];
            21. //根據url，從字典中獲取緩存項的相關數據
            23. NSMutableDictionary *itemDictionary =
            25. [self.cacheDictionary objectForKey:paramURLAsString];
            27. /* 使用下面這些變量幫助我們理解緩存邏輯 */
            29. //文件是否已經被緩存
            31. BOOL fileHasBeenCached = NO;
            33. //緩存是否過期
            35. BOOL cachedFileHasExpired = NO;
            37. //緩存文件是否存在
            39. BOOL cachedFileExists = NO;
            41. //緩存文件能否被加載
            43. BOOL cachedFileDataCanBeLoaded = NO;
            45. //緩存文件數據
            47. NSData *cachedFileData = nil;
            49. //緩存文件是否完全下載
            51. BOOL cachedFileIsFullyDownloaded = NO;
            53. //緩存文件是否已經下載
            55. BOOL cachedFileIsBeingDownloaded = NO;
            57. //過期時間
            59. NSDate *expiryDate = nil;
            61. //下載結束時間
            63. NSDate *downloadEndDate = nil;
            65. //下載開始時間
            67. NSDate *downloadStartDate = nil;
            69. //本地緩存路徑
            71. NSString *localURL = nil;
            73. //有效時間
            75. NSNumber *expiresInSeconds = nil;
            77. NSDate *now = [NSDate date];
            79. if (itemDictionary != nil){
            81. fileHasBeenCached = YES;
            83. }
            85. //如果文件已經被緩存，則從緩存項相關數據中獲取相關的值
            87. if (fileHasBeenCached == YES){
            89. expiryDate = [itemDictionary
            91. objectForKey:CachedKeyExpiryDate];
            93. downloadEndDate = [itemDictionary
            95. objectForKey:CachedKeyDownloadEndDate];
            97. downloadStartDate = [itemDictionary
            99. objectForKey:CachedKeyDownloadStartDate];
            101. localURL = [itemDictionary
            103. objectForKey:CachedKeyLocalURL];
            105. expiresInSeconds = [itemDictionary
            107. objectForKey:CachedKeyExpiresInSeconds];
            109. //如果下載開始和結束時間不為空，表示文件全部被下載
            111. if (downloadEndDate != nil &&
            113. downloadStartDate != nil){
            115. cachedFileIsFullyDownloaded = YES;
            117. }
            119. /* 如果expiresInSeconds不為空，downloadEndDate為空，表示文件已經正在下載 */
            121. if (expiresInSeconds != nil &&
            123. downloadEndDate == nil){
            125. cachedFileIsBeingDownloaded = YES;
            127. }
            129. /* 判斷緩存是否過期 */
            131. if (expiryDate != nil &&
            133. [now timeIntervalSinceDate:expiryDate] > 0.0){
            135. cachedFileHasExpired = YES;
            137. }
            139. if (cachedFileHasExpired == NO){
            141. /* 如果緩存文件沒有過期，加載緩存文件，並且更新過期時間 */
            143. NSFileManager *fileManager = [[NSFileManager alloc] init];
            145. if ([fileManager fileExistsAtPath:localURL] == YES){
            147. cachedFileExists = YES;
            149. cachedFileData = [NSData dataWithContentsOfFile:localURL];
            151. if (cachedFileData != nil){
            153. cachedFileDataCanBeLoaded = YES;
            155. } /* if (cachedFileData != nil){ */
            157. } /* if ([fileManager fileExistsAtPath:localURL] == YES){ */
            159. [fileManager release];
            161. /* 更新緩存時間 */
            163. if (paramUpdateExpiryDateIfInCache == YES){
            165. NSDate *newExpiryDate =
            167. [NSDate dateWithTimeIntervalSinceNow:
            169. paramURLMustExpireInSeconds];
            171. NSLog(@"Updating the expiry date from %@ to %@.",
            173. expiryDate,
            175. newExpiryDate);
            177. [itemDictionary setObject:newExpiryDate
            179. forKey:CachedKeyExpiryDate];
            181. NSNumber *expires =
            183. [NSNumber numberWithFloat:paramURLMustExpireInSeconds];
            185. [itemDictionary setObject:expires
            187. forKey:CachedKeyExpiresInSeconds];
            189. }
            191. } /* if (cachedFileHasExpired == NO){ */
            193. }
            195. if (cachedFileIsBeingDownloaded == YES){
            197. NSLog(@"這個文件已經正在下載...");
            199. return(YES);
            201. }
            203. if (fileHasBeenCached == YES){
            205. if (cachedFileHasExpired == NO &&
            207. cachedFileExists == YES &&
            209. cachedFileDataCanBeLoaded == YES &&
            211. [cachedFileData length] > 0 &&
            213. cachedFileIsFullyDownloaded == YES){
            215. /* 如果文件有緩存而且沒有過期 */
            217. NSLog(@"文件有緩存而且沒有過期.");
            219. [self.delegate
            221. cachedDownloadManagerSucceeded:self
            223. remoteURL:[NSURL URLWithString:paramURLAsString]
            225. localURL:[NSURL URLWithString:localURL]
            227. aboutToBeReleasedData:cachedFileData
            229. isCachedData:YES];
            231. return(YES);
            233. } else {
            235. /* 如果文件沒有被緩存，獲取緩存失敗 */
            237. NSLog(@"文件沒有緩存.");
            239. [self.cacheDictionary removeObjectForKey:paramURLAsString];
            241. [self saveCacheDictionary];
            243. } /* if (cachedFileHasExpired == NO && */
            245. } /* if (fileHasBeenCached == YES){ */
            247. /* 去下載文件 */
            249. NSNumber *expires =
            251. [NSNumber numberWithFloat:paramURLMustExpireInSeconds];
            253. NSMutableDictionary *newDictionary =
            255. [[[NSMutableDictionary alloc] init] autorelease];
            257. [newDictionary setObject:expires
            259. forKey:CachedKeyExpiresInSeconds];
            261. localURL = [paramURLAsString
            263. stringByAddingPercentEscapesUsingEncoding:
            265. NSUTF8StringEncoding];
            267. localURL = [localURL stringByReplacingOccurrencesOfString:@"://"
            269. withString:@""];
            271. localURL = [localURL stringByReplacingOccurrencesOfString:@"/"
            273. withString:@"{1}quot;];
            275. localURL = [localURL stringByAppendingPathExtension:@"cache"];
            277. NSString *documentsDirectory =
            279. [self documentsDirectoryWithTrailingSlash:NO];
            281. localURL = [documentsDirectory
            283. stringByAppendingPathComponent:localURL];
            285. [newDictionary setObject:localURL
            287. forKey:CachedKeyLocalURL];
            289. [newDictionary setObject:now
            291. forKey:CachedKeyDownloadStartDate];
            293. [self.cacheDictionary setObject:newDictionary
            295. forKey:paramURLAsString];
            297. [self saveCacheDictionary];
            299. CacheItem *item = [[[CacheItem alloc] init] autorelease];
            301. [item setDelegate:self];
            303. [item startDownloadingURL:paramURLAsString];
            305. return(result);
            307. }

            308. 4、下面我們設計緩存項下載成功和失敗的兩個委托方法：

                 1. @protocol CacheItemDelegate
                 3. //下載成功執行該方法
                 5. - (void) cacheItemDelegateSucceeded
                 7. :(CacheItem *)paramSender
                 9. withRemoteURL:(NSURL *)paramRemoteURL
                 11. withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData;
                 13. //下載失敗執行該方法
                 15. - (void) cacheItemDelegateFailed
                 17. :(CacheItem *)paramSender
                 19. remoteURL:(NSURL *)paramRemoteURL
                 21. withError:(NSError *)paramError;
                 23. @end

                     當我們下載成功的時候，修改緩存字典中的下載時間，表示已經下載完成，而且需要將請求的資源數據緩存到本地：

                     1. //緩存項的委托方法
                     3. - (void) cacheItemDelegateSucceeded:(CacheItem *)paramSender
                     5. withRemoteURL:(NSURL *)paramRemoteURL
                     7. withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData{
                     9. //從緩存字典中獲取該緩存項的相關數據
                     11. NSMutableDictionary *dictionary =
                     13. [self.cacheDictionary objectForKey:[paramRemoteURL absoluteString]];
                     15. //取當前時間
                     17. NSDate *now = [NSDate date];
                     19. //獲取有效時間
                     21. NSNumber *expiresInSeconds = [dictionary
                     23. objectForKey:CachedKeyExpiresInSeconds];
                     25. //轉換成NSTimeInterval
                     27. NSTimeInterval expirySeconds = [expiresInSeconds floatValue];
                     29. //修改字典中緩存項的下載結束時間
                     31. [dictionary setObject:[NSDate date]
                     33. forKey:CachedKeyDownloadEndDate];
                     35. //修改字典中緩存項的緩存過期時間
                     37. [dictionary setObject:[now dateByAddingTimeInterval:expirySeconds]
                     39. forKey:CachedKeyExpiryDate];
                     41. //保存緩存字典
                     43. [self saveCacheDictionary];
                     45. NSString *localURL = [dictionary objectForKey:CachedKeyLocalURL];
                     47. /* 將下載的數據保持到磁盤 */
                     49. if ([paramAboutToBeReleasedData writeToFile:localURL
                     51. atomically:YES] == YES){
                     53. NSLog(@"緩存文件到磁盤成功.");
                     55. } else{
                     57. NSLog(@"緩存文件到磁盤失敗.");
                     59. }
                     61. //執行緩存管理的委托方法
                     63. [self.delegate
                     65. cachedDownloadManagerSucceeded:self
                     67. remoteURL:paramRemoteURL
                     69. localURL:[NSURL URLWithString:localURL]
                     71. aboutToBeReleasedData:paramAboutToBeReleasedData
                     73. isCachedData:NO];
                     75. }

                     76. 
                         

                         如果下載失敗我們需要從緩存字典中移除改緩存項：

                         1. //緩存項失敗失敗的委托方法
                         3. - (void) cacheItemDelegateFailed:(CacheItem *)paramSender
                         5. remoteURL:(NSURL *)paramRemoteURL
                         7. withError:(NSError *)paramError{
                         9. /* 從緩存字典中移除緩存項，並發送一個委托 */
                         11. if (self.delegate != nil){
                         13. NSMutableDictionary *dictionary =
                         15. [self.cacheDictionary
                         17. objectForKey:[paramRemoteURL absoluteString]];
                         19. NSString *localURL = [dictionary
                         21. objectForKey:CachedKeyLocalURL];
                         23. [self.delegate
                         25. cachedDownloadManagerFailed:self
                         27. remoteURL:paramRemoteURL
                         29. localURL:[NSURL URLWithString:localURL]
                         31. withError:paramError];
                         33. }
                         35. [self.cacheDictionary
                         37. removeObjectForKey:[paramRemoteURL absoluteString]];
                         39. }

                         40. 5、加載緩存字典的時候，我們可以將沒有下載完成的文件移除：

                             1. //初始化緩存字典
                             3. NSString *documentsDirectory =
                             5. [self documentsDirectoryWithTrailingSlash:YES];
                             7. //生產緩存字典的路徑
                             9. cacheDictionaryPath =
                             11. [[documentsDirectory
                             13. stringByAppendingString:@"CachedDownloads.dic"] retain];
                             15. //創建一個NSFileManager實例
                             17. NSFileManager *fileManager = [[NSFileManager alloc] init];
                             19. //判斷是否存在緩存字典的數據
                             21. if ([fileManager
                             23. fileExistsAtPath:self.cacheDictionaryPath] == YES){
                             25. NSLog(self.cacheDictionaryPath);
                             27. //加載緩存字典中的數據
                             29. NSMutableDictionary *dictionary =
                             31. [[NSMutableDictionary alloc]
                             33. initWithContentsOfFile:self.cacheDictionaryPath];
                             35. cacheDictionary = [dictionary mutableCopy];
                             37. [dictionary release];
                             39. //移除沒有下載完成的緩存數據
                             41. [self removeCorruptedCachedItems];
                             43. } else {
                             45. //創建一個新的緩存字典
                             47. NSMutableDictionary *dictionary =
                             49. [[NSMutableDictionary alloc] init];
                             51. cacheDictionary = [dictionary mutableCopy];
                             53. [dictionary release];
                             55. }

                             56. 這樣就基本上完成了我們需要的功能，下面看看我們如何使用我們設計的緩存功能。

                                 例子場景：

                                 我們用一個UIWebView來顯示stackoverflow這個網站，我們在這個網站的內容緩存到本地20秒，如果在20秒內用戶去請求該網站，則從本地文件中獲取內容，否則過了20秒，則重新獲取數據，並緩存到本地。

                                 在界面上拖放一個button和一個webview控件，如下圖。

                                 
                                 

                                 
                                 

                                 這樣我們可以很方便使用前面定義好的類。我們在viewDidLoad 中實例化一個CachedDownloadManager，並設置它的委托為self。當下載完成的時候，執行CachedDownloadManager的下載成功的委托方法。

                                 - (void)viewDidLoad { [super viewDidLoad]; [self setTitle:@"本地緩存測試"];

                                 CachedDownloadManager *newManager =[[CachedDownloadManager alloc] init];

                                 self.downloadManager = newManager; [newManager release]; [self.downloadManager setDelegate:self]; }

                                 在button的點擊事件中加入下面代碼，請求stackoverflow ：

                                 static NSString *url = @http://stackoverflow.com;

                                 [self.downloadManager download:url urlMustExpireInSeconds:20.0fupdateExpiryDateIfInCache:YES];

                                 上面的代碼表示將這個stackoverflow的緩存事件設置為20s，並且如果在20s內有相同的請求，則從本地獲取stackoverflow的內容數據。updateExpiryDateIfInCache設置為yes表示：在此請求的時候，緩存時間又更新為20s，類似我們的session。如果設置成no，則第一次請求20s之後，該緩存就過期。

                                 請求完成之後會執行CachedDownloadManager的委托方法。我們將數據展示在uiwebview中，代碼如下：

                                 - (void) cachedDownloadManagerSucceeded:(CachedDownloadManager *)paramSender remoteURL:(NSURL *)paramRemoteURL localURL:(NSURL*)paramLocalURL aboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData isCachedData:(BOOL)paramIsCachedData

                                 { [webview loadData:paramAboutToBeReleasedData MIMEType:@"text/html" textEncodingName:@"UTF-8" baseURL:[NSURL URLWithString:@"http://stackoverflow.com"]]; }

                                 這樣我們就實現了20s的緩存。

                                 效果：

                                 第一次點擊測試按鈕：

                                 
                                 

                                 20s內點擊按鈕，程序就從本地獲取數據，比較快速的就顯示出該網頁了。

                                 
                                 

                                 總結：

                                 本文通過代碼和實例設計了一個iPhone應用程序本地緩存的方案。當然這個方案不是最好的，如果你有更好的思路，歡迎告訴我。