iOS开发--YTKNetwork的使用

今天学习了一下YTKNetwork,在此写下心得,记录学习历程

首先YTKNetwork的基本功能如下:

1,YTKNetwork包含两个类,分别是YTKNetworkConfig类和YTKRequest类,其中YTKNetworkConfig类是用于统一设置网络请求的服务器和CDN的地址。YTKRequest类是所有的网络请求类需要继承于YTKRequest类,每一个YTKRequest类的子类代表一种专门的网络请求。

其次YTKNetworkConfig类有两个作用:1)统一设置网络请求的服务器和CDN地址。2)管理网络请求的YTKUrlFilterProtocol实例。

需要统一设置服务器地址是因为:1)要按照设计模式里的应该把服务器地址统一写在一个地方。2)在实际业务中,我们的测试人员需要切换不同的服务器地址来测试。统一设置服务器地址到 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 参数指定的地址。

YTKRequest

每一种请求都需要继承 YTKRequest 类,通过覆盖父类的一些方法来构造指定的网络请求,每一种网络请求继承 YTKRequest 类后,需要用方法覆盖的方式,来指定网络请求的具体信息。

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

#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 {

return @"/iphone/register";

}

- (YTKRequestMethod)requestMethod {

return YTKRequestMethodPOST;

}

- (id)requestArgument {

return @{

@"username": _username,

@"password": _password

};

}

@end

在上面这个示例中,我们可以看到:

1)我们通过覆盖 YTKRequest 类的 requestUrl 方法,实现了指定网址信息。并且只需要指定除去域名剩余的网址信息,因为域名信息在 YTKNetworkConfig 中已经设置过了。

2)我们通过覆盖 YTKRequest 类的 requestMethod 方法,实现了指定 POST 方法来传递参数。

3)我们通过覆盖 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]

};

}

完整的代码如下:

// GetUserInfoApi.h

#import "YTKRequest.h"

@interface GetUserInfoApi : YTKRequest

- (id)initWithUserId:(NSString *)userId;

@end

// GetUserInfoApi.m

#import "GetUserInfoApi.h"

@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]

};

}

@end

你可能感兴趣的:(iOS开发--YTKNetwork的使用)