ReactiveCocoa实战: 模仿 “花瓣”,重写 LeanCloud Rest Api的iOS REST Client.

图片 1

      对.py文件援助右键用UlGALAXY Tab打开情势辅助:

霎时同不良我们将要研商的是动开被比首要的如出一辙缠绕–网络要的封装.鉴于民用经验少,本文将当定水准及参考
基于AFNetworking2.0和ReactiveCocoa2.1的iOS REST
Client
,来以LeanCloudRest
Api
来练手.前少节省的示范,大家都是选择自定义之PHP接口来作为测试服务器,不过真实的服务器接口是关乎到无数细节的,比如一个骨干的权能决定机制,用户登录上等.为了可以重新实在快捷的开头网络要求类的重构,本节选拔一个境内相比常用的后端开发平台LeanCloud.
本文将贯彻一个颇具真正数据的博客App的Demo,数据源取自博客主站:ios122.com.

  1.打开注册表(win+R,运行约输入regedit)

一体化代码示例下载: github

  2.先对*.py文件举办设置。找到注册表目录HKEY_CLASSES_ROOT\Python.File\shell,在shell文件夹图标上沾左侧键→新建→项,对新项举办命名,这里命啊叫
        字,在右键将会合来得什么名字,比如自己的是“Edit with Ul华为平板”。

将WP导出的XML数据易成JSON文件,导入LeanCloud.

第一,你是必然使优先夺她官网注册一个账号,然后上加一个应用.这是我是填补加了利用iOS122.然后新建一个名叫也Post的Class,字段信息如下:

图片 2

iOS122是一个wordpress搭建的博客站点,导出的章为xml格式,需要处理成
LeanCloud
需要的JSON格式才可以导入,主站作品未多,几十篇,一个一个手动输,也是得的.我用试行着形容一粗截代码,来自动解析wp导出的文本,并依据需要转移对应之
JSON 文件.感兴趣的,可以友善尝试着干下!

/* 要实现的逻辑很简单: 
 1.读取XML文件;
 2.解析为JSON,并显示;
 3.将JSON输出为json文件.*/

/* 1.读取并解析XML. */
NSMutableArray * jsonArray = [NSMutableArray arrayWithCapacity: 42];

NSString *XMLFilePath = [[NSBundle mainBundle] pathForResource:@"Post" ofType:@"xml"];
ONOXMLDocument *document = [ONOXMLDocument XMLDocumentWithData:[NSData dataWithContentsOfFile:XMLFilePath] error: NULL];

NSString *XPath = @"//channel/item";

[document enumerateElementsWithXPath:XPath usingBlock:^(ONOXMLElement *element, __unused NSUInteger idx, __unused BOOL *stop) {
    ONOXMLElement * titleElement = [element firstChildWithTag:@"title"];
    ONOXMLElement * descElement = [element firstChildWithTag: @"encoded" inNamespace: @"excerpt"];
    ONOXMLElement * contentElement = [element firstChildWithTag: @"encoded" inNamespace:@"content"];

    NSDictionary * jsonDict = @{
                                @"title": [titleElement stringValue],
                                @"desc": [descElement stringValue],
                                @"body": [contentElement stringValue]};

    [jsonArray addObject: jsonDict];
}];

/* 2.显示JSON字符串. */
NSData * jsonData = [NSJSONSerialization dataWithJSONObject:jsonArray
                                                   options:NSJSONWritingPrettyPrinted
                                                     error:NULL];

NSString * jsonString = [[NSString alloc] initWithData:jsonData
                                             encoding:NSUTF8StringEncoding];

self.textView.text = jsonString;

/*3.存储到文件中.
 真机下,暂无法找到Documents目录下的东西,可以通过模拟器运行此段代码,并通过finder-->前往文件夹,输入此处jsonPath对应的文件路径来获取 Post.json 文件.
 */
