YTKNetwork

基本用法:

最近在写公司的项目, 所以没有更新简书, 没想到还有不少哥们惦记, 本来在酝酿一个大文章的, 无奈不知如何起笔, 还是先写点小文章吧.

公司的网络请求类没有自己封装, 而是用来猿题库团队的YTKNetwork网络封装类, 这个框架在github上也有3000+ stars了. 个人感觉还是很好用的, 看了一下源码, 不算特别大的框架, 打算有时间自己也撸一遍的.

对于感兴趣的同学, 可以尝试在自己的项目中使用这个框架, 但是按照官方文档上的说法, 如果你的项目是一个轻型的项目, 那就没有必要使用这个框架了, 自己用AFNetworking即可, 因为YTKNetwork本身也是基于AFNetworking的二次封装.

好了, 现在就来说一下这个框架如何使用吧

这个框架的类如下图所示, 我们今天需要用到的类其实就是我画红框的这两个类

![最近在写公司的项目, 所以没有更新简书, 没想到还有不少哥们惦记, 本来在酝酿一个大文章的, 无奈不知如何起笔, 还是先写点小文章吧.

公司的网络请求类没有自己封装, 而是用来猿题库团队的YTKNetwork网络封装类, 这个框架在github上也有3000+ stars了. 个人感觉还是很好用的, 看了一下源码, 不算特别大的框架, 打算有时间自己也撸一遍的.

对于感兴趣的同学, 可以尝试在自己的项目中使用这个框架, 但是按照官方文档上的说法, 如果你的项目是一个轻型的项目, 那就没有必要使用这个框架了, 自己用AFNetworking即可, 因为YTKNetwork本身也是基于AFNetworking的二次封装.

好了, 现在就来说一下这个框架如何使用吧

这个框架的类如下图所示, 我们今天需要用到的类其实就是我画红框的这两个类

image

说白了,就是网络配置网络请求

先说一下网络配置

我们请求服务器的baseUrl通常是不变的, 根据设计模式中的"单一设计原则", 我们只需要在网络配置的时候设置一遍baseUrl即可, 而不用再操心baseUrl地址的问题.

在程序加载完毕之后, 配置访问服务器的baseUrl

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    YTKNetworkConfig *config = [YTKNetworkConfig sharedInstance];
    config.baseUrl = @"http://m.api.haoshiqi.net";
    return YES;
}

再就是网络请求
  • 首先, 你要发起一个网络请求, 就必须封装一个网络请求类, 如下图所示

[图片上传中...(image-3445f1-1550311475794-0)]

这个网络请求类是继承自YTKRequest类的,YTKRequest又继承自YTKBaseRequest, YTKBaseRequest是一个网络请求类的基类

  • 重写网络请求类的init方法,并对外暴露一个接口

网络请求类的.h文件

#import <YTKNetwork/YTKNetwork.h>

@interface YFTestRequest : YTKRequest

- (instancetype)initWithDict:(NSDictionary *)dict;

@end

网络请求类的.m文件

#import "YFTestRequest.h"

@implementation YFTestRequest {
    NSDictionary *_dict;
}
- (instancetype)initWithDict:(NSDictionary *)dict {
    if (self = [super init]) {
        _dict = dict;
    }
    return self;
}

  • 重写请求方法
- (YTKRequestMethod)requestMethod {
    return YTKRequestMethodPost;
}

  • 重写请求url
    这个url地址是拼接在baseUrl后面的
- (NSString *)requestUrl {
    return @"/common/index";
}

  • 重写请求参数
-(id)requestArgument {
    return _dict;
}

