XMNetworking 1.1.0

XMNetworking 1.1.0

×

测试已测试✓
Lang语言 Obj-CObjective C
许可证 MIT
发布上次发布2018年4月

由Zubin Kang维护。

XMNetworking 1.1.0

  • 作者：
  • Zubin Kang

XMNetworking

英文文档

XMNetworking 是一个轻量级、简单易用但功能强大的网络库，基于 AFNetworking 3.0+ 实现封装。

其中，前缀 XM 是我们团队 Xcode-Men 的缩写。

Platform Language CocoaPods Carthage License

简介

XMNetworking

如上图所示，XMNetworking 采用中心化设计，由 XMCenter 统一发起并管理所有 XMRequest 请求，并可通过 XMCenter 为所有请求配置回调线程、公共 Server URL、Header、Parameter 等信息。同时，也可以通过 Block 注入的方式对所有请求进行预处理以及实现自定义的请求响应结果处理逻辑，如数据模型转换、业务错误码判断、网络缓存等。另外增加了 XMEgine 这一层是为了隔离底层第三方库依赖，便于以后切换其他底层网络库或自己实现底层逻辑。

特性

  • 简单易用，发送请求只需调用一个方法，通过 Block 配置信息，代码紧凑；
  • 功能强大，适用于几乎所有网络请求的使用场景（普通请求、上传、下载）；
  • 专为 RESTful Server API 设计，并提供多种不同的请求和响应的序列化类型；
  • 支持批量请求、链式请求等复杂业务逻辑的网络需求;
  • 可随时取消未完成的网络请求，支持自动重试失败的请求；
  • 全局配置所有请求的公共信息，自定义回调线程以及响应处理逻辑；
  • 支持检查网络连接类型，并集成 AFNetworking 强大的安全策略模块。

系统要求

  • iOS 7.0 以上系统
  • Xcode 7.3 或更高版本

安装说明

CocoaPods

在你的工程 Podfile 文件中添加以下一行，并执行 pod install 或 pod update。

pod 'XMNetworking', '~> 1.1.0'

注意： XMNetworking 会自动依赖 AFNetworking 3.0+ ，因此你工程中的 Podfile 文件无需再次添加 pod AFNetworking 来导入 AFNetworking。

Carthage (仅支持 iOS 8 及以上版本)

与 CocoaPods 不同，Carthage 是一个去中心化的第三方依赖库管理工具。它将自动编译你依赖的第三方库并以 framework 的形式提供给你。

你可以使用 Homebrew 执行以下命令来安装 Carthage：

$ brew update
$ brew install carthage

安装完 Carthage 后，在你的工程 Cartfile 文件中添加以下一行：

github "AFNetworking/AFNetworking" ~> 3.0
github "kangzubin/XMNetworking" ~> 1.1.0

然后执行 carthage update --platform ios 命令生成 framework 包，并将生成的 XMNetworking.framework 和 AFNetworking.framework 拖拽到你的工程中。

手动安装

下载 XMNetworking 子文件夹内容以及 AFNetworking 代码，并将它们的源文件添加（拖放）到你的工程中。

使用教程

头文件的导入

  • 如果通过 CocoaPods 或 Carthage 安装，则
#import <XMNetworking/XMNetworking.h>
  • 如果手动下载源码安装，则
#import "XMNetworking.h"

全局网络配置

[XMCenter setupConfig:^(XMConfig *config) {
    config.generalServer = @"general server address";
    config.generalHeaders = @{@"general-header": @"general header value"};
    config.generalParameters = @{@"general-parameter": @"general parameter value"};
    config.generalUserInfo = nil;
    config.callbackQueue = dispatch_get_main_queue();
    config.engine = [XMEngine sharedEngine];
#ifdef DEBUG
    config.consoleLog = YES;
#endif
}];

