HouseAFNetworking 3.1.0

HouseAFNetworking 3.1.0

×

测试已测试✗
语言语言 Obj-C客观 C
许可证 MIT
发布最新发布2016年12月

由 xayoung 维护。

HouseAFNetworking 3.1.0

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

然而，最重要的功能可能是那些每天使用和贡献 AFNetworking 的开发者的惊人社区。AFNetworking 使 iPhone、iPad 和 Mac 上的一些最受欢迎和备受好评的应用成为可能。

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

如何开始

通讯

  • 如果您 需要帮助，请使用 Stack Overflow。（标签 'afnetworking'）
  • 如果您想 提出一般问题，请使用 Stack Overflow。
  • 如果您 发现了一个错误，并且可以提供可靠地重现它的步骤，打开一个 issue。
  • 如果您 有功能请求，请打开一个 issue。
  • 如果您 想贡献，提交一个 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 项目必须支持 具有现代 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 监控 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以获取详细信息。