QW_Http 1.4.0

QW_Http 1.4.0

×

测试已测试✗
Lang语言 Obj-CObjective C
许可证 MIT
发布最后发布2017年12月

由 hwzss 维护。

QW_Http 1.4.0

  • 作者：
  • hwzss

AFNetworking

Build Status
codecov.io
CocoaPods Compatible
Carthage Compatible
Platform
Twitter

AFNetworking 是为 iOS 和 Mac OS X 设计的一个令人愉快的网络库。它建立在 Foundation URL 加载系统之上，扩展了 Cocoa 中内置的强大的高级网络抽象。它具有模块化架构，具有精心设计的，功能丰富的 API，使用起来非常愉快。

然而，所有功能中最重要的也许是那些每天使用和贡献 AFNetworking 的开发者们。AFNetworking 为 iPhone、iPad 和 Mac 上一些最受欢迎和备受赞誉的应用程序提供支持。

选择 AFNetworking 作为您的下一个项目，或迁移您的现有项目——您会为您的决定感到高兴的！

如何入门

通信

  • 如果您需要帮助，请使用 Stack Overflow。（标签 'afnetworking'）
  • 如果您想提问，请使用 Stack Overflow。
  • 如果您发现了一个错误，并且可以提供可靠重现错误的步骤，请打开一个问题。
  • 如果您有一个功能请求，请打开一个问题。
  • 如果您想贡献力量，请提交一个撤回请求。

安装

AFNetworking 支持多种方法在项目中安装库。

CocoaPods 安装

CocoaPods 是 Objective-C 依赖项管理器，它自动简化了在项目中使用像 AFNetworking 这样的第三方库的过程。有关更多信息，请参阅“入门”指南。您可以使用以下命令安装它：

$ gem install cocoapods

需要 CocoaPods 0.39.0+ 来构建 AFNetworking 3.0.0+。

Podfile

要使用 CocoaPods 将 AFNetworking 集成到您的 Xcode 项目中，请在您的 Podfile 中指定它

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

pod 'AFNetworking', '~> 3.0'

然后，运行以下命令

$ pod install

Carthage 安装

Carthage 是一个分散式的依赖项管理器，它构建您的依赖项并向您提供二进制框架。

您可以使用以下命令使用 homebrew 安装 Carthage：

$ brew update
$ brew install carthage

要使用 Carthage 将 AFNetworking 集成到您的 Xcode 项目中，请在您的 Cartfile 中指定它

github "AFNetworking/AFNetworking" ~> 3.0

运行 carthage 来构建框架，并将构建好的 AFNetworking.framework 拖动到您的 Xcode 项目中。

要求

AFNetworking 版本 最低 iOS 目标 最低 OS X 目标 最低 watchOS 目标 最低 tvOS 目标 注意事项
3.x iOS 7 OS X 10.9 watchOS 2.0 tvOS 9.0 需要 Xcode 7+。已移除 NSURLConnectionOperation 支持。
2.6 -> 2.6.3 iOS 7 OS X 10.9 watchOS 2.0 n/a 需要 Xcode 7+。
2.0 -> 2.5.4 iOS 6 OS X 10.8 n/a n/a 需要 Xcode 5+。需要 iOS 7 或 OS X 10.9 才能使用 NSURLSession 子规格。
1.x iOS 5 Mac OS X 10.7 n/a n/a
0.10.x iOS 4 Mac OS X 10.6 n/a n/a

（OS X 项目必须支持 64 位和现代 Cocoa 运行时）。

在 Swift 中编程？尝试使用更传统的 API 集合的 Alamofire。

架构

NSURLSession

  • AFURLSessionManager
  • AFHTTPSessionManager

序列化

  • <AFURLRequestSerialization>
    • AFHTTPRequestSerializer
    • AFJSONRequestSerializer
    • AFPropertyListRequestSerializer
  • <AFURLResponseSerialization>
    • AFHTTPResponseSerializer
    • AFJSONResponseSerializer
    • AFXMLParserResponseSerializer
    • AFXMLDocumentResponseSerializer （Mac OS X）
    • AFPropertyListResponseSerializer
    • AFImageResponseSerializer
    • AFCompoundResponseSerializer

额外功能

  • AFSecurityPolicy
  • AFNetworkReachabilityManager

用法

AFURLSessionManager

AFURLSessionManager 根据指定的 NSURLSessionConfiguration 对象创建和管理一个 NSURLSession 对象，该对象遵循 <NSURLSessionTaskDelegate>、<NSURLSessionDataDelegate>、<NSURLSessionDownloadDelegate> 和 <NSURLSessionDelegate>。

创建下载任务

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://example.com/download.zip"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:nil destination:^NSURL *(NSURL *targetPath, NSURLResponse *response) {
    NSURL *documentsDirectoryURL = [[NSFileManager defaultManager] URLForDirectory:NSDocumentDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:NO error:nil];
    return [documentsDirectoryURL URLByAppendingPathComponent:[response suggestedFilename]];
} completionHandler:^(NSURLResponse *response, NSURL *filePath, NSError *error) {
    NSLog(@"File downloaded to: %@", filePath);
}];
[downloadTask resume];

