之前写了一篇使用Realm的一些总结的文章，然后里面说会总结一下使用Realm+YYModel+AFNetworking进行项目开发的经验，所以这篇就是啦。
想法
第一时间想到的就是市面上最常见的展示类应用，api的话我选择了V2EX社区的api，简单的用了一个获取所有节点的api(v2ex社区api文档看这里)，简单的使用UITableView展示所有的节点。最终效果如下如所示：
Paste_Image.png
开工
准备工作
- 新建项目，使用
Cocoapods管理依赖包，添加AFNetworking，Realm，YYModel这三个库，非常基础的东西不多写了。 - 准备好获取所有节点的api：
http://www.v2ex.com/api/nodes/all.json
封装AFNetworking(以下简称AFN)
由于Realm原生不支持JSON解析，这篇文章也主要是是为了看如果将Realm与YYModel结合使用，但是我还是决定先封装一下HTTP请求。
AFN 3.0之后，网络请求的发起主要依赖AFHTTPSessionManager这个类，我们首先自定义一个单例类SessionManager 继承自AFHTTPSessionManager
#import <AFNetworking/AFNetworking.h>
typedef void(^Success)(id data);
typedef void(^Failure)(NSURLSessionDataTask *task, NSError *error);
@interface SessionManager : AFHTTPSessionManager
+ (instancetype)shareManager;
//为了篇幅限制只在文章中展示get请求
- (NSURLSessionDataTask *)GETWithUrl:(NSString *)url params:(NSDictionary *)params success:(Success)success failure:(Failure)failure;
+ (NSURLSessionDataTask *)GETWithUrl:(NSString *)url params:(NSDictionary *)params success:(Success)success failure:(Failure)failure;
@end
#import "SessionManager.h"
static NSString *const kBaseURL = @"http://www.v2ex.com/api/";
typedef NS_ENUM(NSInteger, APIMethod) {
APIMethodGET,
APIMethodPOST,
APIMethodPUT,
APIMethodDELETE,
};
@implementation SessionManager
+ (instancetype)shareManager {
static SessionManager *manager = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
manager = [[self alloc] init];
});
return manager;
}
- (instancetype)init {
self = [super initWithBaseURL:[NSURL URLWithString:kBaseURL]];
self.requestSerializer = [AFHTTPRequestSerializer serializer];
self.responseSerializer = [AFHTTPResponseSerializer serializer];
self.requestSerializer.timeoutInterval = 30;
return self;
}
//instance method
- (NSURLSessionDataTask *)GETWithUrl:(NSString *)url params:(NSDictionary *)params success:(Success)success failure:(Failure)failure {
return [self requestWithMethod:APIMethodGET url:url params:params success:success failure:failure];
}
//class method
+ (NSURLSessionDataTask *)GETWithUrl:(NSString *)url params:(NSDictionary *)params success:(Success)success failure:(Failure)failure {
return [[self shareManager] GETWithUrl:url params:params success:success failure:failure];
}
- (NSURLSessionDataTask *)requestWithMethod:(APIMethod)method url:(NSString *)url params:(NSDictionary *)params success:(Success)success failure:(Failure)failure {
if (![url hasPrefix:@"http"]) {
url = [[self class] reponseUrl:url];
}
if ([url rangeOfString:@":id"].length > 0 ) {
NSAssert(NO, @"路径 「%@」中有需要替换的id", url);
}
NSURLSessionDataTask *task = nil;
switch (method) {
case APIMethodGET: {
task = [self GET:url parameters:params progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
[self handleTask:task response:responseObject success:success];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
[self handleTask:task error:error failure:failure];
}];
break;
}
//other case
//...
}
return task;
}
+ (NSString *)reponseUrl:(NSString *)url{
NSString *result = url;
result = [NSString stringWithFormat:@"%@\%@", kBaseURL, result];
return result;
}
#pragma mark - handle response
- (void)handleTask:(NSURLSessionDataTask *)task response:(id)responseOject success:(Success)success {
if (success) {
success(responseOject);
}
}
- (void)handleTask:(NSURLSessionDataTask *)task error:(NSError *)error failure:(Failure)failure{
//handle error
}
@end
说明一下：我们的请求manager创建的时候，会基于http://www.v2ex.com/api/这个baseUrl创建，习惯RESTful API的对这个也习以为常了，同时在实例化的时候我们使用了requestSerializer 、responseSerializer，并且设置每次请求超时时长为30秒。
封装API
现在对于AFN的基本封装工作已经完成，接下来只需要搞定每个API了，我们新建一个V2EXAPIManager类继承自刚才的SessionManager，在接口的实现中补全接口：
#import "SessionManager.h"
#import <AFNetworking.h>
#import "Node.h"
@interface V2EXAPIManager : SessionManager
- (NSURLSessionDataTask *)getAllNodeSuccess:(Success)success failurl:(Failure)failure;
@end
#import "V2EXAPIManager.h"
static NSString *allNodelUrl = @"nodes/all.json";
@implementation V2EXAPIManager
- (NSURLSessionDataTask *)getAllNodeSuccess:(Success)success failurl:(Failure)failure {
return [self GETWithUrl:allNodelUrl params:nil success:^(id data) {
NSArray <Node*>*allNodes = [NSArray yy_modelArrayWithClass:[Node class] json:data];
if (success) {
success(allNodes);
}
} failure:^(NSURLSessionDataTask *task, NSError *error) {
if (failure) {
failure(task,error);
}
}];
}
@end
有了BaseUrl，接下来只需要的发起请求的时候，拼接上具体的需要访问服务器的资源，这里是nodes/all.json。
新建可用于持久化的Node模型
通过log我们可以看到，得到的是这样json串，映射到iOS中则是一个包含多个字典的数组。
[
{
"id": 1,
"name": "babel",
"url": "http://www.v2ex.com/go/babel",
"title": "Project Babel",
"title_alternative": "Project Babel",
"topics": 1119,
"header": "Project Babel - 帮助你在云平台上搭建自己的社区",
"footer": "V2EX 基于 Project Babel 驱动。Project Babel 是用 Python 语言写成的，运行于 Google App Engine 云计算平台上的社区软件。Project Babel 当前开发分支 2.5。最新版本可以从 <a href=\"http://github.com/livid/v2ex\" target=\"_blank\">GitHub</a> 获取。",
"created": 1272206882
},
...
...
]
接下来就是根据拿到的数据字段建立我们的Node模型了,在使用Realm的时候需要我们的数据模型继承自RLMObject，同时为了使用YYModel,我们需要遵循<YYModel>协议:
#import <Realm/Realm.h>
#import <YYModel/YYModel.h>
@interface Node : RLMObject<YYModel>
@property NSString *ID;
@property NSString *name;
@property NSString *url;
@property NSString *title;
@property NSString *title_alternative;
@property NSInteger topics;
@property NSString *header;
@property NSString *footer;
@property NSDate *created;
@end
#import "Node.h"
@implementation Node
+ (NSString *)primaryKey {
return @"ID";
}
+ (NSArray<NSString *> *)indexedProperties {
return @[@"ID"];
}
//由于`id`字段会与系统关键字冲突，我们可以手动转换为大写`ID`
+ (NSDictionary<NSString *,id> *)modelCustomPropertyMapper {
return @{@"ID":@"id"};
}
@end
为了方便以后的使用以及提高查询速度，我们使用ID作为主键与索引字段。
这样就可以在请求到数据之后使用
NSArray <Node*>*allNodes = [NSArray yy_modelArrayWithClass:[Node class] json:data];
直接将数据转换为存放节点Node的数组。
在控制器里面发起请求并持久化
- (void)getNodes {
[[V2EXAPIManager shareManager] getAllNodeSuccess:^(id data) {
NSArray *nodes;
if ([data isKindOfClass:[NSArray class]]) {
nodes = data;
}
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
@autoreleasepool {
//delete old data
RLMRealm *realm = [RLMRealm defaultRealm];
[realm beginWriteTransaction];
[realm deleteAllObjects];
[realm commitWriteTransaction];
//add new data
[realm beginWriteTransaction];
for (Node *node in nodes) {
[realm addObject:node];
}
[realm commitWriteTransaction];
//retrieve data and reload data in main thread
dispatch_async(dispatch_get_main_queue(), ^{
RLMRealm *mainThreadRealm = [RLMRealm defaultRealm];
self.nodes = [Node allObjectsInRealm:mainThreadRealm];
[self.tableview reloadData];
});
}
});
} failurl:^(NSURLSessionDataTask *task, NSError *error) {
self.nodes = [Node allObjects];
[self.tableview reloadData];
}];
}
其他将数据渲染到UI上的一些代码就不往上贴了，当然，本例也是非的简陋，例如封装请求的错误处理也没有做，也没有多余的UI设计，不过我们可以看到，使用Realm+YYModel完成一个从远程请求数据并在本地持久化的需求非常简单，关键代码甚至没有几行。
你可以在GitHub直接clone这个Repository
