LXNetworking 1.0.9

LXNetworking 1.0.9

×

由 姓名 维护。

 
依赖
AFNetworking>= 0
YYCache>= 0
 

LXNetworking 1.0.9

LXNetworking

基于 AFNetworking 的 v3.2.1 进行网络请求，基于 YYCache 进行数据缓存，支持清除特定 URL 缓存、URL 及参数组合缓存，通过 AFNetworkActivityLogger 进行网络日志打印。该代码使用灵活的请求方式，不含任何业务代码，支持集中式、分布式网络接口管理方式，请求前可以进行配置，支持对响应数据进行统一处理。

一、实现功能

1、多环境切换功能：

支持不同环境，快速切换对应环境的地址，也支持为特定接口使用特殊的地址：

// 业务层代码
self.requestConvertManager = [LXRequestConvertManager sharedInstance];
// 不同环境设置不同的baseURL
self.requestConvertManager.configuration.baseURL = baseURL;

// 特殊的接口需要设置特殊的baseURL
[self.requestConvertManager requestMethod:LXRequestMethodPost
                                    URLString:SHOWAPI_LAUGHTER
                                   parameters:@{@"page" : @(pageIndex), @"maxResult" : @(pageSize)}
                         configurationHandler:^(LXRequestManagerConfig * _Nullable configuration) {
                             configuration.baseURL = otherBaseURL;
                         } cache:^(id  _Nullable responseObject) {
                             NSLog(@"缓存数据");
                             cache(responseObject);
                         } success:^(NSURLSessionTask * _Nullable dataTask, id  _Nullable responseObject) {
                             success(dataTask, responseObject);
                         } failure:^(NSURLSessionTask * _Nullable dataTask, LXError * _Nullable error) {
                             failure(dataTask, error);
                         }];

2、处理多个接口中的通用配置：

通用配置，如请求头通用配置、请求体通用配置、接口网络超时时间等等。

// 业务层代码
self.requestConvertManager = [LXRequestConvertManager sharedInstance];

//通过configuration来设置请求头
NSMutableDictionary *builtinHeaders = [NSMutableDictionary dictionary];
builtinHeaders[@"showapi_appid"] = SHOWAPI_APPID;
builtinHeaders[@"showapi_sign"] = SHOWAPI_SIGN;
self.requestConvertManager.configuration.builtinHeaders = builtinHeaders;

//通过configuration来设置通用的请求体
NSMutableDictionary *builtinBodys = [NSMutableDictionary dictionary];
builtinBodys[@"showapi_appid"] = SHOWAPI_APPID;
builtinBodys[@"showapi_sign"] = SHOWAPI_SIGN;
self.requestConvertManager.configuration.builtinBodys = builtinBodys;

3、处理不同接口的差异性：

这里的差异性包括接口网络超时时间、数据缓存时间、数据缓存协议等。实际上，这些地方都有默认值，支持差异化请求。

// 业务层代码
self.requestConvertManager = [LXRequestConvertManager sharedInstance];

// 特殊的接口需要设置特殊的baseURL
[self.requestConvertManager requestMethod:LXRequestMethodPost
                                    URLString:SHOWAPI_LAUGHTER
                                   parameters:@{@"page" : @(pageIndex), @"maxResult" : @(pageSize)}
                         configurationHandler:^(LXRequestManagerConfig * _Nullable configuration) {
                           //设置缓存时长为100000秒
							configuration.resultCacheDuration = 100000;    
                           //优先取缓存数据，不在请求网络数据
                            configuration.requestCachePolicy = LXRequestReturnLoadToCache;    
                         } cache:^(id  _Nullable responseObject) {
                             NSLog(@"缓存数据");
                             cache(responseObject);
                         } success:^(NSURLSessionTask * _Nullable dataTask, id  _Nullable responseObject) {
                             success(dataTask, responseObject);
                         } failure:^(NSURLSessionTask * _Nullable dataTask, LXError * _Nullable error) {
                             failure(dataTask, error);
                         }];

4、对网络请求返回的数据进行一层拦截：

