[关闭]
@kezhen 2015-09-29T08:30:50.000000Z 字数 6252 阅读 3150

YTKNetwork 使用基础教程

YTKNetwork

本教程将讲解 YTKNetwork 的基本功能的使用。

YTKNetwork 基本组成

YTKNetwork 包括以下几个基本的类：

接下来我们详细地来解释这些类以及它们的用法。

YTKNetworkConfig 类

YTKNetworkConfig 类有两个作用：

  1. 统一设置网络请求的服务器和 CDN 的地址。
  2. 管理网络请求的 YTKUrlFilterProtocol 实例（在高级功能教程中有介绍）。

我们为什么需要统一设置服务器地址呢？因为：

  1. 按照设计模式里的 Do Not Repeat Yourself原则，我们应该把服务器地址统一写在一个地方。
  2. 在实际业务中，我们的测试人员需要切换不同的服务器地址来测试。统一设置服务器地址到 YTKNetworkConfig 类中，也便于我们统一切换服务器地址。

具体的用法是，在程序刚启动的回调中，设置好 YTKNetworkConfig 的信息，如下所示：

  1. - (BOOL)application:(UIApplication *)application 
  2.    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
  3. {
  4.    YTKNetworkConfig *config = [YTKNetworkConfig sharedInstance];
  5.    config.baseUrl = @"http://yuantiku.com";
  6.    config.cdnUrl = @"http://fen.bi";
  7. }

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

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

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

YTKRequest 类

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

每一种网络请求继承 YTKRequest 类后，需要用方法覆盖（overwrite）的方式，来指定网络请求的具体信息。如下是一个示例：

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

  1. // RegisterApi.h
  2. #import "YTKRequest.h"
  4. @interface RegisterApi : YTKRequest
  6. - (id)initWithUsername:(NSString *)username password:(NSString *)password;
  8. @end
  11. // RegisterApi.m
  14. #import "RegisterApi.h"
  16. @implementation RegisterApi {
  17.     NSString *_username;
  18.     NSString *_password;
  19. }
  21. - (id)initWithUsername:(NSString *)username password:(NSString *)password {
  22.     self = [super init];
  23.     if (self) {
  24.         _username = username;
  25.         _password = password;
  26.     }
  27.     return self;
  28. }
  30. - (NSString *)requestUrl {
  31.     // “http://www.yuantiku.com” 在 YTKNetworkConfig 中设置，这里只填除去域名剩余的网址信息
  32.     return @"/iphone/register";
  33. }
  35. - (YTKRequestMethod)requestMethod {
  36.     return YTKRequestMethodPost;
  37. }
  39. - (id)requestArgument {
  40.     return @{
  41.         @"username": _username,
  42.         @"password": _password
  43.     };
  44. }
  46. @end

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

调用 RegisterApi

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

  1. - (void)loginButtonPressed:(id)sender {
  2.     NSString *username = self.UserNameTextField.text;
  3.     NSString *password = self.PasswordTextField.text;
  4.     if (username.length > 0 && password.length > 0) {
  5.         RegisterApi *api = [[RegisterApi alloc] initWithUsername:username password:password];
  6.         [api startWithCompletionBlockWithSuccess:^(YTKBaseRequest *request) {
  7.             // 你可以直接在这里使用 self
  8.             NSLog(@"succeed");
  10.         } failure:^(YTKBaseRequest *request) {
  11.             // 你可以直接在这里使用 self
  12.             NSLog(@"failed");
  13.         }];
  14.     }
  15. }

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

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

  1. - (void)loginButtonPressed:(id)sender {
  2.     NSString *username = self.UserNameTextField.text;
  3.     NSString *password = self.PasswordTextField.text;
  4.     if (username.length > 0 && password.length > 0) {
  5.         RegisterApi *api = [[RegisterApi alloc] initWithUsername:username password:password];
  6.         api.delegate = self;
  7.         [api start];
  8.     }
  9. }
  11. - (void)requestFinished:(YTKBaseRequest *)request {
  12.     NSLog(@"succeed");
  13. }
  15. - (void)requestFailed:(YTKBaseRequest *)request {
  16.     NSLog(@"failed");
  17. }

验证服务器返回内容

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

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

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

  1. - (id)jsonValidator {
  2.     return @{
  3.         @"nick": [NSString class],
  4.         @"level": [NSNumber class]
  5.     };
  6. }

