Latest 2.0.2
Homepage https://github.com/QianKun-HanLin/HLNetworking
License MIT
Platforms ios 8.0, requires ARC
Authors

HLNetworking: High-level network request manager based on AFNetworking

基于AFNetworking的高阶网络请求管理器

License MIT
CI Status
[CocoaPods](http://cocoapods.org/?q= HLQRCodeScanner)
Support

简介

HLNetworking

HLNetworking整体结构如图所示,是一套基于AFNetworking 3.1.0封装的网络库,提供了更高层次的抽象和更方便的调用方式。

如果您使用的是1.x.x版本,请查看旧版本说明

特性

  • 离散式的请求设计,方便进行组件化
  • 支持全局配置请求的公共信息
  • 提供大多数网络访问方式和相应的序列化类型
  • 提供api请求结果映射接口,可以自行转换为相应的数据格式
  • api请求支持多种回调方式(block,delegate)
  • api配置简单,通过block链式调用组装api,配合APICenter中的宏可以极大减少离散式api的设置代码
  • 支持批量请求、链式请求等特殊需求
  • 可随时取消未完成的网络请求,支持断点续传
  • 提供常用的formData拼接方式,可自行扩展
  • 提供请求前网络状态检测,重复请求检测,避免不必要的请求
  • 提供debug回调用于调试

使用方法

头文件的导入

  • 如果是通过 CocoaPods 安装,则:
#import <HLNetworking/HLNetworking.h>
  • 如果是手动下载源码安装,则:
#import "HLNetworking.h"

全局网络配置

[HLNetworkManager setupConfig:^(HLNetworkConfig * _Nonnull config) {
    config.request.baseURL = @"https://httpbin.org/";
    config.request.apiVersion = nil;
}];

通过调用HLNetworkManager+setupConfig:方法,修改block中传入的HLNetworkConfig对象来配置全局网络请求信息,其中可修改的参数如下:

  • tips:提示相关参数
    • generalErrorTypeStr:出现网络请求时使用的错误提示文字,该文字在failure block中的NSError对象返回;默认为:服务器连接错误,请稍候重试
    • frequentRequestErrorStr:用户频繁发送同一个请求,使用的错误提示文字;默认为:请求发送速度太快, 请稍候重试
    • networkNotReachableErrorStr:网络请求开始时,会先检测相应网络域名的Reachability,如果不可达,则直接返回该错误提示;默认为:网络不可用,请稍后重试
    • isNetworkingActivityIndicatorEnabled:请求时是否显示网络指示器(状态栏),默认为 YES
  • request:请求相关参数
    • apiCallbackQueue:自定义的请求队列,如果不设置则自动使用HLNetworkManager默认的队列,该参数默认为 nil
    • defaultParams:默认的parameters,可以在HLAPI中选择是否使用,默认开启,该参数不会被覆盖,HLAPI中使用setParams()后,请求的params中依然会有该参数,默认为 nil
    • defaultHeaders:默认的header,可以在HLAPI中覆盖,默认为 nil
    • baseURL:全局的baseURL,HLAPI的baseURL会覆盖该参数,默认为 nil
    • apiVersion:api版本,用于拼接在请求的Path上,默认为infoPlist中的CFBundleShortVersionString,格式为v{version}{r},审核版本为r,例:http://www.baidu.com/v5/s?ie=UTF-8&wd=abc,默认为 nil
    • isJudgeVersion:是否为审核版本,作用于apiVersion,存储在NSUserDefaults中,key为isR,默认为 NO
    • userAgent:UserAgent,request header中的UA,默认为 nil
    • maxHttpConnectionPerHost:每个Host的最大连接数,默认为 5
    • requestTimeoutInterval:请求超时时间,默认为 15
  • policy:网络策略相关参数
    • AppGroup:后台模式所用的GroupID,该选项只对Task有影响,默认为 nil
    • isBackgroundSession:是否为后台模式,该选项只对Task有影响,默认为 NO
    • isErrorCodeDisplayEnabled:出现网络请求错误时,是否在请求错误的文字后加上{code},默认为YES
    • cachePolicy:请求缓存策略,默认为 NSURLRequestUseProtocolCachePolicy
    • URLCache:URLCache设置,默认为 [NSURLCache sharedURLCache]
  • defaultSecurityPolicy:默认的安全策略配置,该配置在debug模式下默认为HLSSLPinningModeNone,release模式下默认为HLSSLPinningModePublicKey,其中详细参数如下:
    • SSLPinningMode:SSL Pinning证书的校验模式,默认为 HLSSLPinningModeNone
    • allowInvalidCertificates:是否允许使用Invalid 证书,默认为 NO
    • validatesDomainName:是否校验在证书 CN 字段中的 domain name,默认为 YES
    • cerFilePath:cer证书文件路径,默认为 nil
  • enableReachability:是否启用reachability,baseURL为domain,默认为 NO
  • enableGlobalLog:是否开启网络debug日志,该选项会在控制台输出所有网络回调日志,并且在Release模式下无效

Request相关

HLNetworking通过Request发送请求,Request分为HLURLRequestHLAPIRequestHLTaskRequestHLURLRequest为基类,HLAPIRequest为RestfulAPI参数类、HLTaskRequest为用于上传下载任务类

组装api

// 组装请求
HLAPIRequest *get = [HLAPIRequest request].setMethod(GET)
                                .setPath(@"get")
                                .setParams(@{@"user_id": @1})
                                .setDelegate(self);

// 手动拼接formData上传
HLAPIRequest *formDataRequest = [HLAPIRequest request].formData(^(id<HLMultipartFormDataProtocol> formData) {
    [formData appendPartWithHeaders:@{@"contentType": @"html/text"} body:[NSData data]];
});

// 使用HLFormDataConfig对象拼接上传
[HLAPIRequest request].formData([HLFormDataConfig configWithData:imageData
                                                 name:@"avatar"
                                             fileName:@"fileName"
                                             mimeType:@"type"]);

组装task

HLTaskRequest *task = [[HLTaskRequest request].setDelegate(self)
     // 设置Task类型,Upload/Download
     .setTaskType(Upload)
     // 设置下载或者上传的本地文件路径
    .setFilePath([[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"Boom2.dmg"])
    // 设置下载或者上传的地址
    .setCustomURL(@"https://dl.devmate.com/com.globaldelight.Boom2/Boom2.dmg") start];

block方式接收请求

// block接收请求
[get.success(^(id result) {
    NSLog(@"napi 1 --- 已回调 n----");
})
 .progress(^(NSProgress *proc){
    NSLog(@"当前进度:%@", proc);
})
 .failure(^(NSError *error){
    NSLog(@"napi1 --- 错误:%@", error);
})
 .debug(^(HLDebugMessage *message){
    NSLog(@"n debug参数:n 
          sessionTask = %@n 
          api = %@n 
          error = %@n 
          originRequest = %@n 
          currentRequest = %@n 
          response = %@n",
          message.sessionTask,
          message.api,
          message.error,
          message.originRequest,
          message.currentRequest,
          message.response);
}) start];

delegate方式接收请求

// 当前类遵守HLAPIResponseDelegate协议
// 在初始化方法中设置当前类为回调监听
[HLNetworkManager registerResponseObserver:self];

// 在这个宏中写入需要监听的api
HLObserverRequests(self.api1, self.api2)
// 或者用-requestAPIs这个代理方法,这两个完全等效
- (NSArray <__kindof HLURLRequest *>*)observerRequests {
    return [NSArray arrayWithObjects:self.api1, self.api2, self.api3, self.api4, nil];
}

// 在下面三个代理方法中获取回调结果
// 进度的回调
- (void)requestProgress:(nullable NSProgress *)progress atRequest:(nullable HLURLRequest *)request {
    NSLog(@"n%@------RequestProgress--------%@n", request.hashKey, progress);
    NSLog(@"%@", [NSThread currentThread]);
}
// 请求成功的回调
- (void)requestSucess:(nullable id)responseObject atRequest:(nullable HLURLRequest *)request {
    NSLog(@"n%@------RequestSuccessDelegaten", request.hashKey);
    NSLog(@"%@", [NSThread currentThread]);
}
// 请求失败的回调
- (void)requestFailure:(nullable NSError *)error atRequest:(nullable HLURLRequest *)request {
    NSLog(@"n%@------RequestFailureDelegate------%@n", request.hashKey, error);
    NSLog(@"%@", [NSThread currentThread]);
}

// 切记在dealloc中释放当前控制器
- (void)dealloc {
    [HLNetworkManager removeResponseObserver:self];
}

注意1:设置请求URL时,setCustomURL的优先级最高,其次是API中的setBaseURL,最后才是全局config中的baseURL,另无论是哪种baseURL都需要配合setPath使用。

注意2:一次请求必须有{customURL}或者{config.baseURL | api.baseURL}``{api.path},如果{customURL}的参数错写成{api.path}中的无host urlString,也会被自动识别成{api.path}

注意3:一个请求对象的回调 block (success/failure/progress/debug) 是非必需的(默认为 nil)。另外,需要注意的是,success/failure/debug等回调 Block 会在 config 设置的 apiCallbackQueue 队列中被执行,但 progress 回调 Block 将在 NSURLSession 自己的队列中执行,而不是 apiCallbackQueue,但是所有的回调结果都会回落到主线程。

注意4:请求的delegate回调之所以这样设置,是为了可以跨类获取请求回调,因此使用起来稍微麻烦一些,如果只需要在当前类拿到回调,使用block方式即可。

注意5:HLAPIRequest 同样支持其他 HTTP 方法,比如:HEAD, DELETE, PUT, PATCH 等,使用方式与上述类似,不再赘述。

注意6:HLTaskRequest目前支持上传下载功能,下载已支持断点续传,其中上传是指使用AFNetworking的uploadTaskWithRequest:fromFile:progress:completionHandler的方法;如果需要使用POST中的formData拼接方式上传,请参考API相关的formData设置

详见 HLNetworkConfigHLSecurityPolicyConfigHLAPIRequestHLAPITypeHLNetworkManagerHLFormDataConfigHLDebugMessage 等几个文件中的代码和注释,可选参数基本可以覆盖大多数需求。

请求的生命周期方法

// 在api组装时设置当前类为代理
[HLAPIRequest request].setDelegate(self)
[HLTaskRequest request].setDelegate(self)

// 请求即将发出的代理方法
- (void)requestWillBeSent:(HLURLRequest *)request {
    NSLog(@"n%@---willBeSent---", request.hashKey);
}

// 请求已经发出的代理方法
- (void)requestDidSent:(HLURLRequest *)request {
    NSLog(@"n%@---didSent---", request.hashKey);
}

自定义请求结果处理逻辑

// 指定的类需要遵守HLObjReformerProtocol协议
[HLAPIRequest request].setObjReformerDelegate(self);

/**
 一般用来进行JSON -> Model 数据的转换工作。返回的id,如果没有error,则为转换成功后的Model数据。如果有error, 则直接返回传参中的responseObject

 @param api 调用的api
 @param responseObject 请求的返回
 @param error 请求的错误
 @return 整理过后的请求数据
 */
- (id)reformerObject:(id)responseObject 
              andError:(NSError *)error
             atRequest:(HLAPIRequest *)request 
{
    if (responseObject) {
        // 在这里处理获得的数据
        // 自定义reformer方法
        MyModel *model = [MyReformer reformerWithResponse:responseObject];
        return model;
    } else {
        // 在这里处理异常
        return nil;
    }
}

取消一个网络请求

// 通过api取消网络请求
[self.api1 cancel];

// 通过HLNetworkManager取消网络请求
[HLNetworkManager cancel: self.api1];

注意:如果请求已经发出,将无法取消,取消可以注销对应的回调block,但是delegate不会被注销。

批量请求

无序请求

HLNetworking 支持同时发一组批量请求,这组请求在业务逻辑上相关,但请求本身是互相独立的,请求时并行执行,- requestGroupAllDidFinished 会在所有请求都结束时才执行,每个请求的结果由API自身管理。注:HLRequestGroup类做了特殊处理,自身即为HLURLRequest及其子类的容器,因此直接group[index]即可获取相应的HLURLRequest对象,也可以直接遍历;回调中的 group中元素的顺序与每个无序请求 HLURLRequest 对象的先后顺序不保证一致。

HLRequestGroup *group = [HLRequestGroup groupWithMode:HLRequestGroupModeBatch];
// 添加单个api
[group add:[HLAPI API]];
// 添加apis集合
[group addRequests:@[api1, api2, api3, nil]];

[group start];

group.delegate = self;

dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 0.5), dispatch_get_main_queue(), ^{
    // 使用cancel取消
    [group cancel];
});

