KBTool 1.0.5

KBTool 1.0.5

×

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

由tudou维护。

KBTool 1.0.5

  • 由
  • TuDou

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+ 需要 build 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 不适用 需要 Xcode 7+。
2.0 -> 2.5.4 iOS 6 OS X 10.8 不适用 不适用 需要 Xcode 5+，《code>NSURLSession 子规范需要 iOS 7 或 OS X 10.9。
1.x iOS 5 Mac OS X 10.7 不适用 不适用
0.10.x iOS 4 Mac OS X 10.6 不适用 不适用

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

使用 Swift 编程？您可以尝试 Alamofire 来获得更传统的 API 集合。

架构

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获取详细信息。