完整的代码如下：

  1. // GetUserInfoApi.h
  2. #import "YTKRequest.h"
  4. @interface GetUserInfoApi : YTKRequest
  6. - (id)initWithUserId:(NSString *)userId;
  8. @end
  11. // GetUserInfoApi.m
  12. #import "GetUserInfoApi.h"
  14. @implementation GetUserInfoApi {
  15.     NSString *_userId;
  16. }
  18. - (id)initWithUserId:(NSString *)userId {
  19.     self = [super init];
  20.     if (self) {
  21.         _userId = userId;
  22.     }
  23.     return self;
  24. }
  26. - (NSString *)requestUrl {
  27.     return @"/iphone/users";
  28. }
  30. - (id)requestArgument {
  31.     return @{ @"id": _userId };
  32. }
  34. - (id)jsonValidator {
  35.     return @{
  36.         @"nick": [NSString class],
  37.         @"level": [NSNumber class]
  38.     };
  39. }
  41. @end

以下是更多的jsonValidator的示例：

  1. - (id)jsonValidator {
  2.     return @[ [NSString class] ];
  3. }
  1. - (id)jsonValidator {
  2.     return @[@{
  3.         @"id": [NSNumber class],
  4.         @"imageId": [NSString class],
  5.         @"time": [NSNumber class],
  6.         @"status": [NSNumber class],
  7.         @"question": @{
  8.             @"id": [NSNumber class],
  9.             @"content": [NSString class],
  10.             @"contentType": [NSNumber class]
  11.         }
  12.     }];
  13. }

使用CDN地址

如果要使用CDN地址，只需要覆盖 YTKRequest 类的 - (BOOL)useCDN;方法。

例如我们有一个取图片的接口，地址是 http://fen.bi/image/imageId ，则我们可以这么写代码:

  1. // GetImageApi.h
  2. #import "YTKRequest.h"
  4. @interface GetImageApi : YTKRequest
  5. - (id)initWithImageId:(NSString *)imageId;
  6. @end
  8. // GetImageApi.m
  9. #import "GetImageApi.h"
  11. @implementation GetImageApi {
  12.     NSString *_imageId;
  13. }
  15. - (id)initWithImageId:(NSString *)imageId {
  16.     self = [super init];
  17.     if (self) {
  18.         _imageId = imageId;
  19.     }
  20.     return self;
  21. }
  23. - (NSString *)requestUrl {
  24.     return [NSString stringWithFormat:@"/iphone/images/%@", _imageId];
  25. }
  27. - (BOOL)useCDN {
  28.     return YES;
  29. }
  31. @end

断点续传

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

  1. @implementation GetImageApi {
  2.     NSString *_imageId;
  3. }
  5. - (id)initWithImageId:(NSString *)imageId {
  6.     self = [super init];
  7.     if (self) {
  8.         _imageId = imageId;
  9.     }
  10.     return self;
  11. }
  13. - (NSString *)requestUrl {
  14.     return [NSString stringWithFormat:@"/iphone/images/%@", _imageId];
  15. }
  17. - (BOOL)useCDN {
  18.     return YES;
  19. }
  21. - (NSString *)resumableDownloadPath {
  22.     NSString *libPath = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex:0];
  23.     NSString *cachePath = [libPath stringByAppendingPathComponent:@"Caches"];
  24.     NSString *filePath = [cachePath stringByAppendingPathComponent:_imageId];
  25.     return filePath;
  26. }
  28. @end

按时间缓存内容

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

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

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

  1. @implementation GetUserInfoApi {
  2.     NSString *_userId;
  3. }
  5. - (id)initWithUserId:(NSString *)userId {
  6.     self = [super init];
  7.     if (self) {
  8.         _userId = userId;
  9.     }
  10.     return self;
  11. }
  13. - (NSString *)requestUrl {
  14.     return @"/iphone/users";
  15. }
  17. - (id)requestArgument {
  18.     return @{ @"id": _userId };
  19. }
  21. - (id)jsonValidator {
  22.     return @{
  23.         @"nick": [NSString class],
  24.         @"level": [NSNumber class]
  25.     };
  26. }
  28. - (NSInteger)cacheTimeInSeconds {
  29.     // 3分钟 = 180 秒
  30.     return 60 * 3;
  31. }
  33. @end

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

以上几个示例代码在Demo工程中也可获得。

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注