// group全部完成之后调用 
- (void)requestGroupAllDidFinished:(HLRequestGroup *)group {
    NSLog(@"%@", group);
}

链式请求

HLNetworking 同样支持发一组链式请求,这组请求之间互相依赖,下一请求是否发送以及请求的参数可以取决于上一个请求的结果,请求时串行执行,- chainRequestsAllDidFinished 会在所有请求都结束时才执行,每个请求的结果由API自身管理。注:HLRequestGroup类做了特殊处理,自身即为HLURLRequest及其子类的容器,因此直接group[index]即可获取相应的HLURLRequest对象,也可以直接遍历;回调中的 group中元素的顺序与每个链式请求 HLURLRequest 对象的先后顺序一致。

HLRequestGroup *group = [HLRequestGroup groupWithMode:HLRequestGroupModeChian];
group.delegate = self;
// 设置每次发送几个请求,每次发出的请求之间无依赖
group.maxRequestCount = 1;
[group addRequests:@[self.api1, self.api2, self.api3, self.api4, self.api5]];

[group start];

for (id obj in group) {
    NSLog(@"%@", obj);
}

HLAPIRequest *api = group[0];

// group[0] == self.api1
NSLog(@"%@", api);

dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 0.5), dispatch_get_main_queue(), ^{
    // 使用cancel取消
    [group cancel];
});