创建上传任务

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://example.com/upload"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURL *filePath = [NSURL fileURLWithPath:@"file://path/to/image.png"];
NSURLSessionUploadTask *uploadTask = [manager uploadTaskWithRequest:request fromFile:filePath progress:nil completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
    if (error) {
        NSLog(@"Error: %@", error);
    } else {
        NSLog(@"Success: %@ %@", response, responseObject);
    }
}];
[uploadTask resume];

创建多部分请求的上传任务，并带有进度

NSMutableURLRequest *request = [[AFHTTPRequestSerializer serializer] multipartFormRequestWithMethod:@"POST" URLString:@"http://example.com/upload" parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> formData) {
        [formData appendPartWithFileURL:[NSURL fileURLWithPath:@"file://path/to/image.jpg"] name:@"file" fileName:@"filename.jpg" mimeType:@"image/jpeg" error:nil];
    } error:nil];

AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];

NSURLSessionUploadTask *uploadTask;
uploadTask = [manager
              uploadTaskWithStreamedRequest:request
              progress:^(NSProgress * _Nonnull uploadProgress) {
                  // This is not called back on the main queue.
                  // You are responsible for dispatching to the main queue for UI updates
                  dispatch_async(dispatch_get_main_queue(), ^{
                      //Update the progress view
                      [progressView setProgress:uploadProgress.fractionCompleted];
                  });
              }
              completionHandler:^(NSURLResponse * _Nonnull response, id  _Nullable responseObject, NSError * _Nullable error) {
                  if (error) {
                      NSLog(@"Error: %@", error);
                  } else {
                      NSLog(@"%@ %@", response, responseObject);
                  }
              }];

[uploadTask resume];

创建数据任务

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://httpbin.org/get"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURLSessionDataTask *dataTask = [manager dataTaskWithRequest:request completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
    if (error) {
        NSLog(@"Error: %@", error);
    } else {
        NSLog(@"%@ %@", response, responseObject);
    }
}];
[dataTask resume];

请求序列化

请求序列化器从 URL 字符串中创建请求，将参数编码为查询字符串或 HTTP 主体。

NSString *URLString = @"http://example.com";
NSDictionary *parameters = @{@"foo": @"bar", @"baz": @[@1, @2, @3]};

查询字符串参数编码

[[AFHTTPRequestSerializer serializer] requestWithMethod:@"GET" URLString:URLString parameters:parameters error:nil];
GET http://example.com?foo=bar&baz[]=1&baz[]=2&baz[]=3

URL 表单参数编码

[[AFHTTPRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];
POST http://example.com/
Content-Type: application/x-www-form-urlencoded

foo=bar&baz[]=1&baz[]=2&baz[]=3

JSON 参数编码

[[AFJSONRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];
POST http://example.com/
Content-Type: application/json

{"foo": "bar", "baz": [1,2,3]}

网络可达性管理器

AFNetworkReachabilityManager 监控 WWAN 和 WiFi 网络接口的域和地址的可达性。

  • 不要使用可达性来决定是否发送原始请求。
    • 您应尝试发送它。
  • 您可以使用可达性来确定何时应自动重试请求。
    • 尽管它可能会失败，但当一个网络连接的可达性通知变得可用时，是一个重试的好时机。
  • 网络可达性是确定请求失败原因的有用工具。
    • 在网络请求失败后，告诉用户他们处于离线状态，比给他们一个更技术但更准确的错误，如“请求超时”要好。

另请参阅WWDC 2012 讲座 706，"网络最佳实践"。。

共享网络可达性

[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
    NSLog(@"Reachability: %@", AFStringFromNetworkReachabilityStatus(status));
}];

[[AFNetworkReachabilityManager sharedManager] startMonitoring];

安全策略

AFSecurityPolicy 评估通过安全连接在固定的 X.509 证书和公钥上对服务器的信任。

将固定的 SSL 证书添加到您的应用程序可以帮助防止中间人攻击和其他漏洞。强烈建议处理敏感客户数据或财务信息的应用程序，通过配置并启用 SSL 锚定，将所有通信路由到 HTTPS 连接。

允许无效的 SSL 证书

AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production

单元测试

AFNetworking 在 Tests 子目录中包含了一套单元测试。您可以通过在平台框架上执行测试操作来简单地运行这些测试。

致谢

AFNetworking 由 Alamofire 软件基金会 拥有和维护。

AFNetworking最初由Scott Raymond和Mattt Thompson在开发iPhone的Gowalla时创建。

AFNetworking的标志由Alan Defibaugh设计。

最重要的是，感谢AFNetworking日益增长的贡献者名单。

安全披露

如果您认为您已经发现AFNetworking的安全漏洞，请尽快通过电子邮件[email protected]报告。请勿将其发布到公共问题跟踪器。

许可证

AFNetworking遵循MIT许可证发布。请参阅LICENSE以获取详细信息。