您可以调用 XMCenter 的 +setupConfig: 类方法，通过修改传入的 XMConfig 对象来配置全局网络请求的公共信息，包括以下内容：

  • generalServer：公共服务端地址，如果一个 XMRequest 请求对象的 server 属性为 nil，且其 useGeneralServer 为 YES（默认），那么该请求的服务端地址 server 将会取 XMCenter 中 generalServer 的值。
  • generalParameters：公共请求参数，如果一个 XMRequest 请求对象的 useGeneralParameters 属性为 YES（默认），并且 XMCenter 的公共参数 generalParameters 不为空，那么这些公共参数会自动加到该请求的 parameters 中。
  • generalHeaders：公共请求头，如果一个 XMRequest 请求对象的 useGeneralHeaders 属性为 YES（默认），并且 XMCenter 的公共请求头 generalHeaders 不为空，那么这些公共请求头会自动加到该请求的 headers 中。
  • generalUserInfo：公共用户信息，默认为 nil，如果一个 XMRequest 请求对象的 userInfo 属性为 nil（默认）而该字段不为 nil，那么该字段会自动赋值给 XMRequest 对象的 userInfo。而 userInfo 属性可用于区分具有相同上下文信息的不同请求。
  • callbackQueue：请求的回调 Block 执行的 dispatch 队列（线程），如果为 NULL（默认），那么会在一个私有的并发队列（子线程）中执行回调 Block。
  • engine：底层请求的引擎，默认为 [XMEngine sharedEngine] 单例对象，你也可以初始化一个 XMEngine 对象给它赋值。
  • consoleLog：一个 BOOL 值，用于表示是否在控制台输出请求和响应的信息，默认为 NO。

此外，您可以通过调用 XMCenter 的以下两个类方法来随时修改全局公共的 header 和 parameter：

+ (void)setGeneralHeaderValue:(nullable NSString *)value forField:(NSString *)field;
+ (void)setGeneralParameterValue:(nullable NSString *)value forKey:(NSString *)key;

普通请求

GET

[XMCenter sendRequest:^(XMRequest *request) {
    request.url = @"http://example.com/v1/foo/bar";
    request.httpMethod = kXMHTTPMethodGET;
} onSuccess:^(id responseObject) {
   NSLog(@"onSuccess: %@", responseObject);
} onFailure:^(NSError *error) {
   NSLog(@"onFailure: %@", error);
}];

**注意1：**可以通过以下两种方法设置 request 对象的 URL 地址，但当 server、api 和 url 三个属性被同时赋值时，url 的优先级比较高，此时 server、api 的值会被忽略。

request.url = @"http://example.com/v1/foo/bar";
// 如果 request.server 为 `nil`，且 request.useGeneralServer 为 `YES`，那么此时 request.server 会取 XMCenter.generalServer 的值。
request.server = @"http://example.com/v1/";
request.api = @"foo/bar";

**注意2：**一个请求对象的回调 Block (success/failure/finished/progress) 是非必需的（默认为 nil），XMCenter 提供了多个设置不同回调 Block 参数的方法用于发送请求。另外，需要注意的是，success/faillure/finished 等回调 Block 会在 XMCenter 设置的 callbackQueue 队列中被执行，但 progress 回调 Block 将在 NSURLSession 自己的队列中执行，而不是 callbackQueue。

POST

[XMCenter sendRequest:^(XMRequest *request) {
    //request.server = @"http://example.com/v1/"; // 可选，如果为空则读取 XMCenter.generalServer
    request.api = @"foo/bar";
    request.parameters = @{@"param1": @"value1", @"param2": @"value2"};
    request.httpMethod = kXMHTTPMethodPOST; // 可选，默认为 `POST`
    request.requestType = kXMRequestNormal; // 可选，默认为 `Normal`
} onSuccess:^(id responseObject) {
   NSLog(@"onSuccess: %@", responseObject);
} onFailure:^(NSError *error) {
   NSLog(@"onFailure: %@", error);
} onFinished:^(id responseObject, NSError *error) {
   NSLog(@"onFinished");
}];

其他 HTTP 方法

XMRequest 同样支持其他 HTTP 方法，比如：HEAD、DELETE、PUT、PATCH 等，使用方式与上述类似，不再赘述。

