设为首页优惠IDC收藏本站六狼博客六狼论坛
开启辅助访问 切换到窄版

六狼论坛

 找回密码
 立即注册

QQ登录

只需一步，快速开始

新浪微博账号登陆

只需一步，快速开始

搜索
六狼论坛»首页 › 移动开发 › iOS开发 › 设计一个移动应用的本地缓存机制
返回列表 发新帖
查看: 629|回复: 0

设计一个移动应用的本地缓存机制

[复制链接]
 楼主| 发表于 2013-6-27 14:08:46 | 显示全部楼层 |阅读模式
在手机应用程序开发中，为了减少与服务端的交互次数，加快用户的响应速度，一般都会在iOS设备中加一个缓存的机制，前面一篇文章介绍了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. {
  2.   "http://www.cnn.com" =     {
  3.     DownloadEndDate = "2011-08-02 07:51:57 +0100";
  4.     DownloadStartDate = "2011-08-02 07:51:55 +0100";
  5.     ExpiresInSeconds = 20;
  6.     ExpiryDate = "2011-08-02 07:52:17 +0100";
  7.     LocalURL = "/var/mobile/Applications/ApplicationID/Documents/
  8.                 httpwww.cnn.com.cache";
  9.   };
  10.   "http://www.baidu.com" =     {
  11.     DownloadEndDate = "2011-08-02 07:51:49 +0100";
  12.     DownloadStartDate = "2011-08-02 07:51:44 +0100";
  13.     ExpiresInSeconds = 20;
  14.     ExpiryDate = "2011-08-02 07:52:09 +0100";
  15.     LocalURL = "/var/mobile/Applications/ApplicationID/Documents/
  16.                 httpwww.oreilly.com.cache";
  17.   };
  18. }
复制代码
上面这个字典里面嵌套了字典。里面那层字典表示一个缓存项的缓存信息：下载结束时间、下载开始时间、缓存有效时间、缓存过期时间、缓存到本地的路径。   下面看下CachedDownloadManager类。用它来实现和封装我们的缓存策略。
  1. /* -----------CachedDownloadManager-------------- */

  3. @interface CachedDownloadManager : NSObject
  4.                                     {
  5. @public
  6.   id  delegate;
  7. @private
  8. //记录缓存数据的字典
  9.   NSMutableDictionary                *cacheDictionary;
  10.                                        //缓存的路径
  11.   NSString                           *cacheDictionaryPath;
  12. }


  15. @property (nonatomic, assign)
  16. id delegate;

  18. @property (nonatomic, copy)
  19. NSMutableDictionary *cacheDictionary;

  21. @property (nonatomic, retain)
  22. NSString *cacheDictionaryPath;


  25. /* 保持缓存字典 */

  27. - (BOOL) saveCacheDictionary;

  29. /* 公有方法：下载 */

  31. - (BOOL)         download:(NSString *)paramURLAsString
  32.    urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds
  33. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache;

  35. /* -------------------------- */

  37. @end