那么, 我们如何使用这个网络请求呢, 很简单, 直接上代码
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    NSDictionary *dict = @{
                           @"channel":@"App_Store",
                           @"device":@"iPhone%206",
                           @"location":@"113.923061%2C22.575888",
                           @"net":@"WIFI",
                           @"page":@"RootTableViewController",
                           @"sheight":@"667",
                           @"swidth":@"375",
                           @"terminal":@"ios",
                           @"timestamp":@"1476340105",
                           @"udid":@"c06322907b91f66bb58c2a9164832bd510231173",
                           @"v":@"1.7.0",
                           @"zoneId":@"2125",
                           };
    YFTestRequest *request = [[YFTestRequest alloc] initWithDict:dict];
    [request startWithCompletionBlockWithSuccess:^(__kindof YTKBaseRequest *request) {
        NSLog(@"%@",request.responseJSONObject);
    } failure:^(__kindof YTKBaseRequest *request) {
        NSLog(@"%@",request.requestOperationError);
    }];
}

  • 从上面的代码可以看出, 我将参数作为字典传进了初始化方法中, 为了举例方便, 我将参数写死了

  • 然后用我重写后的初始化方法初始一个网络请求对象

  • 最后调用

                                    failure:(YTKRequestCompletionBlock)failure```
这个方法, 来向服务器发起请求, 然后服务器利用block返回给我一串json数据, 我通过request的responseJSONObject属性就可以获取到

- 本例中, 我只要点击屏幕,华丽丽的json数据就出来了

![请求下来的json数据](http://upload-images.jianshu.io/upload_images/2868984-cc9d0352f3468209.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

基本介绍:

简单点说YTKNetwork就是在AFNetworking的基础上封装了一层,已提供一些更高级的功能:

支持按时间缓存网络请求内容
支持按版本号缓存网络请求内容
支持统一设置服务器和 CDN 的地址
支持检查返回 JSON 内容的合法性
支持文件的断点续传
支持 block 和 delegate 两种模式的回调方式
支持批量的网络请求发送,并统一设置它们的回调(实现在 YTKBatchRequest 类中)
支持方便地设置有相互依赖的网络请求的发送,例如:发送请求 A,根据请求 A 的结果,选择性的发送请求 B 和 C,再根据 B 和 C 的结果,选择性的发送请求 D。(实现在 YTKChainRequest 类中)
支持网络请求 URL 的 filter,可以统一为网络请求加上一些参数,或者修改一些路径。
定义了一套插件机制,可以很方便地为 YTKNetwork 增加功能。猿题库官方现在提供了一个插件,可以在某些网络请求发起时,在界面上显示“正在加载”的 HUD。
其中,缓存网络请求对大多数开发者来说可能并不重要,毕竟我们还是希望在页面刷新的时候获取到最新的内容。CDN的配置我相信大多数小公司都是用不到的,如果你的业务真的需要CDN来支撑,那已经不是小公司啦!我更推荐你去研究微信开源的网络框架Mars。

YTKNetwork跟别的网络框架(包括我自己封装的),最特别的地方就是可以管理互相依赖的网络请求,即YTKBatchRequest (可以方便的设置若干请求的统一回调)和YTKChainRequest(可以设置若干请求的前后依赖关系)。当然,好的接口设计应该避免出现让客户端同时请求这么多数据。

简单介绍一下这两个类:

1、YTKBatchRequest 类:用于方便地发送批量的网络请求,YTKBatchRequest 是一个容器类,它可以放置多个 YTKRequest子类,并统一处理这多个网络请求的成功和失败。

在如下的示例中,我们发送了 4 个批量的请求,并统一处理这 4 个请求同时成功的回调。

import "YTKBatchRequest.h"

import "GetImageApi.h"

import "GetUserInfoApi.h"

  • (void)sendBatchRequest {
    GetImageApi *a = [[GetImageApi alloc] initWithImageId:@"1.jpg"];
    GetImageApi *b = [[GetImageApi alloc] initWithImageId:@"2.jpg"];
    GetImageApi *c = [[GetImageApi alloc] initWithImageId:@"3.jpg"];
    GetUserInfoApi *d = [[GetUserInfoApi alloc] initWithUserId:@"123"];
    YTKBatchRequest *batchRequest = [[YTKBatchRequest alloc] initWithRequestArray:@[a, b, c, d]];
    [batchRequest startWithCompletionBlockWithSuccess:^(YTKBatchRequest *batchRequest) {
    NSLog(@"succeed");
    NSArray *requests = batchRequest.requestArray;
    GetImageApi *a = (GetImageApi *)requests[0];
    GetImageApi *b = (GetImageApi *)requests[1];
    GetImageApi *c = (GetImageApi *)requests[2];
    GetUserInfoApi *user = (GetUserInfoApi *)requests[3];
    // deal with requests result ...
    } failure:^(YTKBatchRequest *batchRequest) {
    NSLog(@"failed");
    }];
    }
    2、YTKChainRequest 类:用于管理有相互依赖的网络请求,它实际上最终可以用来管理多个拓扑排序后的网络请求。

例如,我们有一个需求,需要用户在注册时,先发送注册的 Api,然后 :

如果注册成功,再发送读取用户信息的 Api。并且,读取用户信息的 Api 需要使用注册成功返回的用户 id 号。
如果注册失败,则不发送读取用户信息的 Api 了。
以下是具体的代码示例,在示例中,我们在 sendChainRequest 方法中设置好了 Api 相互的依赖,然后。 我们就可以通过 chainRequestFinished 回调来处理所有网络请求都发送成功的逻辑了。如果有任何其中一个网络请求失败了,则会触发 chainRequestFailed 回调。

  • (void)sendChainRequest {
    RegisterApi *reg = [[RegisterApi alloc] initWithUsername:@"username" password:@"password"];
    YTKChainRequest *chainReq = [[YTKChainRequest alloc] init];
    [chainReq addRequest:reg callback:^(YTKChainRequest *chainRequest, YTKBaseRequest *baseRequest) {
    RegisterApi *result = (RegisterApi *)baseRequest;
    NSString *userId = [result userId];
    GetUserInfoApi *api = [[GetUserInfoApi alloc] initWithUserId:userId];
    [chainRequest addRequest:api callback:nil];

    }];
    chainReq.delegate = self;
    // start to send request
    [chainReq start];
    }

  • (void)chainRequestFinished:(YTKChainRequest *)chainRequest {
    // all requests are done
    }

  • (void)chainRequestFailed:(YTKChainRequest )chainRequest failedBaseRequest:(YTKBaseRequest)request {
    // some one of request is failed
    }
    这两个类在实际使用中用的还是比较多的,例如登录功能,写接口的人可能更加关注功能的单一性,所以,如果你想在登录之后紧接着获取用户的个人信息,这时候用YTKBatchRequest就比较方便了。

有没有发现定义很多接口类非常麻烦?每个请求都写一边init方法很累?下一篇我将介绍,如何让它用的更顺手。

原文链接:https://www.jianshu.com/p/ad49ab7a41a7
原文链接:https://blog.csdn.net/thelittleboy/article/details/83894438

推荐阅读更多精彩内容