GNetworking 1.0.7

GNetworking 1.0.7

测试已测试
Lang语言 Obj-CObjective C
许可证 MIT
发布最后发布2017年4月

gexinwei维护。



  • 作者:
  • gexw

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

然而,最令人惊叹的可能是所有特性中最重要的,那就是每天都使用和贡献 AFNetworking 的开发人员社区。AFNetworking 驱动了 iPhone、iPad 和 Mac 上一些最受欢迎和备受赞誉的应用。

选择 AFNetworking 作为您的下一个项目,或者迁移到现有的项目中,您会发现这是一个明智的决定!

如何开始

交流

  • 如果您需要帮助,请使用 Stack Overflow。 (标记为 'afnetworking')
  • 如果您想向 strong>询问一个一般问题,请使用 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项目必须支持64位与现代Cocoa运行时)。

在Swift中编程?尝试使用Alamofire来获得更传统的API集。

架构

NSURLSession

  • AFURLSessionManager
  • AFHTTPSessionManager

序列化

  • <AFURLRequestSerialization>
    • AFHTTPRequestSerializer
    • AFJSONRequestSerializer
    • AFPropertyListRequestSerializer
  • <AFURLResponseSerialization>
    • AFHTTPResponseSerializer
    • AFJSONResponseSerializer
    • AFXMLParserResponseSerializer
    • AFXMLDocumentResponseSerializer
    • 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网络接口的域名和地址的可达性。

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

另请参阅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 RaymondMattt Thompson在iPhone应用程序Gowalla的开发中创建。

AFNetworking的标志由Alan Defibaugh设计。

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

安全披露

如果您认为您已发现AFNetworking的安全漏洞,请尽快通过电子邮件报告,地址为[email protected]。请不要将其发布到公共问题跟踪器。

许可

AFNetworking在MIT许可下发布。请参阅LICENSE获取详细信息。