// group全部完成之后调用 
- (void)requestGroupAllDidFinished:(HLRequestGroup *)group {
    NSLog(@"%@", group);
}

网络可连接性检查

HLNetworkManager提供了八个方法和四个属性用于获取网络的状态,分别如下:

// reachability的状态
typedef NS_ENUM(NSUInteger, HLReachabilityStatus) {
    HLReachabilityStatusUnknown,
    HLReachabilityStatusNotReachable,
    HLReachabilityStatusReachableViaWWAN,
    HLReachabilityStatusReachableViaWiFi
};

// 通过sharedMager单例,获取当前reachability状态
+ (HLReachabilityStatus)reachabilityStatus;
// 通过sharedMager单例,获取当前是否可访问网络
+ (BOOL)isReachable;
// 通过sharedMager单例,获取当前是否使用数据流量访问网络
+ (BOOL)isReachableViaWWAN;
// 通过sharedMager单例,获取当前是否使用WiFi访问网络
+ (BOOL)isReachableViaWiFi;

// 通过sharedMager单例,开启默认reachability监视器,block返回状态
+ (void)listening:(void(^)(HLReachabilityStatus status))listener;

// 通过sharedMager单例,停止reachability监视器监听domain
+ (void)stopListening;

// 监听给定的域名是否可以访问,block内返回状态
- (void)listeningWithDomain:(NSString *)domain listeningBlock:(void (^)(HLReachabilityStatus))listener;