NSArray *paths=NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString * path=[paths objectAtIndex:0];
NSString * jsonPath=[path stringByAppendingPathComponent:@"Post.json"];

[jsonData writeToFile: jsonPath atomically:YES];
  • 导入后,LeanCloud控制台突显是如此的:

图片 3

  3.以“Edit with
Ul三星GALAXY Tab”上承接触右键新建起,项名为“command”,点command,左边出现一个“默认”,后边的数额是空的,现在便是于这边充足数据。  

模仿 “花瓣”,重写 LeanCloud Rest Api的iOS REST Client.

紧接下去的仿,思路及拿于相当怪程度上参考
@limboy的稿子,可是会相对更加完整.其余,其实 LeanCloud
其实是暴发友好之iOS
API的,不过是一个架空的包装,和骨子里运用中应用的大网要API有至极怪不同.两种方法的出入,有接触类似于是下
字典等主导类型存储数据,依旧利用
自定义之Model来储存数据.星星栽方法,可是大多置评,个人倾向于晚一样种,方便后续的代码重构.

// TODO:Models Group包含了所有和服务端API对应之Model,比如HBPComment

  4.双击“默认”弹来辑对话框,复制以下字符:

主题构造

用时,直接引用 YFAPI.h 即可,里面含有了有的Class:

|- YFAPI.h
|- Classes
    |- YFAPIManager.h
    |- YFAPIManager.m
    |- Models
        |- YFPostModel.h
        |- YFPostModel.h
           ...

YFAPIManager包含了所有的和服务端通信的不二法门,通过Category来区别:

//
//  YFAPIManager.h
//  iOS122
//
//  Created by 颜风 on 15/10/28.
//  Copyright © 2015年 iOS122. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <AFNetworking.h>

@class RACSignal, YFUserModel;

@interface YFAPIManager : AFHTTPRequestOperationManager

@property (nonatomic, nonatomic) YFUserModel * user; //!< 当前登录的用户,可能为nil.


/**
 *  一个单例.
 *
 *  @return 共享的实例对象.
 */
+ (instancetype) sharedInstance;

@end

/**
 *  私有扩展,其他网路请求的基础.
 */
@interface YFAPIManager (Private)

/**
 *  内部统一使用这个方法来向服务端发送请求
 *
 *  @param method       请求方式.
 *  @param relativePath 相对路径.
 *  @param parameters   参数.
 *  @param resultClass  从服务端获取到JSON数据后,使用哪个Class来将JSON转换为OC的Model.
 *
 *  @return RACSignal 信号对象.
 */
- (RACSignal *)requestWithMethod:(NSString *)method relativePath:(NSString *)relativePath parameters:(NSDictionary *)parameters resultClass:(Class)resultClass;

@end


/**
 *  用户信息相关的操作.
 */
@interface YFAPIManager (User)


/**
 *  用户登录.
 *
 *  获取到用户数据后,会自动更新User属性,所以仅需要在必要的地方观察user属性即可.
 *
 *  @param username 用户名.
 *  @param password 用户密码.
 *
 *  @return RACSingal对象,sendNext的是此类的的单例实例.
 */
- (RACSignal *)signInUsingUsername:(NSString *)username passowrd:(NSString *)password;

/**
 *  登出.
 *
 *  登出,其实就是把 user 属性设为nil.
 *
 *  @return sendNext为此类的单例实例.
 */
- (RACSignal *) logout;

@end

/**
 *  文章相关操作.
 */
@interface YFAPIManager (Post)
//....

@end

Models Group包含了独具和服务端API对应的Model,比如 YFPostModel:

//
//  YFPostModel.h
//  iOS122
//
//  Created by 颜风 on 15/10/28.
//  Copyright © 2015年 iOS122. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <Mantle.h>

/**
 *  文章.
 */
@interface YFPostModel : MTLModel <MTLJSONSerializing>

