iOS 本機快取實現 方案借鑒

標籤：

在手機應用程式開發中，為了減少與服務端的互動次數，加快使用者的響應速度，一般都會在iOS裝置中加一個緩衝的機制，前面一篇文章介紹了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 
                                   <CacheItemDelegate> {
@public
  id<CachedDownloadManagerDelegate>  delegate;
@private
//記錄快取資料的字典
  NSMutableDictionary                *cacheDictionary;
                                       //緩衝的路徑
  NSString                           *cacheDictionaryPath;
}


@property (nonatomic, assign) 
id<CachedDownloadManagerDelegate> 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){ */
  
  /* 去下載檔案 */

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];
      
    }
    
    [fileManager 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.0f
    updateExpiryDateIfInCache: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應用程式本機快取的方案。

轉:http://blog.csdn.net/fhbystudy/article/details/25902841

iOS 本機快取實現 方案借鑒