YMHTTP

YMHTTP 是一个适用于 iOS 平台，基于 libcurl 的 IO 多路复用 HTTP 框架，其 API 设计和行为与 NSURLSession 保持高度一致。

因为 YMHTTP 是基于 libcurl 进行封装，所以有着较高的定制性，目前的版本与 NSURLSession 在 API 保持高度一致的同时拓展了 DNS 的能力（包括 SNI 的场景）。

如果你对 DNS 相关的问题比较感兴趣，可以查看这个文章，它汇总了在 iOS 上支持 DNS 需要面临的一些技术难点、相关解决方案以及 YMHTTP 诞生的初衷。

说明

您可以通过 NSURLSession 来查阅具体的细节。
这里有一份非常不错的NSURLSession最全攻略可以查漏补缺(来自搜狐技术产品)。
YMHTTP 和 NSURLSession 非常像，一个是 YM 前缀，一个是 NS 前缀，对外提供的API相互一致
如果您已经非常了解 NSURLSession，那么可以直接查阅 Connect to specific host and port 部分来获取 DNS 相关内容
不支持 System Background Task 相关功能，这个真的无能为力

安装

pod 'YMHTTP', '~> 1.0'

Requirements

iOS 10.0
Xcode 11.3.1
libcurl 7.64.1 + SecureTransport

使用

0x01 YMSession

// 创建 sharedSession
YMURLSession *sharedSession = [YMURLSession sharedSession];

// 使用指定配置创建会话
YMURLSessionConfiguration *config = [YMURLSessionConfiguration defaultSessionConfiguration];
YMURLSession *sessionNoDelegate = [YMURLSession sessionWithConfiguration:config];

// 创建具有指定会话配置，委托和操作队列的会话
YMURLSession *session = [YMURLSession sessionWithConfiguration:config
                                                      delegate:self
                                                 delegateQueue:nil];

0x02 Adding Data Task to a Session

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request;
- (YMURLSessionTask *)taskWithURL:(NSURL *)url;

通过指定 URL 或 Request 来创建一个任务

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request
                    completionHandler:(void (^)(NSData *_Nullable data,
                                                NSHTTPURLResponse *_Nullable response,
                                                NSError *_Nullable error))completionHandler;

- (YMURLSessionTask *)taskWithURL:(NSURL *)url
                completionHandler:(void (^)(NSData *_Nullable data,
                                            NSHTTPURLResponse *_Nullable response,
                                            NSError *_Nullable error))completionHandler;

通过指定 URL 或 Request 来创建任务，在任务完成后调用 completionHandler

Example

delegate 方式

// create
YMURLSessionTask *task = [session taskWithURL:[NSURL URLWithString:@"http://httpbin.org/get"]];
[task resume];

// delegate
- (void)YMURLSession:(YMURLSession *)session task:(YMURLSessionTask *)task didCompleteWithError:(NSError *)error {

}

- (void)YMURLSession:(YMURLSession *)session task:(YMURLSessionTask *)task didReceiveData:(NSData *)data {

}

- (void)YMURLSession:(YMURLSession *)session task:(YMURLSessionTask *)task willCacheResponse:(NSCachedURLResponse *)proposedResponse completionHandler:(void (^)(NSCachedURLResponse * _Nullable))completionHandler {
    completionHandler(proposedResponse);
}

-(void)YMURLSession:(YMURLSession *)session task:(YMURLSessionTask *)task didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(YMURLSessionResponseDisposition))completionHandler {
    completionHandler(YMURLSessionResponseAllow);
}

completionHandler 方式

YMURLSessionTask *task = [session taskWithURL:[NSURL URLWithString:@"http://httpbin.org/get"] completionHandler:^(NSData * _Nullable data, NSHTTPURLResponse * _Nullable response, NSError * _Nullable error) {
    
}];
[task resume];

0x03 Adding Upload Tasks to a Session

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;

- (YMURLSessionTask *)taskWithStreamedRequest:(NSURLRequest *)request;

