TestFramework 0.2.4

TestFramework 0.2.4

测试已测试
语言语言 Obj-CObjective C
许可证 MIT
发布最新发布2016年3月

vgomezcds维护。



  • 作者
  • vgomezcds

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

然而,所有这些功能中最重要的可能是,每天都有许多开发者使用和贡献 AFNetworking 的惊人社区。AFNetworking 为 iPhone、iPad 和 Mac 上的一些最受欢迎和备受好评的应用提供动力。

为您的下一个项目选择 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 或更高版本。 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://example.com/upload"];
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];
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];
POST http://example.com/
Content-Type: application/json

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

网络可达性管理器

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

  • 请勿使用 Reachability 来确定是否应发送原始请求。
    • 您应该尝试发送它。
  • 您可以使用网络可达性来确定何时应该自动重试请求数据。
    • 尽管它可能仍然会失败,但是当获得网络可达性通知,表示网络已可用时,是一个重试的好机会。
  • 网络可达性是一个很有用的工具,用于确定请求可能失败的原因。
    • 网络请求失败后,告诉用户他们是离线的,比给他们一个更技术但更准确的错误,如“请求超时”要好。

参见 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在测试子目录内包含了一系列单元测试。可以通过执行您要测试的平台的测试操作来运行这些测试。

致谢

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

AFNetworking最初由Scott RaymondMattt Thompson在开发iPhone上的Gowalla时创建。

AFNetworking的标志由Alan Defibaugh设计。

最重要的是,感谢AFNetworking日益增长的贡献者列表

安全披露

如果您相信您已确定AFNetworking的安全漏洞,您应该尽快通过电子邮件发送至[email protected]报告。请勿将其发布到公共问题跟踪器。

许可

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