// 停止给定域名的网络状态监听
- (void)stopListeningWithDomain:(NSString *)domain; 

注意:reachability的监听domain默认为[HLNetworking sharedManager].config.baseURL,当然你也可以通过对象方法自定义domain。

HTTPS 请求的本地证书校验(SSL Pinning)

在你的应用程序包里添加 (pinned) 相应的 SSL 证书做校验有助于防止中间人攻击和其他安全漏洞。HLNetworkingconfig属性和HLAPI里有对AFNetworking 的 AFSecurityPolicy 安全模块的封装,你可以通过配置configdefaultSecurityPolicy属性,用于校验本地保存的证书或公钥可信任。

// SSL Pinning
typedef NS_ENUM(NSUInteger, HLSSLPinningMode) {
    // 不校验Pinning证书
    HLSSLPinningModeNone,
    // 校验Pinning证书中的PublicKey
    HLSSLPinningModePublicKey,
    // 校验整个Pinning证书
    HLSSLPinningModeCertificate
};

// 生成策略
HLSecurityPolicyConfig *securityPolicy = [HLSecurityPolicyConfig policyWithPinningMode:HLSSLPinningModePublicKey];
    // 是否允许使用Invalid 证书,默认为 NO
    securityPolicy.allowInvalidCertificates = NO;
    // 是否校验在证书 CN 字段中的 domain name,默认为 YES
    securityPolicy.validatesDomainName = YES;
    //cer证书文件路径
    securityPolicy.cerFilePath = [[NSBundle mainBundle] pathForResource:@"myCer" ofType:@"cer"];

