【轉】設計一個iOS應用的本地快取機制

weixin_34320159發表於2017-03-29
iOS快取

原文連結：http://cache.baiducontent.com/c?m=9d78d513d9981cee4fede5697c1dc0111343f0122ba6d4027ea48438e3732b325016e5ac50260443939b733d47e90b4beb832b6f675d7de28cc8ff1b9cedce3f2fff7b633601de12568052e8931d769577cc0ff4fc59a1e1a16cc4b384849907089412187081f28e5e0711&p=882a9e4e839f12a05aa48a3e5f5f&newp=c679c54addc80efc57ef8f31557a92695803ed603ed1da01298ffe0cc4241a1a1a3aecbf26291b0fd7c07e630ba54859ebfa34703c0634f1f689df08d2ecce7e60&user=baidu&fm=sc&query=ios+%C9%E8%BC%C6%BB%BA%B4%E6&qid=fe2a3c3300015032&p1=1

前面一篇文章介紹了iOS裝置的記憶體快取，這篇文章將設計一個本地快取的機制。

功能需求

這個快取機制滿足下面這些功能。

1、可以將資料快取到本地磁碟。

2、可以判斷一個資源是否已經被快取。如果已經被快取，在請求相同的資源，先到本地磁碟搜尋。

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

4、可以實現：如果檔案已經被快取，而且沒有過期，這將本地的資料返回，否則重新請求url。

5、可以實現：如果檔案下載不成功或者下載沒有完成，下次開啟程式的時候，移除這些沒有成功或者沒有下載完成的檔案。

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

設計實現：

1、設計一個CacheItem類，用來請求一個web連線，它的一個例項表示一個快取項。這個CacheItem類，需要一個url建立一個NSURLConnection，去請求web資源。使用CacheItem類主要用來請求web資源。

/* ---------快取項-------------- */   

@interface CacheItem : NSObject {   
@public   
  id<CacheItemDelegate> delegate;   
  //web地址   
  NSString              *remoteURL;   
@private   
  //是否正在下載   
  BOOL                  isDownloading;   
  //NSMutableData物件   
  NSMutableData         *connectionData;   
 //NSURLConnection物件   
NSURLConnection       *connection;   
}   

/* -------------------------- */   

@property (nonatomic, retain) id<CacheItemDelegate> delegate;   
@property (nonatomic, retain) NSString  *remoteURL;   
@property (nonatomic, assign) BOOL      isDownloading;   
@property (nonatomic, retain) NSMutableData *connectionData;   
@property (nonatomic, retain) NSURLConnection *connection;   

/* ----------開始下載方法----------- */   

   - (BOOL) startDownloadingURL:(NSString *)paramRemoteURL;   

@end

2、在NSURLConnection開始請求之前，呼叫CachedDownloadManager類，來搜尋和管理本地的快取檔案。將快取檔案的情況儲存到一個字典類中。這個字典設計如下：

{   

  "http://www.cnn.com" =     {   

    DownloadEndDate = "2011-08-02 07:51:57 +0100";   

    DownloadStartDate = "2011-08-02 07:51:55 +0100";   

    ExpiresInSeconds = 20;   

    ExpiryDate = "2011-08-02 07:52:17 +0100";   

    LocalURL = "/var/mobile/Applications/ApplicationID/Documents/   

            httpwww.cnn.com.cache";   

  };   

  "http://www.baidu.com" =     {   

    DownloadEndDate = "2011-08-02 07:51:49 +0100";   

    DownloadStartDate = "2011-08-02 07:51:44 +0100";   

    ExpiresInSeconds = 20;   

    ExpiryDate = "2011-08-02 07:52:09 +0100";   

    LocalURL = "/var/mobile/Applications/ApplicationID/Documents/   

            httpwww.oreilly.com.cache";   

  };   

}

上面這個字典裡面巢狀了字典。裡面那層字典表示一個快取項的快取資訊：下載結束時間、下載開始時間、快取有效時間、快取過期時間、快取到本地的路徑。

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

