CBNetworking 1.0.2

CBNetworking 1.0.2

测试已测试
语言语言 Obj-CObjective C
授权 MIT
发布上次发布2016年5月

CharlieCB 维护。



  • 作者:
  • 陈超邦

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

然而,所有功能中最重要的是,AFNetworking 拥有一个惊人的开发者社区,他们每天都在使用和贡献 AFNetworking。AFNetworking 为一些最流行、最受好评的 iPhone、iPad 和 Mac 应用提供了动力。

为您的下一个项目选择 AFNetworking,或将现有项目迁移到 AFNetworking,您会对此表示满意的!

如何开始

沟通

  • 如果您需要帮助,请使用 Stack Overflow。(标记为 'afnetworking')
  • 如果您想提问一个 一般性问题,请使用 Stack Overflow
  • 如果您 发现了一个错误,并且 可以提供可靠地重现错误步骤,请打开一个问题。
  • 如果您有一个 功能请求,请打开一个问题。
  • 如果您想 贡献,提交一个拉取请求。

安装

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及以上版本。使用NSURLSession subspec需要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项目必须支持使用现代Cocoa运行时的64位)。

正在使用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监视WAN和WiFi网络接口的域和网络地址的可达性。

  • 请不要使用可达性来确定是否应该发送原始请求。
    • 您应该尝试发送它。
  • 您可以使用可达性(Reachability)来判定何时应自动重试请求。
    • 尽管它可能会失败,但接收到可达性通知表明连接可用时,是重试的好时机。
  • 网络可达性是确定请求可能失败原因的有用工具。
    • 在发生网络请求失败后,告知用户他们处于离线状态,比提供更技术但更准确错误信息(如“超时”)要好。

参见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。