通过指定 Request 来创建一个上传任务。

taskWithStreamedRequest 方法，会调用 YMURLSession:task:needNewBodyStream: delegate 方法，您需要通过 completionHandler 返回一个 NSInputStream 对象。当然你也可以功过 NSURLMutableRequest 创建对象，并在 bodyStream 传入 NSInputStream 对象。

如果您需要上传大文件，建议您使用 fromFile 方法，虽然 taskWithStreamedRequest 也支持大文件的传输，但其形式为循环执行 读取指定长度内容 -> 上传该内容，该行为在内部的线程是同步的，而 fromFile 方式则会每次异步获取 3 * CURL_MAX_WRITE_SIZE 长度的内容供 libcurl 进行上传（CURL_MAX_WRITE_SIZE 为单次支持最大上传的长度），不仅减少文件 IO 的次数，也减少同步阻塞的时间，优化上传效率。

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request
                             fromFile:(NSURL *)fileURL
                    completionHandler:(void (^)(NSData *_Nullable data,
                                                NSHTTPURLResponse *_Nullable response,
                                                NSError *_Nullable error))completionHandler;

- (YMURLSessionTask *)taskWithRequest:(NSURLRequest *)request
                             fromData:(nullable NSData *)bodyData
                    completionHandler:(void (^)(NSData *_Nullable data,
                                                NSHTTPURLResponse *_Nullable response,
                                                NSError *_Nullable error))completionHandler;

通过指定 Request 来创建任务，在任务完成后调用 completionHandler

0x04 Adding Download Tasks to a Session

- (YMURLSessionTask *)taskWithDownloadRequest:(NSURLRequest *)request;

- (YMURLSessionTask *)taskWithDownloadURL:(NSURL *)url;

通过指定 Request 来创建一个下载任务，并返回临时文件，由于该文件是临时文件，因此必须打开该文件进行读取，或将其移动到应用程序沙盒容器目录中的永久位置，支持大文件下载。

当然你也可以使用 taskWithRequest 和 taskWithURL 来自定义下载任务。

- (YMURLSessionTask *)taskWithDownloadRequest:(NSURLRequest *)request
                            completionHandler:(void (^)(NSURL *_Nullable location,
                                                        NSHTTPURLResponse *_Nullable response,
                                                        NSError *_Nullable error))completionHandler;

- (YMURLSessionTask *)taskWithDownloadURL:(NSURL *)url
                        completionHandler:(void (^)(NSURL *_Nullable location,
                                                    NSHTTPURLResponse *_Nullable response,
                                                    NSError *_Nullable error))completionHandler;

0x05 Connect to specific host and port

- (YMURLSessionTask *)taskWithURL:(NSURL *)url connectToHost:(NSString *)host;

- (YMURLSessionTask *)taskWithURL:(NSURL *)url connectToHost:(NSString *)host connectToPort:(NSInteger)port;

// 创建包含 host port 的 request
[[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:@"https://httpbin.org/get"] connectToHost:@"52.202.2.199"];
[[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:@"https://httpbin.org/get"] connectToHost:@"52.202.2.199" connectToPort:443];
[[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:@"https://httpbin.org/get"]
                           connectToHost:@"52.202.2.199"
                           connectToPort:443
                             cachePolicy:NSURLRequestUseProtocolCachePolicy
                         timeoutInterval:60];

连接到特定的主机和端口，其中 host 支持 IP 的形式。如果使用正常的域名+host+port的请求方式，那么对于框架内部可以自动处理 Cookie，Cache 以及 302 等问题，当然该接口也支持 SNI 的场景。

备注：该接口不会影响到 DNS Cache，了解更多可以看这里 https://curl.haxx.se/libcurl/c/CURLOPT_CONNECT_TO.html

libcurl

libcurl is free, thread-safe, IPv6 compatible, feature rich, well supported, fast, thoroughly documented and is already used by many known, big and successful companies.