详细信息请参考 XMConst、XMRequest 和 XMCenter 等文件中的代码和注释。

上传请求

// `NSData` form data.
UIImage *image = [UIImage imageNamed:@"testImage"];
NSData *fileData1 = UIImageJPEGRepresentation(image, 1.0);
// `NSURL` form data.
NSString *path = [NSHomeDirectory() stringByAppendingString:@"/Documents/testImage.png"];
NSURL *fileURL2 = [NSURL fileURLWithPath:path isDirectory:NO];

[XMCenter sendRequest:^(XMRequest *request) {
    request.server = @"http://example.com/v1/";
    request.api = @"foo/bar";
    request.requestType = kXMRequestUpload;
    [request addFormDataWithName:@"image[]" fileName:@"temp.jpg" mimeType:@"image/jpeg" fileData:fileData1];
    [request addFormDataWithName:@"image[]" fileURL:fileURL2];
    // see `XMUploadFormData` for more details.
} onProgress:^(NSProgress *progress) {
    // the progress block is running on the session queue.
    if (progress) {
        NSLog(@"onProgress: %f", progress.fractionCompleted);
    }
} onSuccess:^(id responseObject) {
    NSLog(@"onSuccess: %@", responseObject);
} onFailure:^(NSError *error) {
    NSLog(@"onFailure: %@", error);
} onFinished:^(id responseObject, NSError *error) {
    NSLog(@"onFinished");
}];

下载请求

[XMCenter sendRequest:^(XMRequest *request) {
    request.url = @"http://example.com/v1/testDownFile.zip";
    request.downloadSavePath = [NSHomeDirectory() stringByAppendingString:@"/Documents/"];
    request.requestType = kXMRequestDownload;
} onProgress:^(NSProgress *progress) {
    // the progress block is running on the session queue.
    if (progress) {
        NSLog(@"onProgress: %f", progress.fractionCompleted);
    }
} onSuccess:^(id responseObject) {
    NSLog(@"onSuccess: %@", responseObject);
} onFailure:^(NSError *error) {
    NSLog(@"onFailure: %@", error);
}];

序列化

在 XMRequest 中有两个属性 requestSerializerType 和 responseSerializerType，分别用于设置请求参数和响应结果的序列化类型。

其中，XMRequestSerializerType 和 XMResponseSerializerType 枚举的定义如下：

typedef NS_ENUM(NSInteger, XMRequestSerializerType) {
    kXMRequestSerializerRAW     = 0, // default
    kXMRequestSerializerJSON    = 1,
    kXMRequestSerializerPlist   = 2,
};
typedef NS_ENUM(NSInteger, XMResponseSerializerType) {
    kXMResponseSerializerRAW    = 0,
    kXMResponseSerializerJSON   = 1, // default
    kXMResponseSerializerPlist  = 2,
    kXMResponseSerializerXML    = 3,
};

详情请参考 AFURLRequestSerialization.h 和 AFURLResponseSerialization.h 以获取更多细节。

预处理和后处理插件

请求预处理

你可以通过调用 [XMCenter setRequestProcessBlock:...] 来设置 XMCenter 的预处理插件，在这里对所有请求进行统一处理。需要注意的是，这个 requestProcessBlock 只对普通/上传/下载的请求有效，对于批量请求和链式请求中的 XMRequest 对象，则不会走这个逻辑。

[XMCenter setRequestProcessBlock:^(XMRequest *request) {
    // 自定义请求预处理逻辑
    request.httpMethod = kXMHTTPMethodPOST;
    request.requestSerializerType = kXMRequestSerializerRAW;
    request.responseSerializerType = kXMResponseSerializerRAW;
}];

自定义响应结果的处理逻辑

通常情况下，一个请求成功结束时，会执行 success block，而当有错误发生时，会执行 failure block。但在实际开发中，更常见的情况是，即使一个请求成功结束，我们也需要进一步处理，比如验证响应结果数据、判断业务错误的类型等，然后再决定是否执行 success block 或 failure block。