这里举个例子说明一下，就是在一些应用中，登录的有效性只是持续一段时间的，但是一些接口必须要登录有效性才能访问的，这个时候通常的做法可能就是，对这些需要验证登录有效性的接口返回数据进行筛选和判断，然后再进行下一步处理。随着这类接口数量不断增加，就会导致无法清楚地知道这一套判断代码写在哪里了。也许有经验的老司机在封装自己的网络请求库AFNetworking的时候，在返回代码的地方统一加入了这层逻辑，这确实是一种省时省力的方法，但是问题就在于，老司机写的这层组件也被业务代码给弄脏了。😂

我的思路其实也是这样的，这层拦截的代码也是加在网络请求库AFNetworking返回代码的地方，但是我使用了块（block），把原始数据回调给业务层本身，也就意味着业务层自己处理自己的拦截。

// 业务层代码
self.requestConvertManager = [LXRequestConvertManager sharedInstance];

//通过configuration来统一处理输出的数据，比如对token失效处理、对需要重新登录拦截
self.requestConvertManager.configuration.resposeHandle = ^id (NSURLSessionTask *dataTask, id responseObject) {
  	responseObject = [responseObject doSomething];
	return responseObject;
};


//LXNetworkingManager.m
self.requestManager = [AFHTTPSessionManager manager];
[self.requestManager dataTaskWithRequest:request
completionHandler:^(NSURLResponse * _Nonnull response, id  _Nullable responseObject, NSError * _Nullable error) {
    __strong typeof(self) strong_self = weak_self;
    if (error) {
        
    }
    else {
      	//如果业务层需要拦截，则先将返回的数据抛给业务层先处理
        if (configuration.resposeHandle) {
            responseObject = configuration.resposeHandle(dataTask, responseObject);
        }
        success(dataTask, responseObject);
    }
}];

5、网络数据缓存策略：

这里的缓存使用了YYCache，策略分为五种方式。默认为LXRequestReturnCacheOrLoadToCache，并且支持自定义缓存时间。

configuration.resultCacheDuration = 100000;

 >缓存策略机制
 
 - LXRequestReturnCacheDontLoad: 如果缓存有效则直接返回缓存，缓存失效则返回nil，不再load。（场景：几乎没有任何变化的接口，实效性低）
 - LXRequestReturnCacheAndLoadToCache: 如果缓存有效则直接返回缓存，并且load且缓存数据。缓存失效则load返回，且缓存数据。（场景：接口实效性不高，但需要有一定实效性，比如商品详情接口）
 - LXRequestReturnCacheOrLoadToCache: 如果缓存有效则直接返回缓存。缓存失效则load返回，且缓存数据。（场景：接口实效性不高，但需要有一定实效性，比如商品详情接口）
 - LXRequestReturnLoadToCache: 直接load并返回数据，且缓存数据，如果load失败则读取缓存数据。（场景：接口需要一定的实效性，但同时要有数据支持，比如项目的首页接口）
 - LXRequestReturnLoadDontCache: 直接load并返回数据，不缓存数据，如果load失败则直接抛出Error。（场景：接口一定是实时的，并且保证返回的数据真实、可靠、安全，而非本地缓存数据，比如支付接口）

6、log日志的完善机制：

这里使用的是AFNetworkActivityLogger这个类来实现的，它也可以根据开发者选择的log等级来打印对应级别的log，支持打印请求的HTTPMethod、URL、absluteString、网络请求响应的statusCode、本次请求耗时等等信息。它是利用AFNetworking请求发出的通知来实现的，具体可以查看源码。

7、error层的自定义统一管理：

组件中已经包含了一个基础版的LXError类，业务层可以继承这个类并重写下面的两个类方法：

+ (LXError *)lxErrorNetNotReachable;
+ (LXError *)lxErrorHttpError:(NSError *)error;

8、网络状态的判断：

这个没有过多说的，还是使用AFNetworking那一套：

//LXNetworkingManager.m
[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
	NSLog(@"Reachability: %@", AFStringFromNetworkReachabilityStatus(status));
	self.networkStatus = status;
}];

9、取消网络请求：

在调用组件中的网络接口时，会返回请求对象NSURLSessionTask，如果需要取消，只需要获取这个对象并调用它的cancel方法。当然，所有的请求都会在AFNetworking中排队，组件也提供了取消队列中所有请求的接口：

//LXNetworkingManager.m
- (void)cancelAllRequest {
    [self.requestManager invalidateSessionCancelingTasks:YES];
}

如何使用

pod 'LXNetworking'