SZHakawai 0.1.13

SZHakawai 0.1.13

测试已测试
语言语言 Obj-CObjective C
许可证 Apache 2
发布上次发布2016年11月

Jaja Yting 维护。



 
依赖
BonMot~> 3.2
SZFontAwesomeKit~> 2.2.3
PINRemoteImage~> 2.1.4
 

SZHakawai 0.1.13

  • Austin Zheng 和 Jaja

AFNetworking 是适用于 iOS 和 Mac OS X 的卓越的网络库。它是建立在 Foundation URL 加载系统之上,扩展了 Cocoa 中内置的强大高级网络抽象。它具有模块化架构,API 设计得当、功能丰富,易于使用。

然而,最重要的特性也许是使用并每天为 AFNetworking 贡献的开发者社区。AFNetworking 为 iPhone、iPad 和 Mac 上的一些最受欢迎和赞誉备至的应用提供动力。

为您的下一个项目选择 AFNetworking,或者将现有项目转换为 AFNetworking——您会为此感到高兴的!

如何开始使用

沟通

  • 如果您需要帮助,请使用 Stack Overflow。{(标签 'afnetworking')}}
  • 如果您想提出一个一般问题,请使用 Stack Overflow
  • 如果您发现了一个错误,并且能够提供可靠的复现步骤,请提交一个问题。
  • 如果您有功能请求,请提交一个问题。
  • 如果您想做出贡献,请提交一个 pull request。

安装

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

Podfile

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

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

pod 'AFNetworking', '~> 3.0'

然后运行以下命令

$ pod install

需求

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+。requires iOS 7 或 OS X 10.9 的 NSURLSession subspec。
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 监控通向域名和 IP 地址的网络可达性,包括 WWAN 和 WiFi 网络接口。

  • 不要使用可达性来决定是否发送原始请求。
    • 你应该尝试发送它。
  • 你可以使用可达性来决定何时自动重试请求。
    • 尽管它可能仍然会失败,但当网络可达性通知连接可用时,是重试的好时机。
  • 网络可达性是确定请求失败原因的有用工具。
    • 网络请求失败后,告诉用户他们离线比提供更技术但更准确的错误(例如“请求超时”)更好。

参见2012 年 WWDC 演讲 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 RaymondMattt Thompson 在开发 iPhone 的 Gowalla 时创建。

AFNetworking 的标志由 Alan Defibaugh 设计。

最重要的是,感谢 AFNetworking 日渐增长的贡献者名单

安全披露

如果您相信您已经确定了 AFNetworking 的安全漏洞,您应尽快通过电子邮件[email protected] 报告。请不要将其发布在公共问题跟踪器上。

许可

AFNetworking 在 MIT 许可下发布。有关详细信息,请参阅 LICENSE。