// 设置默认的安全策略
[HLNetworkManager setupConfig:^(HLNetworkConfig * _Nonnull config) {
    config.defaultSecurityPolicy = securityPolicy;
}];

// 针对特定API的安全策略
self.api1.setSecurityPolicy(securityPolicy);

注意:Request中的安全策略会在此request请求时覆盖默认安全策略,并且与request相同baseURL的安全策略都会被覆盖。

注意1:Task的resume信息记录在沙盒中Cache/com.qkhl.HLNetworking/downloadDict中

Center相关

  • HLAPICenter提供一种离散式API的组织模版,其核心理念是通过category分散APICenter内的API对象;
  • HLBaseObjReformer提供了基于YYModel的JSON->Model的模版;
  • 通过HLAPIMacro中定义的宏,可以快速设置模块所需的API

范例

  • 根据API相关中的设置,配置HLNetworkManager的相关Config
  • 根据模块创建HLAPICenter的category,例如HLAPICenter+home
  • 在HLAPICenter+home.h中使用HLStrongProperty(name)宏,name为方法名,形如:
#import "HLAPICenter.h"

@interface HLAPICenter (home)
HLStrongProperty(home)
@end
  • 在HLAPICenter+home.m中使用HLStrongSynthesize(name, api)宏,name为方法名,api为API对象,形如:
#import "HLAPICenter+home.h"

@implementation HLAPICenter (home)
HLStrongSynthesize(home, [HLAPIRequest request]
                   .setMethod(GET)
                   // 根据需要设置Path、BaseURL、CustomURL
                   .setPath(@"index.php?r=home")
                   // 如果该api对应的model可以直接通过yymodel转换的话,则指定需转换的模型类型名
                   .setResponseClass(@"HLHomeModel")
                   // 这里使用self.defaultReformer即通过yymodel转换
                   .setObjReformerDelegate(self.defaultReformer))
@end
  • 然后就可以愉快的使用了,在控制器中#import "HLAPICenter+home.h",按如下方法使用即可:
- (void)testHome {
    [HLAPICenter.home.setParams(@{@"user_id": @self.myUserID})
    .success(^(HLHomeModel *model) {
        self.model = model;
    }).failure(^(NSError *obj){
        NSLog(@"----%@", obj);
    }) start];
}

Logger相关

  • HLNetworkLogger提供了记录网络请求信息日志的功能,可自定义日志结构,日志头部信息,日志存储类型等

配置Logger

可选参数如下:

  • channelID:渠道ID
  • appKey:app标志
  • appName:app名字
  • appVersion:app版本
  • serviceType:服务名
  • enableLocalLog:是否开启本地日志
  • logAutoSaveCount:日志自动保存数,默认为50次保存一次
  • loggerLevel:日志等级,该选项暂时无效
  • loggerType:日志保存类型,可选JSON或者Plist
  • logFilePath:只读,默认为sandbox/Library/Cache/com.qkhl.HLNetworking/log/{timestamp}.log

  • 范例
[HLNetworkLogger setupConfig:^(HLNetworkLoggerConfig *config) {
    config.enableLocalLog = YES;
    config.logAutoSaveCount = 50;
    config.loggerType = HLNetworkLoggerTypeJSON;
}];
[HLNetworkLogger startLogging];