libcurl是免费的，线程安全的，IPv6兼容的，功能丰富，支持良好，速度快，有完整的文档记录，已经被许多知名的，大的和成功的公司使用。

您也可以通过这里查看更多的内容：https://curl.haxx.se/

libcurl 版本

当前使用 libcurl 7.64.1 的版本，与 macOS Catalina 中保持一致，使用curl-android-ios进行构建，你也可以选择喜欢的版本进行构建

HTTP/2

目前版本不支持 HTTP/2，你可以使用 Build-OpenSSL-cURL 进行构建支持 HTTP/2 功能的版本。

注意 Build-OpenSSL-cURL 中使用的是 openSSL，而目前 macOS Catalina 中则是使用 LibreSSL，我在 Build-OpenSSL-cURL 的基础上修改了一个支持 libresll 的版本，链接地址：https://github.com/zymxxxs/libcurl-nghttp2-libressl-ios

备注：

支持 HTTP/2 需要考虑包大小的影响
目前一期的工作量主要是对外接口与 NSURLSession 对齐以及支持 DNS，HTTP/2 暂时不在支持范围内，所以上述脚本只能保证构建出静态库，暂无做过较多的验证，请知悉。

最后

如果看过 swift-corelibs-foundation 的相关源码，你会发现其 NSURLSession 系列的功能（HTTP、FTP）则是基于 libcurl 进行的封装。如果你想学习它，建议你直接去学习官方源码，YMHTTP 也是参考其中大量的实现，然后补充一些尚未实现的功能以及修复了一些BUG。

YMHTTP 之所以诞生，初衷是为了 彻底 解决 HTTP DNS 的问题（性能+SNI 场景+ Cache + Cookies + 302 ），现在回头来看，倒像是切开了一道口，获取了更多的自由度，如果您需要什么功能，请 ISSUE 告诉我。

如何贡献

非常欢迎你的加入! 提一个Issue 或者提交一个 Pull Request。

License

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

感谢

lindean 破老师，目前就职于PDD。感谢其初版 HTTP DNS 的实现，作为先驱者，填了无数坑，尤其是 libcurl 中各种参数以及 Cache 层的相关实现
amendgit 二老师，人称二哥，目前就职于支付宝，感谢其在 IO 多路复用 上解惑与指导
libcurl
swift-corelibs-foundation
curl-android-ios
Build-OpenSSL-cURL

TODO:

目前指定 IP 的能力通过 CURLOPT_CONNECT_TO 来解决，其好处是不会影响 DNS Cache，但是在 Charles 中会直接显示 IP 的请求。待考虑是否替换为 CURLOPT_RESOLVE 参数，不过对于 DNS Cache 的问题，是需要影响还是不能影响需要删除？或者是说DNS的能力，使用 CURLOPT_CONNECT_TO 还是 CURLOPT_RESOLVE 哪一个更为合理？
目前大部分还是基于 AFNetworking 进行分封装，待考虑是否提供一个 YMNetworking 版本便于接入？也可以参考 retrofit 的接口实现？
NSURLSessionTaskMetrics 待实现。使用 curl_easy_getinfo 实现，目前实现这个功能，代码改动较大，需要着重设计下，目前属于重要不紧急，可以延后。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

YMHTTP

说明

安装

Requirements

使用

0x01 YMSession

0x02 Adding Data Task to a Session

Example

0x03 Adding Upload Tasks to a Session

0x04 Adding Download Tasks to a Session

0x05 Connect to specific host and port

libcurl

libcurl 版本

HTTP/2

最后

如何贡献

License

感谢

TODO:

Files

README.md

Latest commit

History

README.md

File metadata and controls

YMHTTP

说明

安装

Requirements

使用

0x01 YMSession

0x02 Adding Data Task to a Session

Example

0x03 Adding Upload Tasks to a Session

0x04 Adding Download Tasks to a Session

0x05 Connect to specific host and port

libcurl

libcurl 版本

HTTP/2

最后

如何贡献

License

感谢

TODO: