zoukankan      html  css  js  c++  java
  • iOS应用本地缓存

    转自http://mobile.51cto.com/iphone-314382.htm

    在手机应用程序开发中,为了减少与服务端的交互次数,加快用户的响应速度,一般都会在iOS设备中加一个缓存的机制.

    功能需求

    这个缓存机制满足下面这些功能。

    1、可以将数据缓存到本地磁盘。

    2、可以判断一个资源是否已经被缓存。如果已经被缓存,在请求相同的资源,先到本地磁盘搜索。

    3、可以判断文件缓存什么时候过期。这里为了简单起见这里,我们在请求url资源的时候,给每次请求的文件设定一个过期的时间。

    4、可以实现:如果文件已经被缓存,而且没有过期,这将本地的数据返回,否则重新请求url。

    5、可以实现:如果文件下载不成功或者下载没有完成,下次打开程序的时候,移除这些没有成功或者没有下载完成的文件。

    6、可以实现:同时请求或者下载多个资源。

    设计实现

    1、设计一个CacheItem类,用来请求一个web连接,它的一个实例表示一个缓存项。这个CacheItem类,需要一个url创建一个NSURLConnection,去请求web资源。使用CacheItem类主要用来请求web资源。

    1. /* ---------缓存项-------------- */   
    2.  
    3. @interface CacheItem : NSObject {   
    4. @public   
    5.   id<CacheItemDelegate> delegate;   
    6.     //web地址   
    7.   NSString              *remoteURL;   
    8. @private   
    9.     //是否正在下载   
    10.   BOOL                  isDownloading;   
    11.        //NSMutableData对象   
    12.   NSMutableData         *connectionData;   
    13.    //NSURLConnection对象   
    14.   NSURLConnection       *connection;   
    15. }   
    16.  
    17. /* -------------------------- */   
    18.  
    19. @property (nonatomic, retain) id<CacheItemDelegate> 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;   
    24.  
    25. /* ----------开始下载方法----------- */   
    26.  
    27. - (BOOL) startDownloadingURL:(NSString *)paramRemoteURL;   
    28.  
    29. @end   

    2、在NSURLConnection开始请求之前,调用CachedDownloadManager类,来搜索和管理本地的缓存文件。将缓存文件的情况保存到一个字典类中。这个字典设计如下:

    1. {   
    2.  
    3.   "http://www.cnn.com" =     {   
    4.  
    5.     DownloadEndDate = "2011-08-02 07:51:57 +0100";   
    6.  
    7.     DownloadStartDate = "2011-08-02 07:51:55 +0100";   
    8.  
    9.     ExpiresInSeconds = 20;   
    10.  
    11.     ExpiryDate = "2011-08-02 07:52:17 +0100";   
    12.  
    13.     LocalURL = "/var/mobile/Applications/ApplicationID/Documents/   
    14.  
    15.                 httpwww.cnn.com.cache";   
    16.  
    17.   };   
    18.  
    19.   "http://www.baidu.com" =     {   
    20.  
    21.     DownloadEndDate = "2011-08-02 07:51:49 +0100";   
    22.  
    23.     DownloadStartDate = "2011-08-02 07:51:44 +0100";   
    24.  
    25.     ExpiresInSeconds = 20;   
    26.  
    27.     ExpiryDate = "2011-08-02 07:52:09 +0100";   
    28.  
    29.     LocalURL = "/var/mobile/Applications/ApplicationID/Documents/   
    30.  
    31.                 httpwww.oreilly.com.cache";   
    32.  
    33.   };   
    34.  
    35. }   

    上面这个字典里面嵌套了字典。里面那层字典表示一个缓存项的缓存信息:下载结束时间、下载开始时间、缓存有效时间、缓存过期时间、缓存到本地的路径。

    下面看下CachedDownloadManager类。用它来实现和封装我们的缓存策略。

    1. /* -----------CachedDownloadManager-------------- */ 
    2.  
    3. @interface CachedDownloadManager : NSObject 
    4.  
    5.  
    6. @public 
    7.  
    8. id delegate; 
    9.  
    10. @private 
    11.  
    12. //记录缓存数据的字典 
    13.  
    14. NSMutableDictionary *cacheDictionary; 
    15.  
    16. //缓存的路径 
    17.  
    18. NSString *cacheDictionaryPath; 
    19.  
    20.  
    21. @property (nonatomic, assign) 
    22.  
    23. id delegate; 
    24.  
    25. @property (nonatomic, copy) 
    26.  
    27. NSMutableDictionary *cacheDictionary; 
    28.  
    29. @property (nonatomic, retain) 
    30.  
    31. NSString *cacheDictionaryPath; 
    32.  
    33. /* 保持缓存字典 */ 
    34.  
    35. - (BOOL) saveCacheDictionary; 
    36.  
    37. /* 公有方法:下载 */ 
    38.  
    39. - (BOOL) download:(NSString *)paramURLAsString 
    40.  
    41. urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds 
    42.  
    43. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache; 
    44.  
    45. /* -------------------------- */ 
    46.  
    47. @end 
    48.  

    从上面代码可以看出,这个管理缓存的类中,有一个缓存字典:cacheDictionary,用来表示所有资源的缓存情况;cacheDictionaryPath用来表示缓存的路径;saveCacheDictionary用来将缓存字典归档到本地文件中。download:urlMustExpireInSeconds:updateExpiryDateIfInCache是一个公共接口,通过传递url、缓存过期时间、是否更新缓存过期时间三个参数来方便的使用,实现我们的缓存策略。

    3、如果这个文件已经被下载,而且没有过期,则从本地获取文件的数据。如果文件已经过期,则重新下载。我们通过download:urlMustExpireInSeconds:updateExpiryDateIfInCache方法来实现,主要看这个方法的代码:

    1. /* ---------下载-------------- */ 
    2.  
    3. - (BOOL) download:(NSString *)paramURLAsString 
    4.  
    5. urlMustExpireInSeconds:(NSTimeInterval)paramURLMustExpireInSeconds 
    6.  
    7. updateExpiryDateIfInCache:(BOOL)paramUpdateExpiryDateIfInCache{ 
    8.  
    9. BOOL result = NO
    10.  
    11. if (self.cacheDictionary == nil || 
    12.  
    13. [paramURLAsString length] == 0){ 
    14.  
    15. return(NO); 
    16.  
    17.  
    18. paramURLAsString = [paramURLAsString lowercaseString]; 
    19.  
    20. //根据url,从字典中获取缓存项的相关数据 
    21.  
    22. NSMutableDictionary *itemDictionary = 
    23.  
    24. [self.cacheDictionary objectForKey:paramURLAsString]; 
    25.  
    26. /* 使用下面这些变量帮助我们理解缓存逻辑 */ 
    27.  
    28. //文件是否已经被缓存 
    29.  
    30. BOOL fileHasBeenCached = NO
    31.  
    32. //缓存是否过期 
    33.  
    34. BOOL cachedFileHasExpired = NO
    35.  
    36. //缓存文件是否存在 
    37.  
    38. BOOL cachedFileExists = NO
    39.  
    40. //缓存文件能否被加载 
    41.  
    42. BOOL cachedFileDataCanBeLoaded = NO
    43.  
    44. //缓存文件数据 
    45.  
    46. NSData *cachedFileData = nil
    47.  
    48. //缓存文件是否完全下载 
    49.  
    50. BOOL cachedFileIsFullyDownloaded = NO
    51.  
    52. //缓存文件是否已经下载 
    53.  
    54. BOOL cachedFileIsBeingDownloaded = NO
    55.  
    56. //过期时间 
    57.  
    58. NSDate *expiryDate = nil
    59.  
    60. //下载结束时间 
    61.  
    62. NSDate *downloadEndDate = nil
    63.  
    64. //下载开始时间 
    65.  
    66. NSDate *downloadStartDate = nil
    67.  
    68. //本地缓存路径 
    69.  
    70. NSString *localURL = nil
    71.  
    72. //有效时间 
    73.  
    74. NSNumber *expiresInSeconds = nil
    75.  
    76. NSDate *now = [NSDate date]; 
    77.  
    78. if (itemDictionary != nil){ 
    79.  
    80. fileHasBeenCached = YES
    81.  
    82.  
    83. //如果文件已经被缓存,则从缓存项相关数据中获取相关的值 
    84.  
    85. if (fileHasBeenCached == YES){ 
    86.  
    87. expiryDate = [itemDictionary 
    88.  
    89. objectForKey:CachedKeyExpiryDate]; 
    90.  
    91. downloadEndDate = [itemDictionary 
    92.  
    93. objectForKey:CachedKeyDownloadEndDate]; 
    94.  
    95. downloadStartDate = [itemDictionary 
    96.  
    97. objectForKey:CachedKeyDownloadStartDate]; 
    98.  
    99. localURL = [itemDictionary 
    100.  
    101. objectForKey:CachedKeyLocalURL]; 
    102.  
    103. expiresInSeconds = [itemDictionary 
    104.  
    105. objectForKey:CachedKeyExpiresInSeconds]; 
    106.  
    107. //如果下载开始和结束时间不为空,表示文件全部被下载 
    108.  
    109. if (downloadEndDate != nil && 
    110.  
    111. downloadStartDate != nil){ 
    112.  
    113. cachedFileIsFullyDownloaded = YES
    114.  
    115.  
    116. /* 如果expiresInSeconds不为空,downloadEndDate为空,表示文件已经正在下载 */ 
    117.  
    118. if (expiresInSeconds != nil && 
    119.  
    120. downloadEndDate == nil){ 
    121.  
    122. cachedFileIsBeingDownloaded = YES
    123.  
    124.  
    125. /* 判断缓存是否过期 */ 
    126.  
    127. if (expiryDate != nil && 
    128.  
    129. [now timeIntervalSinceDate:expiryDate] > 0.0){ 
    130.  
    131. cachedFileHasExpired = YES
    132.  
    133.  
    134. if (cachedFileHasExpired == NO){ 
    135.  
    136. /* 如果缓存文件没有过期,加载缓存文件,并且更新过期时间 */ 
    137.  
    138. NSFileManager *fileManager = [[NSFileManager alloc] init]; 
    139.  
    140. if ([fileManager fileExistsAtPath:localURL] == YES){ 
    141.  
    142. cachedFileExists = YES
    143.  
    144. cachedFileData = [NSData dataWithContentsOfFile:localURL]; 
    145.  
    146. if (cachedFileData != nil){ 
    147.  
    148. cachedFileDataCanBeLoaded = YES
    149.  
    150. } /* if (cachedFileData != nil){ */ 
    151.  
    152. } /* if ([fileManager fileExistsAtPath:localURL] == YES){ */ 
    153.  
    154. [fileManager release]; 
    155.  
    156. /* 更新缓存时间 */ 
    157.  
    158. if (paramUpdateExpiryDateIfInCache == YES){ 
    159.  
    160. NSDate *newExpiryDate = 
    161.  
    162. [NSDate dateWithTimeIntervalSinceNow: 
    163.  
    164. paramURLMustExpireInSeconds]; 
    165.  
    166. NSLog(@"Updating the expiry date from %@ to %@.", 
    167.  
    168. expiryDate, 
    169.  
    170. newExpiryDate); 
    171.  
    172. [itemDictionary setObject:newExpiryDate 
    173.  
    174. forKey:CachedKeyExpiryDate]; 
    175.  
    176. NSNumber *expires = 
    177.  
    178. [NSNumber numberWithFloat:paramURLMustExpireInSeconds]; 
    179.  
    180. [itemDictionary setObject:expires 
    181.  
    182. forKey:CachedKeyExpiresInSeconds]; 
    183.  
    184.  
    185. } /* if (cachedFileHasExpired == NO){ */ 
    186.  
    187.  
    188. if (cachedFileIsBeingDownloaded == YES){ 
    189.  
    190. NSLog(@"这个文件已经正在下载..."); 
    191.  
    192. return(YES); 
    193.  
    194.  
    195. if (fileHasBeenCached == YES){ 
    196.  
    197. if (cachedFileHasExpired == NO && 
    198.  
    199. cachedFileExists == YES && 
    200.  
    201. cachedFileDataCanBeLoaded == YES && 
    202.  
    203. [cachedFileData length] > 0 && 
    204.  
    205. cachedFileIsFullyDownloaded == YES){ 
    206.  
    207. /* 如果文件有缓存而且没有过期 */ 
    208.  
    209. NSLog(@"文件有缓存而且没有过期."); 
    210.  
    211. [self.delegate 
    212.  
    213. cachedDownloadManagerSucceeded:self 
    214.  
    215. remoteURL:[NSURL URLWithString:paramURLAsString] 
    216.  
    217. localURL:[NSURL URLWithString:localURL] 
    218.  
    219. aboutToBeReleasedData:cachedFileData 
    220.  
    221. isCachedData:YES]; 
    222.  
    223. return(YES); 
    224.  
    225. } else { 
    226.  
    227. /* 如果文件没有被缓存,获取缓存失败 */ 
    228.  
    229. NSLog(@"文件没有缓存."); 
    230.  
    231. [self.cacheDictionary removeObjectForKey:paramURLAsString]; 
    232.  
    233. [self saveCacheDictionary]; 
    234.  
    235. } /* if (cachedFileHasExpired == NO && */ 
    236.  
    237. } /* if (fileHasBeenCached == YES){ */ 
    238.  
    239. /* 去下载文件 */ 
    240.  
    241. NSNumber *expires = 
    242.  
    243. [NSNumber numberWithFloat:paramURLMustExpireInSeconds]; 
    244.  
    245. NSMutableDictionary *newDictionary = 
    246.  
    247. [[[NSMutableDictionary alloc] init] autorelease]; 
    248.  
    249. [newDictionary setObject:expires 
    250.  
    251. forKey:CachedKeyExpiresInSeconds]; 
    252.  
    253. localURL = [paramURLAsString 
    254.  
    255. stringByAddingPercentEscapesUsingEncoding: 
    256.  
    257. NSUTF8StringEncoding]; 
    258.  
    259. localURL = [localURL stringByReplacingOccurrencesOfString:@"://" 
    260.  
    261. withString:@""]; 
    262.  
    263. localURL = [localURL stringByReplacingOccurrencesOfString:@"/" 
    264.  
    265. withString:@"{1}quot;]; 
    266.  
    267. localURL = [localURL stringByAppendingPathExtension:@"cache"]; 
    268.  
    269. NSString *documentsDirectory = 
    270.  
    271. [self documentsDirectoryWithTrailingSlash:NO]; 
    272.  
    273. localURL = [documentsDirectory 
    274.  
    275. stringByAppendingPathComponent:localURL]; 
    276.  
    277. [newDictionary setObject:localURL 
    278.  
    279. forKey:CachedKeyLocalURL]; 
    280.  
    281. [newDictionary setObject:now 
    282.  
    283. forKey:CachedKeyDownloadStartDate]; 
    284.  
    285. [self.cacheDictionary setObject:newDictionary 
    286.  
    287. forKey:paramURLAsString]; 
    288.  
    289. [self saveCacheDictionary]; 
    290.  
    291. CacheItem *item = [[[CacheItem alloc] init] autorelease]; 
    292.  
    293. [item setDelegate:self]; 
    294.  
    295. [item startDownloadingURL:paramURLAsString]; 
    296.  
    297. return(result); 
    298.  
    299.  

    4、下面我们设计缓存项下载成功和失败的两个委托方法:

    1. @protocol CacheItemDelegate <NSObject>   
    2.  
    3. //下载成功执行该方法   
    4.  
    5. - (void) cacheItemDelegateSucceeded   
    6.  
    7.   :(CacheItem *)paramSender   
    8.  
    9.   withRemoteURL:(NSURL *)paramRemoteURL   
    10.  
    11.   withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData;   
    12.  
    13. //下载失败执行该方法   
    14.  
    15. - (void) cacheItemDelegateFailed   
    16.  
    17.   :(CacheItem *)paramSender   
    18.  
    19.   remoteURL:(NSURL *)paramRemoteURL   
    20.  
    21.   withError:(NSError *)paramError;  
    22.  
    23. @end   

    当我们下载成功的时候,修改缓存字典中的下载时间,表示已经下载完成,而且需要将请求的资源数据缓存到本地:

    1. //缓存项的委托方法 
    2.  
    3. - (void) cacheItemDelegateSucceeded:(CacheItem *)paramSender 
    4.  
    5. withRemoteURL:(NSURL *)paramRemoteURL 
    6.  
    7. withAboutToBeReleasedData:(NSData *)paramAboutToBeReleasedData{ 
    8.  
    9. //从缓存字典中获取该缓存项的相关数据 
    10.  
    11. NSMutableDictionary *dictionary = 
    12.  
    13. [self.cacheDictionary objectForKey:[paramRemoteURL absoluteString]]; 
    14.  
    15. //取当前时间 
    16.  
    17. NSDate *now = [NSDate date]; 
    18.  
    19. //获取有效时间 
    20.  
    21. NSNumber *expiresInSeconds = [dictionary 
    22.  
    23. objectForKey:CachedKeyExpiresInSeconds]; 
    24.  
    25. //转换成NSTimeInterval 
    26.  
    27. NSTimeInterval expirySeconds = [expiresInSeconds floatValue]; 
    28.  
    29. //修改字典中缓存项的下载结束时间 
    30.  
    31. [dictionary setObject:[NSDate date] 
    32.  
    33. forKey:CachedKeyDownloadEndDate]; 
    34.  
    35. //修改字典中缓存项的缓存过期时间 
    36.  
    37. [dictionary setObject:[now dateByAddingTimeInterval:expirySeconds] 
    38.  
    39. forKey:CachedKeyExpiryDate]; 
    40.  
    41. //保存缓存字典 
    42.  
    43. [self saveCacheDictionary]; 
    44.  
    45. NSString *localURL = [dictionary objectForKey:CachedKeyLocalURL]; 
    46.  
    47. /* 将下载的数据保持到磁盘 */ 
    48.  
    49. if ([paramAboutToBeReleasedData writeToFile:localURL 
    50.  
    51. atomically:YES] == YES){ 
    52.  
    53. NSLog(@"缓存文件到磁盘成功."); 
    54.  
    55. } else{ 
    56.  
    57. NSLog(@"缓存文件到磁盘失败."); 
    58.  
    59.  
    60. //执行缓存管理的委托方法 
    61.  
    62. [self.delegate 
    63.  
    64. cachedDownloadManagerSucceeded:self 
    65.  
    66. remoteURL:paramRemoteURL 
    67.  
    68. localURL:[NSURL URLWithString:localURL] 
    69.  
    70. aboutToBeReleasedData:paramAboutToBeReleasedData 
    71.  
    72. isCachedData:NO]; 
    73.  
    74.  

    如果下载失败我们需要从缓存字典中移除改缓存项:

    1. //缓存项失败失败的委托方法 
    2.  
    3. - (void) cacheItemDelegateFailed:(CacheItem *)paramSender 
    4.  
    5. remoteURL:(NSURL *)paramRemoteURL 
    6.  
    7. withError:(NSError *)paramError{ 
    8.  
    9. /* 从缓存字典中移除缓存项,并发送一个委托 */ 
    10.  
    11. if (self.delegate != nil){ 
    12.  
    13. NSMutableDictionary *dictionary = 
    14.  
    15. [self.cacheDictionary 
    16.  
    17. objectForKey:[paramRemoteURL absoluteString]]; 
    18.  
    19. NSString *localURL = [dictionary 
    20.  
    21. objectForKey:CachedKeyLocalURL]; 
    22.  
    23. [self.delegate 
    24.  
    25. cachedDownloadManagerFailed:self 
    26.  
    27. remoteURL:paramRemoteURL 
    28.  
    29. localURL:[NSURL URLWithString:localURL] 
    30.  
    31. withError:paramError]; 
    32.  
    33.  
    34. [self.cacheDictionary 
    35.  
    36. removeObjectForKey:[paramRemoteURL absoluteString]]; 
    37.  
    38.  

    5、加载缓存字典的时候,我们可以将没有下载完成的文件移除:

    1. //初始化缓存字典 
    2.  
    3. NSString *documentsDirectory = 
    4.  
    5. [self documentsDirectoryWithTrailingSlash:YES]; 
    6.  
    7. //生产缓存字典的路径 
    8.  
    9. cacheDictionaryPath = 
    10.  
    11. [[documentsDirectory 
    12.  
    13. stringByAppendingString:@"CachedDownloads.dic"] retain]; 
    14.  
    15. //创建一个NSFileManager实例 
    16.  
    17. NSFileManager *fileManager = [[NSFileManager alloc] init]; 
    18.  
    19. //判断是否存在缓存字典的数据 
    20.  
    21. if ([fileManager 
    22.  
    23. fileExistsAtPath:self.cacheDictionaryPath] == YES){ 
    24.  
    25. NSLog(self.cacheDictionaryPath); 
    26.  
    27. //加载缓存字典中的数据 
    28.  
    29. NSMutableDictionary *dictionary = 
    30.  
    31. [[NSMutableDictionary alloc] 
    32.  
    33. initWithContentsOfFile:self.cacheDictionaryPath]; 
    34.  
    35. cacheDictionary = [dictionary mutableCopy]; 
    36.  
    37. [dictionary release]; 
    38.  
    39. //移除没有下载完成的缓存数据 
    40.  
    41. [self removeCorruptedCachedItems]; 
    42.  
    43. } else { 
    44.  
    45. //创建一个新的缓存字典 
    46.  
    47. NSMutableDictionary *dictionary = 
    48.  
    49. [[NSMutableDictionary alloc] init]; 
    50.  
    51. cacheDictionary = [dictionary mutableCopy]; 
    52.  
    53. [dictionary release]; 
    54.  
    55.  

    这样就基本上完成了我们需要的功能,下面看看我们如何使用我们设计的缓存功能。

    例子场景

    我们用一个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应用程序本地缓存的方案。

  • 相关阅读:
    跟layout_weight说88,轻松搞定百分比布局
    跟闪退、程序崩溃说88
    程序的需求层次
    开博
    第十章 数组与集合 发牌程序 实例代码
    C#面向对象基础01
    winform form
    html
    C#语言基础02
    C#语言基础01
  • 原文地址:https://www.cnblogs.com/jiangshiyong/p/2845346.html
Copyright © 2011-2022 走看看