
作者:shelin(投稿)。
一直想總結一下 iOS 離線數據緩存的思路,最近也重新封裝了 AFN,索性把兩件事放在一起寫。展示型頁面做離線緩存能明顯改善體驗——用戶在無網環境下依然能看到內容。緩存方案首選 SQLite:輕量,讀寫性能相對其他存儲方式更有優勢。
而網絡層封裝的目的並不是堆業務邏輯,而是把常用方法收攏、降低工程對第三方的耦合,讓底層請求庫能夠被快速替換。本文重點講緩存思路,網絡層只做簡要介紹。
主要能力包括:
/** 請求成功 */ typedef void (^requestSuccessBlock)(id responseObj); /** 請求失敗 */ typedef void (^requestFailureBlock) (NSError *error); /** 請求響應 */ typedef void (^responseBlock)(id dataObj, NSError *error); /** 監聽進度 */ typedef void (^progressBlock)(int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite);
GET 請求的核心實現:
+ (void)getRequest:(NSString *)url params:(NSDictionary *)params success:(requestSuccessBlock)successHandler failure:(requestFailureBlock)failureHandler {
// 網絡不可用
if (![self checkNetworkStatus]) {
successHandler(nil);
failureHandler(nil);
return;
}
AFHTTPRequestOperationManager *manager = [self getRequstManager];
[manager GET:url parameters:params success:^(AFHTTPRequestOperation * _Nonnull operation, id _Nonnull responseObject) {
successHandler(responseObject);
} failure:^(AFHTTPRequestOperation * _Nullable operation, NSError * _Nonnull error) {
XLLog(@"------請求失敗-------%@", error);
failureHandler(error);
}];
}下載並監聽進度:
+ (void)downloadRequest:(NSString *)url successAndProgress:(progressBlock)progressHandler complete:(responseBlock)completionHandler {
if (![self checkNetworkStatus]) {
progressHandler(0, 0, 0);
completionHandler(nil, nil);
return;
}
NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:sessionConfiguration];
NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:url]];
NSProgress *kProgress = nil;
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:&kProgress destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
NSURL *documentUrl = [[NSFileManager defaultManager] URLForDirectory:NSDocumentDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:NO error:nil];
return [documentUrl URLByAppendingPathComponent:[response suggestedFilename]];
} completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nonnull filePath, NSError * _Nonnull error){
if (error) {
XLLog(@"------下載失敗-------%@", error);
}
completionHandler(response, error);
}];
[manager setDownloadTaskDidWriteDataBlock:^(NSURLSession * _Nonnull session, NSURLSessionDownloadTask * _Nonnull downloadTask, int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite) {
progressHandler(bytesWritten, totalBytesWritten, totalBytesExpectedToWrite);
}];
[downloadTask resume];
}上傳並監聽進度:
+ (void)updateRequest:(NSString *)url params:(NSDictionary *)params fileConfig:(XLFileConfig *)fileConfig successAndProgress:(progressBlock)progressHandler complete:(responseBlock)completionHandler {
if (![self checkNetworkStatus]) {
progressHandler(0, 0, 0);
completionHandler(nil, nil);
return;
}
NSMutableURLRequest *request = [[AFHTTPRequestSerializer serializer] multipartFormRequestWithMethod:@"POST" URLString:url parameters:params constructingBodyWithBlock:^(id _Nonnull formData) {
[formData appendPartWithFileData:fileConfig.fileData name:fileConfig.name fileName:fileConfig.fileName mimeType:fileConfig.mimeType];
} error:nil];
AFHTTPRequestOperation *operation = [[AFHTTPRequestOperation alloc] initWithRequest:request];
[operation setUploadProgressBlock:^(NSUInteger bytesWritten, long long totalBytesWritten, long long totalBytesExpectedToWrite) {
progressHandler(bytesWritten, totalBytesWritten, totalBytesExpectedToWrite);
}];
[operation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation * _Nonnull operation, id _Nonnull responseObject) {
completionHandler(responseObject, nil);
} failure:^(AFHTTPRequestOperation * _Nonnull operation, NSError * _Nonnull error) {
completionHandler(nil, error);
if (error) { XLLog(@"------上傳失敗-------%@", error); }
}];
[operation start];
}XLDataService 把「請求 + 轉模型」串起來:
+ (void)getWithUrl:(NSString *)url param:(id)param modelClass:(Class)modelClass responseBlock:(responseBlock)responseDataBlock {
[XLNetworkRequest getRequest:url params:param success:^(id responseObj) {
// 數組、字典轉化為模型數組
dataObj = [self modelTransformationWithResponseObj:responseObj modelClass:modelClass];
responseDataBlock(dataObj, nil);
} failure:^(NSError *error) {
responseDataBlock(nil, error);
}];
}而 modelTransformationWithResponseObj:modelClass: 留給子類覆寫,相似的業務只需繼承一個子類,就能直接拿到模型數組:
/** 數組、字典轉化為模型 */
+ (id)modelTransformationWithResponseObj:(id)responseObj modelClass:(Class)modelClass {
return nil;
}進入展示頁面時,有三種情況會涉及數據庫讀寫:
1. 進入頁面

2. 下拉刷新

