YTKNetwork的基本使用

YTKNetwork是一个对AFNetworking封装的一个框架，虽然二者底层原理相同，但使用方法和使用效果是大不相同的。YTKNetwork 提供了以下更高级的功能：
1.支持按时间缓存网络请求内容
2.支持按版本号缓存网络请求内容
3.支持统一设置服务器和 CDN 的地址
4.支持检查返回 JSON 内容的合法性
5.支持文件的断点续传
6.支持 block 和 delegate 两种模式的回调方式
7.支持批量的网络请求发送，并统一设置它们的回调（实现在 YTKBatchRequest 类中）
支持方便地设置有相互依赖的网络请求的发送，例如：发送请求 A，根据请求 A 的结果，选择性的发送请求 B
和 C，再根据 B 和 C 的结果，选择性的发送请求 D。（实现在 YTKChainRequest 类中）
支持网络请求 URL 的 filter，可以统一为网络请求加上一些参数，或者修改一些路径。

YTKNetwork包含了这几个类：1、YTKNetworkConfig （设置域名） 2、YTKRequest （网络请求）3、YTKBatchRequest （请求多个类 ）4、YTKChainRequest （依赖请求）5、YTKBaseRequest（YTKRequest的父类）

YTKNetwork 的基本思想

YTKNetwork 的基本的思想是把每一个网络请求封装成对象。所以使用 YTKNetwork，你的每一个请求都需要继承 YTKRequest 类，通过覆盖父类的一些方法来构造指定的网络请求。

集约式和离散式API

集约式API

介绍：所有API的调用只有一个类，然后这个类接收API名字，API参数，以及回调着陆点，即项目中的每个请求都会走统一的入口，对外暴露了请求的 URL 和 Param 以及请求方式，入口一般都是通过单例 来实现，AFNetworking 的官方 demo 就是采用的集约式的方式对网络请求进行的封装，也是目前比较流行的网络请求方式。

优点：使用便捷，能实现快速开发
缺点：
1.对每个请求的定制型不够强
2.不方便后期业务拓展
我们常用的AFNetworking框架就是集约式，在简单程序中AFNetworking 将请求逻辑写在 Controller 中比YTK更加方便，也不用一个个请求新建不同的request类。而YTKNetworking则是离散式的

离散式API

介绍：离散型API调用是这样的，一个API对应于一个APIManager，然后这个APIManager只需要提供参数就能起飞，API名字、着陆方式都已经集成入APIManager中。即每个网络请求类都是一个对象，它的 URL 以及请求方式和响应方式 均不暴露给外部调用。只能内部通过 重载或实现协议 的方式来指定，外部调用只需要传 Param 即可，YTKNetwork就是采用的这种网络请求方式。

优点：URL 以及请求和响应方式不暴露给外部，避免外部调用的时候写错
业务方使用起来较简单，业务使用者不需要去关心它的内部实现
可定制性强，可以为每个请求指定请求的超时时间以及缓存的周期
缺点：
网络层需要业务实现方去写，变相的增加了部分工作量
文件增多，程序包会变大一些

YTKNetworkConfig 类

YTKNetworkConfig 类有两个作用：
统一设置网络请求的服务器和 CDN 的地址。
管理网络请求的 YTKUrlFilterProtocol 实例
我们为什么需要统一设置服务器地址呢？因为：

按照设计模式里的 Do Not Repeat Yourself 原则，我们应该把服务器地址统一写在一个地方。
在实际业务中，我们的测试人员需要切换不同的服务器地址来测试。统一设置服务器地址到 YTKNetworkConfig 类中，也便于我们统一切换服务器地址。
具体的用法是，在程序刚启动的回调中，设置好 YTKNetworkConfig 的信息，如下所示：

- (BOOL)application:(UIApplication *)application 
   didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
   YTKNetworkConfig *config = [YTKNetworkConfig sharedConfig];
   config.baseUrl = @"http://yuantiku.com";
   config.cdnUrl = @"http://fen.bi";
}

设置好之后，所有的网络请求都会默认使用 YTKNetworkConfig 中 baseUrl 参数指定的地址。

大部分企业应用都需要对一些静态资源（例如图片、js、css）使用 CDN。YTKNetworkConfig 的 cdnUrl 参数用于统一设置这一部分网络请求的地址。

当我们需要切换服务器地址时，只需要修改 YTKNetworkConfig 中的 baseUrl 和 cdnUrl 参数即可。

YTKRequest

YTK把每个请求实例化，管理它的生命周期，也可以管理多个请求，在github的基础教程里面我们可以看到YTK是把每个网络请求都封装成对象，每一种网络请求继承 YTKRequest 类后，需要用方法覆盖（overwrite）的方式，来指定网络请求的具体信息。如下是一个示例：

假如我们要向网址 http://www.yuantiku.com/iphone/register 发送一个 POST 请求，请求参数是 username 和 password。那么，这个类应该如下所示：

// RegisterApi.h
#import "YTKRequest.h"

@interface RegisterApi : YTKRequest

- (id)initWithUsername:(NSString *)username password:(NSString *)password;

@end


// RegisterApi.m

#import "RegisterApi.h"

@implementation RegisterApi {
   NSString *_username;
   NSString *_password;
}

- (id)initWithUsername:(NSString *)username password:(NSString *)password {
   self = [super init];
   if (self) {
       _username = username;
       _password = password;
   }
   return self;
}

- (NSString *)requestUrl {
   // “ http://www.yuantiku.com ” 在 YTKNetworkConfig 中设置，这里只填除去域名剩余的网址信息
   return @"/iphone/register";
}