复制代码
从上面代码可以看出，这个管理缓存的类中，有一个缓存字典：cacheDictionary，用来表示所有资源的缓存情况；cacheDictionaryPath用来表示缓存的路径；saveCacheDictionary用来将缓存字典归档到本地文件中。download：urlMustExpireInSeconds：updateExpiryDateIfInCache是一个公共接口，通过传递url、缓存过期时间、是否更新缓存过期时间三个参数来方便的使用，实现我们的缓存策略。
3、如果这个文件已经被下载，而且没有过期，则从本地获取文件的数据。如果文件已经过期，则重新下载。我们通过download：urlMustExpireInSeconds：updateExpiryDateIfInCache方法来实现，主要看这个方法的代码：
  1. - (BOOL)         download:(NSString *)paramURLAsString
  2.    urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds
  3. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache{
  4.   
  5.   BOOL result = NO;
  6.   
  7.   if (self.cacheDictionary == nil ||
  8.       [paramURLAsString length] == 0){
  9.     return(NO);
  10.   }
  11.   
  12.   paramURLAsString = [paramURLAsString lowercaseString];
  13.   //根据url，从字典中获取缓存项的相关数据
  14.   NSMutableDictionary *itemDictionary =
  15.   [self.cacheDictionary objectForKey:paramURLAsString];
  16.   
  17.   /* 使用下面这些变量帮助我们理解缓存逻辑 */
  18.     //文件是否已经被缓存
  19.   BOOL    fileHasBeenCached = NO;
  20.     //缓存是否过期
  21.   BOOL    cachedFileHasExpired = NO;
  22.     //缓存文件是否存在
  23.   BOOL    cachedFileExists = NO;
  24.     //缓存文件能否被加载
  25.   BOOL    cachedFileDataCanBeLoaded = NO;
  26.     //缓存文件数据
  27.   NSData  *cachedFileData = nil;
  28.     //缓存文件是否完全下载
  29.   BOOL    cachedFileIsFullyDownloaded = NO;
  30.     //缓存文件是否已经下载
  31.   BOOL    cachedFileIsBeingDownloaded = NO;
  32.   //过期时间
  33.   NSDate    *expiryDate = nil;
  34.     //下载结束时间
  35.   NSDate    *downloadEndDate = nil;
  36.     //下载开始时间
  37.   NSDate    *downloadStartDate = nil;
  38.     //本地缓存路径
  39.   NSString  *localURL = nil;
  40.     //有效时间
  41.   NSNumber  *expiresInSeconds = nil;
  42.   NSDate    *now = [NSDate date];
  43.   
  44.   if (itemDictionary != nil){
  45.     fileHasBeenCached = YES;
  46.   }
  47.   //如果文件已经被缓存，则从缓存项相关数据中获取相关的值
  48.   if (fileHasBeenCached == YES){
  49.    
  50.     expiryDate = [itemDictionary
  51.                   objectForKey:CachedKeyExpiryDate];
  52.    
  53.     downloadEndDate = [itemDictionary
  54.                        objectForKey:CachedKeyDownloadEndDate];
  55.    
  56.     downloadStartDate = [itemDictionary
  57.                          objectForKey:CachedKeyDownloadStartDate];
  58.    
  59.     localURL = [itemDictionary
  60.                 objectForKey:CachedKeyLocalURL];
  61.    
  62.     expiresInSeconds = [itemDictionary
  63.                         objectForKey:CachedKeyExpiresInSeconds];
  64.     //如果下载开始和结束时间不为空，表示文件全部被下载
  65.     if (downloadEndDate != nil &&
  66.         downloadStartDate != nil){
  67.       cachedFileIsFullyDownloaded = YES;
  68.     }
  69.    
  70.     /* 如果expiresInSeconds不为空，downloadEndDate为空，表示文件已经正在下载 */
  71.     if (expiresInSeconds != nil &&
  72.         downloadEndDate == nil){
  73.       cachedFileIsBeingDownloaded = YES;
  74.     }
  75.    
  76.     /* 判断缓存是否过期 */
  77.     if (expiryDate != nil &&
  78.         [now timeIntervalSinceDate:expiryDate] > 0.0){
  79.       cachedFileHasExpired = YES;
  80.     }
  81.    
  82.     if (cachedFileHasExpired == NO){
  83.       /* 如果缓存文件没有过期，加载缓存文件，并且更新过期时间 */
  84.       NSFileManager *fileManager = [[NSFileManager alloc] init];
  85.       
  86.       if ([fileManager fileExistsAtPath:localURL] == YES){
  87.         cachedFileExists = YES;
  88.         cachedFileData = [NSData dataWithContentsOfFile:localURL];
  89.         if (cachedFileData != nil){
  90.           cachedFileDataCanBeLoaded = YES;
  91.         } /* if (cachedFileData != nil){ */
  92.       } /* if ([fileManager fileExistsAtPath:localURL] == YES){ */
  93.       
  94.       [fileManager release];
  95.       
  96.       /* 更新缓存时间 */
  97.       
  98.       if (paramUpdateExpiryDateIfInCache == YES){
  99.         
  100.         NSDate *newExpiryDate =
  101.         [NSDate dateWithTimeIntervalSinceNow:
  102.          paramURLMustExpireInSeconds];
  103.         
  104.         NSLog(@"Updating the expiry date from %@ to %@.",
  105.               expiryDate,
  106.               newExpiryDate);
  107.         
  108.         [itemDictionary setObject:newExpiryDate
  109.                            forKey:CachedKeyExpiryDate];
  110.         
  111.         NSNumber *expires =
  112.         [NSNumber numberWithFloat:paramURLMustExpireInSeconds];
  113.         
  114.         [itemDictionary setObject:expires
  115.                            forKey:CachedKeyExpiresInSeconds];
  116.       }
  117.       
  118.     } /* if (cachedFileHasExpired == NO){ */
  119.    
  120.   }
  121.   
  122.   if (cachedFileIsBeingDownloaded == YES){
  123.     NSLog(@"这个文件已经正在下载...");
  124.     return(YES);
  125.   }
  126.   
  127.   if (fileHasBeenCached == YES){
  128.    
  129.     if (cachedFileHasExpired == NO &&
  130.         cachedFileExists == YES &&
  131.         cachedFileDataCanBeLoaded == YES &&
  132.         [cachedFileData length] > 0 &&
  133.         cachedFileIsFullyDownloaded == YES){
  134.       
  135.       /* 如果文件有缓存而且没有过期 */
  136.       
  137.       NSLog(@"文件有缓存而且没有过期.");
  138.       
  139.       [self.delegate
  140.        cachedDownloadManagerSucceeded:self
  141.        remoteURL:[NSURL URLWithString:paramURLAsString]
  142.        localURL:[NSURL URLWithString:localURL]
  143.        aboutToBeReleasedData:cachedFileData
  144.        isCachedData:YES];
  145.       
  146.       return(YES);
  147.       
  148.     } else {
  149.       /* 如果文件没有被缓存，获取缓存失败 */
  150.       NSLog(@"文件没有缓存.");
  151.       [self.cacheDictionary removeObjectForKey:paramURLAsString];
  152.       [self saveCacheDictionary];
  153.     } /* if (cachedFileHasExpired == NO && */
  154.    
  155.   } /* if (fileHasBeenCached == YES){ */
  156.   
  157.   /* 去下载文件 */
复制代码
4、下面我们设计缓存项下载成功和失败的两个委托方法：
  1. @protocol CacheItemDelegate
  2. //下载成功执行该方法
  3. - (void) cacheItemDelegateSucceeded
  4.   :(CacheItem *)paramSender
  5.   withRemoteURL:(NSURL *)paramRemoteURL
  6.   withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData;

  8. //下载失败执行该方法
  9. - (void) cacheItemDelegateFailed
  10.   :(CacheItem *)paramSender
  11.   remoteURL:(NSURL *)paramRemoteURL
  12.   withError:(NSError *)paramError;

  14. @end
复制代码
当我们下载成功的时候，修改缓存字典中的下载时间，表示已经下载完成，而且需要将请求的资源数据缓存到本地：
  1. //缓存项的委托方法
  2. - (void) cacheItemDelegateSucceeded:(CacheItem *)paramSender
  3.          withRemoteURL:(NSURL *)paramRemoteURL
  4.         withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData{
  5.   
  6.   //从缓存字典中获取该缓存项的相关数据
  7.   NSMutableDictionary *dictionary =
  8.   [self.cacheDictionary objectForKey:[paramRemoteURL absoluteString]];
  9.   //取当前时间
  10.   NSDate *now = [NSDate date];
  11.   //获取有效时间
  12.   NSNumber *expiresInSeconds = [dictionary
  13.                                 objectForKey:CachedKeyExpiresInSeconds];
  14.   //转换成NSTimeInterval
  15.   NSTimeInterval expirySeconds = [expiresInSeconds floatValue];
  16.   //修改字典中缓存项的下载结束时间
  17.   [dictionary setObject:[NSDate date]
  18.                  forKey:CachedKeyDownloadEndDate];
  19.   //修改字典中缓存项的缓存过期时间
  20.   [dictionary setObject:[now dateByAddingTimeInterval:expirySeconds]
  21.                  forKey:CachedKeyExpiryDate];
  22.   //保存缓存字典
  23.   [self saveCacheDictionary];
  24.   
  25.   NSString *localURL = [dictionary objectForKey:CachedKeyLocalURL];
  26.   
  27.   /* 将下载的数据保持到磁盘 */
  28.   if ([paramAboutToBeReleasedData writeToFile:localURL
  29.                                    atomically:YES] == YES){
  30.     NSLog(@"缓存文件到磁盘成功.");
  31.   } else{
  32.     NSLog(@"缓存文件到磁盘失败.");
  33.   }
  34.   //执行缓存管理的委托方法
  35.   [self.delegate
  36.    cachedDownloadManagerSucceeded:self
  37.    remoteURL:paramRemoteURL
  38.    localURL:[NSURL URLWithString:localURL]
  39.    aboutToBeReleasedData:paramAboutToBeReleasedData
  40.    isCachedData:NO];
  41.   
  42.   
  43. }
复制代码
如果下载失败我们需要从缓存字典中移除改缓存项：
  1. //缓存项失败失败的委托方法
  2. - (void) cacheItemDelegateFailed:(CacheItem *)paramSender
  3.                        remoteURL:(NSURL *)paramRemoteURL
  4.                        withError:(NSError *)paramError{
  5.   
  6.   /* 从缓存字典中移除缓存项，并发送一个委托 */
  7.   
  8.   if (self.delegate != nil){
  9.    
  10.     NSMutableDictionary *dictionary =
  11.     [self.cacheDictionary
  12.      objectForKey:[paramRemoteURL absoluteString]];
  13.    
  14.     NSString *localURL = [dictionary
  15.                           objectForKey:CachedKeyLocalURL];
  16.    
  17.     [self.delegate
  18.      cachedDownloadManagerFailed:self
  19.      remoteURL:paramRemoteURL
  20.      localURL:[NSURL URLWithString:localURL]
  21.      withError:paramError];
  22.   }
  23.   
  24.   [self.cacheDictionary
  25.    removeObjectForKey:[paramRemoteURL absoluteString]];
  26.   
  27. }
复制代码
5、加载缓存字典的时候，我们可以将没有下载完成的文件移除：
  1. NSString *documentsDirectory =
  2.     [self documentsDirectoryWithTrailingSlash:YES];
  3.     //生产缓存字典的路径
  4.     cacheDictionaryPath =
  5.     [[documentsDirectory
  6.       stringByAppendingString:@"CachedDownloads.dic"] retain];
  7.     //创建一个NSFileManager实例
  8.     NSFileManager *fileManager = [[NSFileManager alloc] init];
  9.     //判断是否存在缓存字典的数据
  10.     if ([fileManager
  11.          fileExistsAtPath:self.cacheDictionaryPath] == YES){
  12.         NSLog(self.cacheDictionaryPath);
  13.       //加载缓存字典中的数据
  14.       NSMutableDictionary *dictionary =
  15.       [[NSMutableDictionary alloc]
  16.        initWithContentsOfFile:self.cacheDictionaryPath];
  17.       
  18.       cacheDictionary = [dictionary mutableCopy];
  19.       
  20.       [dictionary release];
  21.       
  22.       //移除没有下载完成的缓存数据
  23.       [self removeCorruptedCachedItems];
  24.       
  25.     } else {
  26.       //创建一个新的缓存字典
  27.       NSMutableDictionary *dictionary =
  28.       [[NSMutableDictionary alloc] init];
  29.       
  30.       cacheDictionary = [dictionary mutableCopy];
  31.       
  32.       [dictionary release];
  33.       
  34.     }
  35.    
  36.     [fileManager release];
复制代码
这样就基本上完成了我们需要的功能，下面看看我们如何使用我们设计的缓存功能。
例子场景：
    我们用一个UIWebView来显示stackoverflow这个网站，我们在这个网站的内容缓存到本地20秒，如果在20秒内用户去请求该网站，则从本地文件中获取内容，否则过了20秒，则重新获取数据，并缓存到本地。
    在界面上拖放一个button和一个webview控件，如下图。

    这样我们可以很方便使用前面定义好的类。我们在viewDidLoad 中实例化一个CachedDownloadManager，并设置它的委托为self。当下载完成的时候，执行CachedDownloadManager的下载成功的委托方法。
  1. - (void)viewDidLoad {
  2.   [super viewDidLoad];  
  3.   [self setTitle:@"本地缓存测试"];
  4.   CachedDownloadManager *newManager = [[CachedDownloadManager alloc] init];
  5.   self.downloadManager = newManager;
  6.   [newManager release];
  7.   [self.downloadManager setDelegate:self];
  8.   
  9.   
  10. }
复制代码
在button的点击事件中加入下面代码，请求stackoverflow ：
  1. static NSString *url = @"http://stackoverflow.com";
  2.   
  3.   [self.downloadManager download:url
  4.       urlMustExpireInSeconds:20.0f
  5.     updateExpiryDateIfInCache:YES];
复制代码
上面的代码表示将这个stackoverflow的缓存事件设置为20s，并且如果在20s内有相同的请求，则从本地获取stackoverflow的内容数据。updateExpiryDateIfInCache设置为yes表示：在此请求的时候，缓存时间又更新为20s，类似我们的session。如果设置成no，则第一次请求20s之后，该缓存就过期。    请求完成之后会执行CachedDownloadManager的委托方法。我们将数据展示在uiwebview中，代码如下：
  1. - (void) cachedDownloadManagerSucceeded:(CachedDownloadManager *)paramSender
  2.                               remoteURL:(NSURL *)paramRemoteURL
  3.                                localURL:(NSURL *)paramLocalURL
  4.                   aboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData
  5.                            isCachedData:(BOOL)paramIsCachedData{  

  7.     [webview loadData:paramAboutToBeReleasedData MIMEType:@"text/html" textEncodingName:@"UTF-8" baseURL:[NSURL URLWithString:@"http://stackoverflow.com"]];  
  8. }
复制代码
这样我们就实现了20s的缓存。
效果：
第一次点击测试按钮：

20s内点击按钮，程序就从本地获取数据，比较快速的就显示出该网页了。

总结：
    本文通过代码和实例设计了一个iPhone应用程序本地缓存的方案。当然这个方案不是最好的，如果你有更好的思路，欢迎告诉我。
本文摘自：http://www.cnblogs.com/zhuqil/archive/2011/08/02/2124870.html










移动应用

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有帐号？立即注册 新浪微博账号登陆

x
该会员没有填写今日想说内容.
回复

使用道具 举报

返回列表 发新帖
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册 新浪微博账号登陆

本版积分规则

快速回复 返回顶部 返回列表