XPPNetworking 0.0.6

XPPNetworking 0.0.6

×

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

由 xppnetworking 维护。

XPPNetworking 0.0.6

  • 由
  • xp19870106

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 目标 最低 macOS 目标 最低 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://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在Tests子目录中包含一系列单元测试。可以通过在平台框架上执行测试动作来简单地运行这些测试。

致谢

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

AFNetworking最初由Scott Raymond和Mattt Thompson在开发iPhone版Gowalla时创建。

AFNetworking的标志由Alan Defibaugh设计。

最重要的是，感谢AFNetworking的日益增长的贡献者名单。

安全披露

如果您认为您已经发现了AFNetworking的安全漏洞，请尽快通过电子邮件报告，联系[email protected]。请勿将其发布到公共问题跟踪器。

许可

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