3. 上拉加載更多

兩個關鍵細節:
其一,上拉加載時每次只從數據庫取固定數量,不要一次性全量加載,否則內存會出問題;直到數據庫中沒有更多數據,才發起網絡請求並把新數據落庫。
其二,存儲方式上,把服務器返回的每組數據字典直接歸檔為二進制存入字段,而不是為每個屬性建一列。模型屬性多的時候,這種做法維護成本明顯更低。另外增加一個 idStr 字段用於判斷唯一性,避免重複存儲。
底層使用 FMDB:
#import "XLDataBase.h"
#import "FMDatabase.h"
#import "Item.h"
#import "MJExtension.h"
@implementation XLDataBase
static FMDatabase *_db;
+ (void)initialize {
NSString *path = [NSString stringWithFormat:@"%@/Library/Caches/Data.db", NSHomeDirectory()];
_db = [FMDatabase databaseWithPath:path];
[_db open];
[_db executeUpdate:@"CREATE TABLE IF NOT EXISTS t_item (id integer PRIMARY KEY, itemDict blob NOT NULL, idStr text NOT NULL)"];
}
// 存入數據庫
+ (void)saveItemDict:(NSDictionary *)itemDict {
// 字典歸檔為二進制直接存,避免建立過多字段
NSData *dictData = [NSKeyedArchiver archivedDataWithRootObject:itemDict];
[_db executeUpdateWithFormat:@"INSERT INTO t_item (itemDict, idStr) VALUES (%@, %@)", dictData, itemDict[@"id"]];
}
// 返回全部數據
+ (NSArray *)list {
FMResultSet *set = [_db executeQuery:@"SELECT * FROM t_item"];
NSMutableArray *list = [NSMutableArray array];
while (set.next) {
NSData *dictData = [set objectForColumnName:@"itemDict"];
NSDictionary *dict = [NSKeyedUnarchiver unarchiveObjectWithData:dictData];
[list addObject:[Item mj_objectWithKeyValues:dict]];
}
return list;
}
// 取出指定范圍內的數據
+ (NSArray *)listWithRange:(NSRange)range {
NSString *SQL = [NSString stringWithFormat:@"SELECT * FROM t_item LIMIT %lu, %lu", range.location, range.length];
FMResultSet *set = [_db executeQuery:SQL];
NSMutableArray *list = [NSMutableArray array];
while (set.next) {
NSData *dictData = [set objectForColumnName:@"itemDict"];
NSDictionary *dict = [NSKeyedUnarchiver unarchiveObjectWithData:dictData];
[list addObject:[Item mj_objectWithKeyValues:dict]];
}
return list;
}
// 判斷數據是否已存在
+ (BOOL)isExistWithId:(NSString *)idStr {
BOOL isExist = NO;
FMResultSet *resultSet = [_db executeQuery:@"SELECT * FROM t_item where idStr = ?", idStr];
while ([resultSet next]) {
isExist = [resultSet stringForColumn:@"idStr"] ? YES : NO;
}
return isExist;
}
@end業務子類覆寫模型轉換,並順手完成落庫:
#import "GetTableViewData.h"
#import "XLDataBase.h"
@implementation GetTableViewData
+ (id)modelTransformationWithResponseObj:(id)responseObj modelClass:(Class)modelClass {
NSArray *lists = responseObj[@"data"][@"list"];
NSMutableArray *array = [NSMutableArray array];
for (NSDictionary *dict in lists) {
[modelClass mj_setupReplacedKeyFromPropertyName:^NSDictionary *{
return @{ @"ID" : @"id" };
}];
[array addObject:[modelClass mj_objectWithKeyValues:dict]];
// 通過 idStr 判斷是否存儲過,沒有則寫入數據庫
if (![XLDataBase isExistWithId:dict[@"id"]]) {
NSLog(@"存入數據庫");
[XLDataBase saveItemDict:dict];
}
}
return array;
}
@end控制器側的讀寫流程:
#define URL_TABLEVIEW @"https://api.108tian.com/mobile/v3/EventList?cityId=1&step=10&theme=0&page=%lu"
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
NSRange range = NSMakeRange(0, 10);
// 數據庫有數據則直接讀取,不發請求
if ([[XLDataBase listWithRange:range] count]) {
[_dataArray addObjectsFromArray:[XLDataBase listWithRange:range]];
NSLog(@"從數據庫加載");
} else {
[self getTableViewDataWithPage:0];
}
}
- (void)loadMoreData {
NSLog(@"上拉加載");
_currentPage++;
NSRange range = NSMakeRange(_currentPage * 10, 10);
if ([[XLDataBase listWithRange:range] count]) {
[_dataArray addObjectsFromArray:[XLDataBase listWithRange:range]];
[_tableView reloadData];
[_tableView.mj_footer endRefreshing];
} else {
// 數據庫沒有更多數據時才發網絡請求
[self getTableViewDataWithPage:_currentPage];
}
}完整的下拉刷新、上拉加載與 MJRefresh 集成請參照源碼。
代碼下載地址:https://github.com/ShelinShelin/OffLineCache.git
關鍵部分均有註釋與日誌打印,直接運行就能直觀看到緩存命中與網絡請求的切換。歡迎交流指正。