/* -----------CachedDownloadManager-------------- */ 

@interface CachedDownloadManager : NSObject 

{ 

@public 

id delegate; 

@private 

//記錄快取資料的字典 

NSMutableDictionary *cacheDictionary; 

//快取的路徑 

NSString *cacheDictionaryPath; 

} 

@property (nonatomic, assign)  id delegate; 

@property (nonatomic, copy) 

NSMutableDictionary *cacheDictionary; 

@property (nonatomic, retain) 

NSString *cacheDictionaryPath; 
 
/* 保持快取字典 */ 

- (BOOL) saveCacheDictionary; 

/* 公有方法：下載 */ 

- (BOOL) download:(NSString *)paramURLAsString

urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds

updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache;

/* -------------------------- */ 

@end

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

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

/* ---------下載-------------- */ 

- (BOOL) download:(NSString *)paramURLAsString  urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache{ 

BOOL result = NO; 

if (self.cacheDictionary == nil || 

[paramURLAsString length] == 0){ 

return(NO); 

} 

paramURLAsString = [paramURLAsString lowercaseString]; 

//根據url，從字典中獲取快取項的相關資料 

NSMutableDictionary *itemDictionary = 

[self.cacheDictionary objectForKey:paramURLAsString]; 

/* 使用下面這些變數幫助我們理解快取邏輯 */ 

//檔案是否已經被快取 

BOOL fileHasBeenCached = NO; 

//快取是否過期 

BOOL cachedFileHasExpired = NO; 

//快取檔案是否存在 

BOOL cachedFileExists = NO; 

//快取檔案能否被載入 

BOOL cachedFileDataCanBeLoaded = NO; 

//快取檔案資料 

NSData *cachedFileData = nil; 

//快取檔案是否完全下載 

BOOL cachedFileIsFullyDownloaded = NO; 

//快取檔案是否已經下載 

BOOL cachedFileIsBeingDownloaded = NO; 

//過期時間 

NSDate *expiryDate = nil; 

//下載結束時間 

NSDate *downloadEndDate = nil; 

//下載開始時間 

NSDate *downloadStartDate = nil; 

//本地快取路徑 

NSString *localURL = nil; 

//有效時間 

NSNumber *expiresInSeconds = nil; 

NSDate *now = [NSDate date]; 

if (itemDictionary != nil){ 

    fileHasBeenCached = YES; 

} 

//如果檔案已經被快取，則從快取項相關資料中獲取相關的值 

if (fileHasBeenCached == YES){ 

    expiryDate = [itemDictionary objectForKey:CachedKeyExpiryDate]; 

    downloadEndDate = [itemDictionary objectForKey:CachedKeyDownloadEndDate]; 

    downloadStartDate = [itemDictionary objectForKey:CachedKeyDownloadStartDate]; 

    localURL = [itemDictionary objectForKey:CachedKeyLocalURL]; 

    expiresInSeconds = [itemDictionary objectForKey:CachedKeyExpiresInSeconds]; 

//如果下載開始和結束時間不為空，表示檔案全部被下載 

    if (downloadEndDate != nil && downloadStartDate != nil){ 

        cachedFileIsFullyDownloaded = YES; 
     }

/* 如果expiresInSeconds不為空，downloadEndDate為空，表示檔案已經正在下載 */

if (expiresInSeconds != nil &&

downloadEndDate == nil){

cachedFileIsBeingDownloaded = YES;

}

/* 判斷快取是否過期 */

if (expiryDate != nil &&

[now timeIntervalSinceDate:expiryDate] > 0.0){

cachedFileHasExpired = YES;

}

if (cachedFileHasExpired == NO){

/* 如果快取檔案沒有過期，載入快取檔案，並且更新過期時間 */

NSFileManager *fileManager = [[NSFileManager alloc] init];

if ([fileManager fileExistsAtPath:localURL] == YES){

cachedFileExists = YES;

cachedFileData = [NSData dataWithContentsOfFile:localURL];

if (cachedFileData != nil){

cachedFileDataCanBeLoaded = YES;

} /* if (cachedFileData != nil){ */

} /* if ([fileManager fileExistsAtPath:localURL] == YES){ */

[fileManager release];

/* 更新快取時間 */

if (paramUpdateExpiryDateIfInCache == YES){

NSDate *newExpiryDate =

[NSDate dateWithTimeIntervalSinceNow:

paramURLMustExpireInSeconds];

NSLog(@"Updating the expiry date from %@ to %@.",

expiryDate,

newExpiryDate);

[itemDictionary setObject:newExpiryDate

forKey:CachedKeyExpiryDate];

NSNumber *expires =

[NSNumber numberWithFloat:paramURLMustExpireInSeconds];

[itemDictionary setObject:expires

forKey:CachedKeyExpiresInSeconds];

}

} /* if (cachedFileHasExpired == NO){ */

}

if (cachedFileIsBeingDownloaded == YES){

NSLog(@"這個檔案已經正在下載...");

return(YES);

}

if (fileHasBeenCached == YES){

if (cachedFileHasExpired == NO &&

cachedFileExists == YES &&

cachedFileDataCanBeLoaded == YES &&

[cachedFileData length] > 0 &&

cachedFileIsFullyDownloaded == YES){

/* 如果檔案有快取而且沒有過期 */

NSLog(@"檔案有快取而且沒有過期.");

[self.delegate

cachedDownloadManagerSucceeded:self

remoteURL:[NSURL URLWithString:paramURLAsString]

localURL:[NSURL URLWithString:localURL]

aboutToBeReleasedData:cachedFileData

isCachedData:YES];

return(YES);

} else {

/* 如果檔案沒有被快取，獲取快取失敗 */

NSLog(@"檔案沒有快取.");

[self.cacheDictionary removeObjectForKey:paramURLAsString];

[self saveCacheDictionary];

} /* if (cachedFileHasExpired == NO && */

} /* if (fileHasBeenCached == YES){ */

/* 去下載檔案 */

NSNumber *expires =

[NSNumber numberWithFloat:paramURLMustExpireInSeconds];

NSMutableDictionary *newDictionary =

[[[NSMutableDictionary alloc] init] autorelease];

[newDictionary setObject:expires

forKey:CachedKeyExpiresInSeconds];

localURL = [paramURLAsString

stringByAddingPercentEscapesUsingEncoding:

NSUTF8StringEncoding];

localURL = [localURL stringByReplacingOccurrencesOfString:@"://"

withString:@""];

localURL = [localURL stringByReplacingOccurrencesOfString:@"/"

withString:@"{1}quot;];

localURL = [localURL stringByAppendingPathExtension:@"cache"];

NSString *documentsDirectory =

[self documentsDirectoryWithTrailingSlash:NO];

localURL = [documentsDirectory

stringByAppendingPathComponent:localURL];

[newDictionary setObject:localURL

forKey:CachedKeyLocalURL];

[newDictionary setObject:now

forKey:CachedKeyDownloadStartDate];

[self.cacheDictionary setObject:newDictionary

forKey:paramURLAsString];

[self saveCacheDictionary];

CacheItem *item = [[[CacheItem alloc] init] autorelease];

[item setDelegate:self];

[item startDownloadingURL:paramURLAsString];

return(result);

}

4、下面我們設計快取項下載成功和失敗的兩個委託方法：

@protocol CacheItemDelegate <NSObject>

//下載成功執行該方法

  • (void) cacheItemDelegateSucceeded

    :(CacheItem *)paramSender

    withRemoteURL:(NSURL *)paramRemoteURL

    withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData;

//下載失敗執行該方法

  • (void) cacheItemDelegateFailed

    :(CacheItem *)paramSender

    remoteURL:(NSURL *)paramRemoteURL

    withError:(NSError *)paramError;

@end
當我們下載成功的時候，修改快取字典中的下載時間，表示已經下載完成，而且需要將請求的資源資料快取到本地：

//快取項的委託方法

  • (void) cacheItemDelegateSucceeded:(CacheItem *)paramSender

withRemoteURL:(NSURL *)paramRemoteURL

withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData{

//從快取字典中獲取該快取項的相關資料

NSMutableDictionary *dictionary =

[self.cacheDictionary objectForKey:[paramRemoteURL absoluteString]];

//取當前時間

NSDate *now = [NSDate date];

//獲取有效時間

NSNumber *expiresInSeconds = [dictionary

objectForKey:CachedKeyExpiresInSeconds];

//轉換成NSTimeInterval

NSTimeInterval expirySeconds = [expiresInSeconds floatValue];

//修改字典中快取項的下載結束時間

[dictionary setObject:[NSDate date]

forKey:CachedKeyDownloadEndDate];

//修改字典中快取項的快取過期時間

[dictionary setObject:[now dateByAddingTimeInterval:expirySeconds]

forKey:CachedKeyExpiryDate];

//儲存快取字典

[self saveCacheDictionary];

NSString *localURL = [dictionary objectForKey:CachedKeyLocalURL];

/* 將下載的資料保持到磁碟 */

if ([paramAboutToBeReleasedData writeToFile:localURL

atomically:YES] == YES){

NSLog(@"快取檔案到磁碟成功.");

} else{

NSLog(@"快取檔案到磁碟失敗.");

}

//執行快取管理的委託方法

[self.delegate

cachedDownloadManagerSucceeded:self

remoteURL:paramRemoteURL

localURL:[NSURL URLWithString:localURL]

aboutToBeReleasedData:paramAboutToBeReleasedData

isCachedData:NO];

}

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

//快取項失敗失敗的委託方法

  • (void) cacheItemDelegateFailed:(CacheItem *)paramSender

remoteURL:(NSURL *)paramRemoteURL

withError:(NSError *)paramError{

/* 從快取字典中移除快取項，併傳送一個委託 */

if (self.delegate != nil){

NSMutableDictionary *dictionary =

[self.cacheDictionary

objectForKey:[paramRemoteURL absoluteString]];

NSString *localURL = [dictionary

objectForKey:CachedKeyLocalURL];

[self.delegate

cachedDownloadManagerFailed:self

remoteURL:paramRemoteURL

localURL:[NSURL URLWithString:localURL]

withError:paramError];

}

[self.cacheDictionary

removeObjectForKey:[paramRemoteURL absoluteString]];

}

5、載入快取字典的時候，我們可以將沒有下載完成的檔案移除：

//初始化快取字典

NSString *documentsDirectory =

[self documentsDirectoryWithTrailingSlash:YES];

//生產快取字典的路徑

cacheDictionaryPath =

[[documentsDirectory

stringByAppendingString:@"CachedDownloads.dic"] retain];

//建立一個NSFileManager例項

NSFileManager *fileManager = [[NSFileManager alloc] init];

//判斷是否存在快取字典的資料

if ([fileManager

fileExistsAtPath:self.cacheDictionaryPath] == YES){

NSLog(self.cacheDictionaryPath);

//載入快取字典中的資料

NSMutableDictionary *dictionary =

[[NSMutableDictionary alloc]

initWithContentsOfFile:self.cacheDictionaryPath];

cacheDictionary = [dictionary mutableCopy];

[dictionary release];

//移除沒有下載完成的快取資料

[self removeCorruptedCachedItems];

} else {

//建立一個新的快取字典

NSMutableDictionary *dictionary =

[[NSMutableDictionary alloc] init];

cacheDictionary = [dictionary mutableCopy];

[dictionary release];

}

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

例子場景：

我們用一個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應用程式本地快取的方案。當然這個方案不是最好的，如果你有更好的思路，歡迎告訴我。

頂

相關文章