@property (strong, nonatomic) NSString * postId; //!< 文章唯一标识.
@property (copy, nonatomic) NSString * title; //!< 文章标题.
@property (copy, nonatomic) NSString * desc; //!< 文章简介.
@property (copy, nonatomic) NSString * body; //!< 文章详情.

@end

//
//  YFPostModel.m
//  iOS122
//
//  Created by 颜风 on 15/10/28.
//  Copyright © 2015年 iOS122. All rights reserved.
//

#import "YFPostModel.h"

@implementation YFPostModel

/**
 *  用于指定模型属性与JSON数据字段的对应关系.
 *
 *  @return 模型属性与JSON数据字段的对应关系:以模型属性为键,JSON字段为值.
 */

+ (NSDictionary *)JSONKeyPathsByPropertyKey {
    NSDictionary * dictMap = @{
                               @"postId": @"objectId",
                               @"title": @"title",
                               @"desc": @"desc",
                               @"body": @"body"
                               };

    return dictMap;
}

@end

可用类下面的口舌,来以JSON转换为Model:

YFPostModel * model = [MTLJSONAdapter modelOfClass:[YFPostModel class] fromJSONDictionary:@{@"title": @"标题", @"desc": @"简介", @"body": @"内容", @"objectId": @"id"} error: NULL];

  ”C:\Program Files\UliPad\UliPad.exe” “%1”

Archive / UnArchive / Copy

诸一个Model都如帮忙Archive / UnArchive /
Copy,也即是如若兑现与讨论,这片独探讨的始末实在即使是本着Object的Property做些处理,所以一旦得以于基类里拿这些从都合并处理,就会面便利多。考虑到统筹之泰与终的可扩展性,我们采纳相比较有名的老三方库–Mantle
来处理.你可使用CocoaPods安装此库房,然后引入头文件 #import <Mantle.h>
到由定义的Model中不怕可.

pod 'Mantle' # JSON <==> Model

     即可。

用户的记名和上

先来说说登录,由于拔取RAC,在结构API时,就非需传入Block了,随之而来的一个题目就是待在诠释中验证sendNext时会发送什么内容.LeanCloud用户登录接口会回完整的用户音信:

+ (RACSignal *)signInUsingUsername:(NSString *)username passowrd:(NSString *)password
{
    NSDictionary *parameters = @{
                                 @"username": username,
                                 @"password": password,
                                 };

    YFAPIManager *manager = [self sharedInstance];

    // 需要配对使用@weakify 与 @strongify 宏,以防止block内的可能的循环引用问题.
    @weakify(manager);

    return [[[[manager rac_GET:@"login" parameters:parameters]
               // reduceEach的作用是传入多个参数,返回单个参数,是基于`map`的一种实现
               reduceEach:^id(NSDictionary *response, AFHTTPRequestOperation *operation){
                   @strongify(manager);

                   YFUserModel * user = [MTLJSONAdapter modelOfClass:[YFUserModel class] fromJSONDictionary: response error: NULL];

                   manager.user = user;

                   return manager;
               }]
              // 避免side effect,有点类似于 "懒加载".
              replayLazily]
            setNameWithFormat:@"+signInUsingUsername:%@ password:%@", username, password];
}

用户之登出哪怕简单了,直接设置user为nil就尽了:

+ (RACSignal *)logout
{
    YFAPIManager * manager = [YFAPIManager sharedInstance];
    @weakify(manager);

    return [RACSignal createSignal:^RACDisposable *(id<RACSubscriber> subscriber) {
        @strongify(manager);

        manager.user = nil;


        [subscriber sendNext: manager];

        [subscriber sendCompleted];

        return nil;
    }];
}

安过时间以及缓存策略

“花瓣”选拔的凡再一次定义 AFHTTPRequestSerializer
子类的不二法门,但骨子里用AOP,几行代码就足足了:

// 设置超时和缓存策略.
[self.requestSerializer aspect_hookSelector:@selector(requestWithMethod:
                                                      URLString:
                                                      parameters:
                                                      error:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo>info){
    /* 在方法调用后,来获取返回值,然后更改其属性. */
    // __autoreleasing 关键字是必须的,默认的 __strong,会引起后续代码的野指针崩溃.
    __autoreleasing NSMutableURLRequest *  request = nil;

    NSInvocation *invocation = info.originalInvocation;

    [invocation getReturnValue: &request];

    if (nil != request) {
        request.timeoutInterval = 30;
        request.cachePolicy = NSURLRequestReloadIgnoringLocalCacheData;

        [invocation setReturnValue: &request];
    }
}error: NULL];

行使了一个AOP库,感兴趣的穿那里:
Aspects.

权力验证

夫比较简单些,直接以道中长判断属性self.isAuthenticated 即可:

if (!self.isAuthenticated)
{
  ....
}

中 isAuthenticated 为依照self.user的推理属性,其实现如下:

RAC(self, isAuthenticated) = [RACSignal combineLatest:@[RACObserve(self, user)] reduce:^id{
    @strongify(self);

    BOOL isLogin = YES;

    if (nil == self.user || nil == self.user.token) {
        isLogin = NO;
    }

    return [NSNumber numberWithBool: isLogin];
}];

实现博客数据的访问.

这边我们要促成访问某个具体的博客数据,以讲明上述各样基础构件的可用性.为了要示例更兼具典型性,我手动将博客数据设为仅指定测试用户(测试用户可以LeanCloud后台添加和点名)可以拜:

急需先实现- (RACSignal *)requestWithMethod:(YFAPIManagerMethod)method relativePath:(NSString *)relativePath parameters:(NSDictionary *)parameters resultClass:(Class)resultClass;办法,这是负有网络访问的基础,如下:

/**
 *  内部统一使用这个方法来向服务端发送请求
 *
 *  @param method       请求方式.
 *  @param relativePath 相对路径.
 *  @param parameters   参数.
 *  @param resultClass  从服务端获取到JSON数据后,使用哪个Class来将JSON转换为OC的Model.
 *
 *  @return RACSignal 信号对象.sendNext返回的是转换后的Model.
 */

- (RACSignal *)requestWithMethod:(YFAPIManagerMethod)method relativePath:(NSString *)relativePath parameters:(NSDictionary *)parameters resultClass:(Class)resultClass
{
    RACSignal * signal = nil;

    if (method == YFAPIManagerMethodGet) {
        signal = [self rac_GET:relativePath parameters:parameters];
    }

    if (method == YFAPIManagerMethodPut) {
        signal = [self rac_PUT:relativePath parameters:parameters];
    }

    if (method == YFAPIManagerMethodPost) {
        signal = [self rac_POST:relativePath parameters:parameters];
    }

    if (method == YFAPIManagerMethodPatch) {
        signal = [self rac_PATCH:relativePath parameters:parameters];
    }

    if (method == YFAPIManagerMethodDelete) {
        signal = [self rac_DELETE:relativePath parameters:parameters];
    }

    return [[signal reduceEach:^id(NSDictionary *response){
        id responseModel = [MTLJSONAdapter modelOfClass:resultClass fromJSONDictionary:response error:NULL];

        return responseModel;
    }]replayLazily];
}

然后上加一个用户博客详情访问的艺术即可:

/**
 *  获取文章详情.
 *
 *  @param postId 文章id.
 *
 *  @return sendNext为获取到的文章数据模型.
 */

- (RACSignal *)fetchPostDetail:(NSString *)postId
{
    return [[self requestWithMethod:YFAPIManagerMethodGet relativePath:[NSString stringWithFormat:@"classes/Post/%@", postId] parameters:nil resultClass: [YFPostModel class]] setNameWithFormat: @"%@ -fetchPostDetail: %@", self.class, postId];
}