- (YTKRequestMethod)requestMethod {
   return YTKRequestMethodPOST;
}

- (id)requestArgument {
   return @{
       @"username": _username,
       @"password": _password
   };
}

@end

在上面这个示例中，我们可以看到：

• 我们通过覆盖 YTKRequest 类的 requestUrl 方法，实现了指定网址信息。并且我们只需要指定除去域名剩余的网址信息，因为域名信息在 YTKNetworkConfig 中已经设置过了。
• 我们通过覆盖 YTKRequest 类的 requestMethod 方法，实现了指定 POST 方法来传递参数。
• 我们通过覆盖 YTKRequest 类的 requestArgument 方法，提供了 POST 的信息。这里面的参数 username 和 password 如果有一些特殊字符（如中文或空格），也会被自动编码。

调用 RegisterApi

在构造完成 RegisterApi 之后，具体如何使用呢？我们可以在登录的 ViewController 中，调用 RegisterApi，并用 block 的方式来取得网络请求结果：

- (void)loginButtonPressed:(id)sender {
    NSString *username = self.UserNameTextField.text;
    NSString *password = self.PasswordTextField.text;
    if (username.length > 0 && password.length > 0) {
        RegisterApi *api = [[RegisterApi alloc] initWithUsername:username password:password];
        [api startWithCompletionBlockWithSuccess:^(YTKBaseRequest *request) {
            // 你可以直接在这里使用 self
            NSLog(@"succeed");
        } failure:^(YTKBaseRequest *request) {
            // 你可以直接在这里使用 self
            NSLog(@"failed");
        }];
    }
}

注意：你可以直接在 block 回调中使用 self，不用担心循环引用。因为 YTKRequest 会在执行完 block 回调之后，将相应的 block 设置成 nil。从而打破循环引用。

除了 block 的回调方式外，YTKRequest 也支持 delegate 方式的回调：

- (void)loginButtonPressed:(id)sender {
    NSString *username = self.UserNameTextField.text;
    NSString *password = self.PasswordTextField.text;
    if (username.length > 0 && password.length > 0) {
        RegisterApi *api = [[RegisterApi alloc] initWithUsername:username password:password];
        api.delegate = self;
        [api start];
    }
}

- (void)requestFinished:(YTKBaseRequest *)request {
    NSLog(@"succeed");
}

- (void)requestFailed:(YTKBaseRequest *)request {
    NSLog(@"failed");
}

验证服务器返回内容

有些时候，由于服务器的 Bug，会造成服务器返回一些不合法的数据，如果盲目地信任这些数据，可能会造成客户端 Crash。如果加入大量的验证代码，又使得编程体力活增加，费时费力。

使用 YTKRequest 的验证服务器返回值功能，可以很大程度上节省验证代码的编写时间。

例如，我们要向网址 http://www.yuantiku.com/iphone/users 发送一个 GET 请求，请求参数是 userId 。我们想获得某一个用户的信息，包括他的昵称和等级，我们需要服务器必须返回昵称（字符串类型）和等级信息（数值类型），则可以覆盖 jsonValidator 方法，实现简单的验证。

- (id)jsonValidator {
    return @{
        @"nick": [NSString class],
        @"level": [NSNumber class]
    };
}

断点续传

要启动断点续传功能，只需要覆盖 resumableDownloadPath 方法，指定断点续传时文件的存储路径即可，文件会被自动保存到此路径。如下代码将刚刚的取图片的接口改造成了支持断点续传：

@implementation GetImageApi {
    NSString *_imageId;
}

- (id)initWithImageId:(NSString *)imageId {
    self = [super init];
    if (self) {
        _imageId = imageId;
    }
    return self;
}

- (NSString *)requestUrl {
    return [NSString stringWithFormat:@"/iphone/images/%@", _imageId];
}

- (BOOL)useCDN {
    return YES;
}

- (NSString *)resumableDownloadPath {
    NSString *libPath = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    NSString *cachePath = [libPath stringByAppendingPathComponent:@"Caches"];
    NSString *filePath = [cachePath stringByAppendingPathComponent:_imageId];
    return filePath;
}

@end

按时间缓存内容

刚刚我们写了一个 GetUserInfoApi ，这个网络请求是获得用户的一些资料。

我们想像这样一个场景，假设你在完成一个类似微博的客户端，GetUserInfoApi 用于获得你的某一个好友的资料，因为好友并不会那么频繁地更改昵称，那么短时间内频繁地调用这个接口很可能每次都返回同样的内容，所以我们可以给这个接口加一个缓存。

在如下示例中，我们通过覆盖 cacheTimeInSeconds 方法，给 GetUserInfoApi 增加了一个 3 分钟的缓存，3 分钟内调用调 Api 的 start 方法，实际上并不会发送真正的请求。

@implementation GetUserInfoApi {
    NSString *_userId;
}

- (id)initWithUserId:(NSString *)userId {
    self = [super init];
    if (self) {
        _userId = userId;
    }
    return self;
}

- (NSString *)requestUrl {
    return @"/iphone/users";
}

- (id)requestArgument {
    return @{ @"id": _userId };
}

- (id)jsonValidator {
    return @{
        @"nick": [NSString class],
        @"level": [NSNumber class]
    };
}

- (NSInteger)cacheTimeInSeconds {
    // 3 分钟 = 180 秒
    return 60 * 3;
}

@end

该缓存逻辑对上层是透明的，所以上层可以不用考虑缓存逻辑，每次调用 GetUserInfoApi 的 start 方法即可。GetUserInfoApi 只有在缓存过期时，才会真正地发送网络请求。