现在，你可以通过调用 [XMCenter setResponseProcessBlock:...] 方法以注入 Block 的方式设置自定义的处理逻辑，这个 Block 会在成功 block 被执行前调用。如果传入的 *error 参数被赋值，则会执行 failure block。此外，你还可以通过修改 Block 的返回值来替换 responseObject 的值，即如果 Block 的返回值不为空，则 responseObject 会被替换。

在这里，你可以对全局请求进行统一处理，包括业务错误码判断、数据模型转换、网络缓存等操作！

[XMCenter setResponseProcessBlock:^id(XMRequest *request, id responseObject, NSError *__autoreleasing *error) {
    // 自定义响应结果处理逻辑，如果 `*error` 被赋值，则接下来会执行 failure block。
    return nil; // or return a new object to reset value for responseObject
}];

错误信息统一过滤

你可以在 [XMCenter setErrorProcessBlock:...] 方法中统一处理全局网络请求的错误。

[XMCenter setErrorProcessBlock:^(XMRequest *request, NSError *__autoreleasing * error) {
   // 比如对不同的错误码统一错误提示等
}];

批量请求

XMNetworking 支持同时发送一组相关但独立的批量请求，所有请求成功结束时才执行 success block，一旦有请求失败，则执行 failure block。注意：回调 block 中的 responseObjects 和 errors 元素顺序与 XMRequest 对象在 batchRequest.requestArray 中的顺序一致。

[XMCenter sendBatchRequest:^(XMBatchRequest *batchRequest) {
    XMRequest *request1 = [XMRequest request];
    request1.url = @"server url 1";
    // set other properties for request1
        
    XMRequest *request2 = [XMRequest request];
    request2.url = @"server url 2";
    // set other properties for request2
        
    [batchRequest.requestArray addObject:request1];
    [batchRequest.requestArray addObject:request2];
} onSuccess:^(NSArray *responseObjects) {
    NSLog(@"onSuccess: %@", responseObjects);
} onFailure:^(NSArray *errors) {
    NSLog(@"onFailure: %@", errors);
} onFinished:^(NSArray *responseObjects, NSArray *errors) {
    NSLog(@"onFinished");
}];

[XMCenter sendBatchRequest:...] 方法返回新发起 XMBatchRequest 对象的唯一标识符 identifier，你可通过 identifier 调用 XMCenter 的 cancelRequest: 方法取消这组批量请求。

链式请求

XMNetworking 同样支持发送一组依赖的链式请求，所有请求成功结束时才执行 success block，一旦有请求失败，则执行 failure block。注意：回调 block 中的 responseObjects 和 errors 元素顺序与链式请求 XMRequest 对象的顺序一致。

[XMCenter sendChainRequest:^(XMChainRequest *chainRequest) {
    [[[[chainRequest onFirst:^(XMRequest *request) {
        request.url = @"server url 1";
        // set other properties for request
    }] onNext:^(XMRequest *request, id responseObject, BOOL *sendNext) {
        NSDictionary *params = responseObject;
        if (params.count > 0) {
            request.url = @"server url 2";
            request.parameters = params;
        } else {
            *sendNext = NO;
        }
    }] onNext:^(XMRequest *request, id responseObject, BOOL *sendNext) {
        request.url = @"server url 3";
        request.parameters = @{@"param1": @"value1", @"param2": @"value2"};
    }] onNext: ...];    
} onSuccess:^(NSArray *responseObjects) {
    NSLog(@"onSuccess: %@", responseObjects);
} onFailure:^(NSArray *errors) {
    NSLog(@"onFailure: %@", errors);
} onFinished:^(NSArray *responseObjects, NSArray *errors) {
    NSLog(@"onFinished");
}];

[XMCenter sendChainRequest:...] 方法返回新发起 XMChainRequest 对象的唯一标识符 identifier，你可通过 identifier 调用 XMCenter 的 cancelRequest: 方法取消这组链式请求。