然后您便可据此接近下面的代码访问博客详情了:

[[[YFAPIManager sharedInstance] fetchPostDetail: @"56308138e4b0feb4c8ba2a34"] subscribeNext:^(YFPostModel * x) {
    NSLog(@"%@", x.body);

    [self.webView loadHTMLString:x.body baseURL:nil];
}];

局部而或需要通晓的技术细节

md5 加密

LeanClodu Rest API
需要以地方对masterKey以地点做一样次于md5加密,我包了一个办法,可以平素用:

/**
 *  将字符串md5加密,并返回加密后的结果.
 *
 *  @param originalStr 原始字符串.
 *  @param lower       是否返回小写形式: YES,返回全小写形式;NO,返回全大写形式.
 *
 *  @return md5 加密后的结果.
 */
- (NSString *) md5Str: (NSString *) originalStr isLower: (BOOL) lower
{
    const char *original = [originalStr UTF8String];
    unsigned char result[CC_MD5_DIGEST_LENGTH];
    CC_MD5(original, (CC_LONG)strlen(original), result);
    NSMutableString *hash = [NSMutableString string];
    for (int i = 0; i < 16; i++)
    {
        [hash appendFormat:@"%02X", result[i]];
    }

    NSString * md5Result = [hash lowercaseString];

    if (NO == lower) {
        md5Result = [md5Result uppercaseString];
    }

    return md5Result;
}

动态设置请求头

因为LeanCloud的乞请签权和时穿有悬挂,所以每一回要都亟待重置部分要求头,此处可以每个请求都手动设置,可是本人是行使AOP,直接hook了刹那间(PS:强烈指出不通晓AOP为什么物的童鞋,学习下,真的要命爽用起来):

// 每次发送请求前,都需要更新一下 请求头中的 apiClientSecret,因为它是时间戳相关的.
[self aspect_hookSelector:NSSelectorFromString(@"rac_requestPath:parameters:method:") withOptions:AspectPositionBefore usingBlock:^{
    @strongify(self);

    [self.requestSerializer setValue: self.apiClientSecret forHTTPHeaderField: @"X-LC-Sign"];

} error:NULL];

token值自动安装

本条实在到头来RAC的根基,让token和user的变通绑定起来就是举行了,假如您想再次写user的setter方法,然后起身请求头中token的扭转,也是得的(但我再也喜欢RAC的状法了):

// 每次用户数据更新时,都需要重新设置下请求头中的token值.
[RACObserve(self, user) subscribeNext:^(YFUserModel * user) {
    @strongify(self);

    [self.requestSerializer setValue:user.token forHTTPHeaderField: @"X-LC-Session"];
}];

“推导属性”的实现

所谓”推导属性”,就是这个附属的,是冲其他性能估算出来的性,本身应当趁机中央属性的转变而机关变化.实现情势发出许多,可以再度写是属性的getter方法,也足以像下那样:

// 设置isAuthenticated.
RAC(self, isAuthenticated) = [RACSignal combineLatest:@[RACObserve(self, user)] reduce:^id{
    @strongify(self);

    BOOL isLogin = YES;

    if (nil == self.user || nil == self.user.token) {
        isLogin = NO;
    }

    return [NSNumber numberWithBool: isLogin];
}];

小结与兆

因大家的服务器,是人情的PHP服务器,所以本文对LeanCloud的解析,仅供我们看做技术实现达标之一个参考.具体到自己之事体细节,可能略地点,需要新鲜处理.关于以上技术啄磨的问题,欢迎跟帖商量!

生一样篇主题,会对单元测试的一些细节做同样细分析.边查找边上学,总算真到了一个宜的重构我们都暴发工的策略了.重构量不略,最核心的一些凡须确保原有的代码不吃影响.也就是说,接下去少完善我只要穷尽写单元测试用例,边重构代码.期间遇的关于测试的题目及坑,会及时记录下来,汇总交换.