默认Logger信息

  • HLNetworkLogger默认提供的log信息为HLDebugMessage对象,包括:
    • requestObject api/task请求对象,
    • sessionTask NSURLSessionTask对象,
    • response HLURLResponse对象,
    • queue dispatch_queue_t对象,
    • 具体信息请参考HLDebugMessageHLURLResponseHLURLResult这三个文件中的注释
  • HLNetworkLogger通过管理debugInfoArray数组来存储信息,该数组的首元素为当前APP信息,默认如下:
    • @{@"AppInfo": @{@"OSVersion": [UIDevice currentDevice].systemVersion,
      • @"DeviceType": [UIDevice currentDevice].hl_machineType,
      • @"UDID": [UIDevice currentDevice].hl_udid,
      • @"UUID": [UIDevice currentDevice].hl_uuid,
      • @"MacAddressMD5": [UIDevice currentDevice].hl_macaddressMD5,
      • @"ChannelID": _config.channelID,
      • @"AppKey": _config.appKey,
      • @"AppName": _config.appName,
      • @"AppVersion": _config.appVersion,
      • @"ServiceType": _config.serviceType}}

自定义Logger信息

  • HLNetworkLogger提供自定义log信息内容的方法,该方法每发一次请求,回调时都会调用一次:
// 设置当前类为logger代理,并将当前类遵守HLNetworkCustomLoggerDelegate协议
[HLNetworkLogger setDelegate:self];

// 根据传入的message信息和其他信息组装字典数据
- (NSDictionary *)customInfoWithMessage:(HLDebugMessage *)message {
    return [message toDictionary];
}

// 根据传入的config信息和其他信息组装字典
- (NSDictionary *)customHeaderWithMessage:(HLNetworkLoggerConfig *)config {
    return @{@"AppInfo": @{@"OSVersion": [UIDevice currentDevice].systemVersion,
                           @"DeviceType": [UIDevice currentDevice].hl_machineType,
                           @"UDID": [UIDevice currentDevice].hl_udid,
                           @"UUID": [UIDevice currentDevice].hl_uuid,
                           @"MacAddressMD5": [UIDevice currentDevice].hl_macaddressMD5,
                           @"ChannelID": config.channelID,
                           @"AppKey": config.appKey,
                           @"AppName": config.appName,
                           @"AppVersion": config.appVersion,
                           @"ServiceType": config.serviceType}};
}

更新日志

2.0.2

新增:
1. Request组装在线程安全状态
修复:
1. 修复了请求结束时progressBlock没有释放的问题

环境要求

该库需运行在 iOS 8.0 和 Xcode 7.0以上环境.

集成方法

HLNetworking 可以在CocoaPods中获取,将以下内容添加进你的Podfile中后,运行pod install即可安装:

pod "HLNetworking"

如果你只需要用到网络相关,可以这样:

pod "HLNetworking/Core"

目前有两个模块可供选择:

 - HLNetworking/Core
 - HLNetworking/Center

其中Core包含网络请求相关的所有代码,Center依赖于Core

作者

wangshiyu13, [email protected]

开源协议

HLNetworking is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "HLNetworking",
    "version": "2.0.2",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "homepage": "https://github.com/QianKun-HanLin/HLNetworking",
    "authors": {
        "wangshiyu13": "[email protected]"
    },
    "summary": "u57fau4e8eAFNetworkingu7684u9ad8u9636u7f51u7edcu8bf7u6c42u7ba1u7406u5668",
    "source": {
        "git": "https://github.com/QianKun-HanLin/HLNetworking.git",
        "tag": "2.0.2",
        "submodules": true
    },
    "requires_arc": true,
    "platforms": {
        "ios": "8.0"
    },
    "default_subspecs": "Core",
    "resources": "HLNetworking/Source/Logger/iPhoneTypeDefine.plist",
    "subspecs": [
        {
            "name": "Core",
            "source_files": [
                "HLNetworking/Source/HLNetworking.h",
                "HLNetworking/Source/Generator/**/*.{h,m}",
                "HLNetworking/Source/Manager/**/*.{h,m}",
                "HLNetworking/Source/Engine/**/*.{h,m}",
                "HLNetworking/Source/Logger/**/*.{h,m}",
                "HLNetworking/Source/Config/**/*.{h,m}"
            ],
            "dependencies": {
                "AFNetworking": [
                    "~> 3.1.0"
                ]
            }
        },
        {
            "name": "Center",
            "source_files": "HLNetworking/Source/Center/*.{h,m}",
            "dependencies": {
                "HLNetworking/Core": [],
                "YYModel": []
            }
        }
    ]
}

Pin It on Pinterest

Share This