取消一个网络请求

当调用 [XMCenter sendRequest:...] 方法发送网络请求时，该方法会返回唯一标识请求对象的 identifier（如果请求失败，则值为 nil）。在需要时，你可通过此 identifier 来取消当前网络请求（如果一个请求已结束，再次使用 identifier 来取消请求时将直接忽略）。

// send a request
NSString identifier = [XMCenter sendRequest:^(XMRequest *request) {
    request.url = @"http://example.com/v1/foo/bar";
    request.httpMethod = kXMHTTPMethodGET;
    request.timeoutInterval = 10;
    request.retryCount = 1;
} onFailure:^(NSError *error) {
    NSLog(@"onFailure: %@", error);
}];

// your business code
sleep(2);

// cancel the running request by identifier with cancel block
[XMCenter cancelRequest:identifier onCancel:^(XMRequest *request) {
    NSLog(@"onCancel");
}];

**注意：**调用 XMCenter cancelRequest:onCancel: 方法取消网络请求时，被取消的请求对象（如果存在）会以参数的形式传递到 cancel block，另外 cancel block 是在调用 cancelRequest: 方法的线程中执行，而不是 XMCenter 的 callbackQueue。

网络可连接性检查

我们提供了两种方法用于获取网络的可连接性，如下所示：

  • 该方法返回一个布尔值，表示当前网络是否可连接。
[[XMCenter defaultCenter] isNetworkReachable];
  • 该方法返回当前网络的状态值（XMNetworkConnectionType 枚举），-1 表示 Unknown，0 表示 NotReachable，1 表示 WWAN，2 表示 WiFi。
[[XMCenter defaultCenter] networkConnectionType];

有关更多细节，请参阅 AFNetworkReachabilityManager。

HTTPS 请求的本地证书校验（SSL Pinning）

在你的应用程序包里添加（固定 Crypto）相应的SSL证书进行校验，有助于防止中间人攻击和其他安全漏洞。AFNetworking 的 AFSecurityPolicy 安全模块可以通过校验本地保存的证书或公钥帮助判断服务器是否值得信任以及建立安全连接。

在 XMNetworking 中，我们对 AFSecurityPolicy 进行了封装以便于使用，你可以通过 XMCenter 的 addSSLPinningURL: 方法添加需要做 SSL Pinning 的域名：

[XMCenter addSSLPinningURL:@"https://example.com/"];

默认情况下，你只需将该域名对应的 .cer 格式的证书拖拽到你的工程中即可（即 .cer 所在的 Bundle 需要与 XMNetworking 代码所在的 Bundle 一致）。如果你是以 embedded framework 的方式（Carthage）集成 XMNetworking，则需要按照以下方式添加证书：

// Add SSL Pinning Certificate
NSString *certPath = [[NSBundle bundleForClass:[self class]] pathForResource:@"certificate file name" ofType:@"cer"];
NSData *certData = [NSData dataWithContentsOfFile:certPath];
[XMCenter addSSLPinningCert:certData];
[XMCenter addSSLPinningURL:@"https://example.com/"];

详见 AFSecurityPolicy 了解更多细节。

文档

详见 XMNetworking 文档链接。

单元测试

XMNetworking 包含一系列单元测试，用于验证网络请求的正确性，详见 XMNetworkingDemoTests 文件夹中的测试案例。

结构

XMNetworking 的代码结构非常简洁和紧凑，只包含了 4 个核心文件：XMConst.h 用于定义全局常量和枚举、Block，XMRequest，XMCenter 和 XMEngine 是核心类声明和实现，具体的代码结构如图所示：

XMNetworking Structure

待完善

  • 支持断点下载
  • 支持网络层缓存
  • 兼容 tvOS/watchOS/macOS 测试
  • 更强大的自定义模型转换
  • 实现一套可扩展的插件机制，便于 XMNetworking 增加新功能

作者

贡献者

许可证

XMNetworking 使用 MIT 许可证，详情见 LICENSE 文件。