WSGateway 0.0.13

WSGateway 0.0.13

×

测试已测试✗
语言语言 Obj-CObjective C
许可 MIT
发布最后发布2016年12月

由WOWSOME Dev维护。

WSGateway 0.0.13

  • 作者
  • aditya

AFNetworking

Build Status codecov.io CocoaPods Compatible Carthage Compatible Platform Twitter

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

然而，所有功能中最重要的一点可能是，一个令人惊叹的开发者社区每天都在使用和贡献AFNetworking。AFNetworking为iPhone、iPad和Mac上的一些最流行和备受好评的应用程序提供动力。

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

如何开始使用

沟通

  • 如果您需要帮助，请使用 Stack Overflow。（标签'afnetworking'）
  • 如果您想提出一个 一般问题，请使用 Stack Overflow。
  • 如果您发现了一个 bug，并且可以提供可靠地重现它的步骤，请提交一个问题。
  • 如果您有一个 功能请求，请提交一个问题。
  • 如果您想 贡献，请提交一个拉取请求。

安装

AFNetworking支持多种方法将库安装到项目中。

使用CocoaPods安装

CocoaPods 是一个Objective-C的依赖管理器，它自动化并简化了在项目中使用第三方库（如AFNetworking）的过程。有关更多信息，请参阅"如何开始使用"指南。您可以使用以下命令安装它

$ gem install cocoapods

0.39.0+版本的CocoaPods是构建AFNetworking 3.0.0+所必需的。

Podfile

要使用CocoaPods将AFNetworking集成到您的Xcode项目中，请在您的 Podfile 中指定它

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

pod 'AFNetworking', '~> 3.0'

然后，运行以下命令

$ pod install

使用Carthage进行安装

Carthage是一个去中心化的依赖关系管理器，它会编译您的依赖项并提供二进制框架。

您可以使用以下命令通过Homebrew安装Carthage

$ brew update
$ brew install carthage

要使用Carthage将AFNetworking集成到您的Xcode项目中，请在您的Cartfile中指定它

github "AFNetworking/AFNetworking" ~> 3.0

运行carthage来构建框架，并将生成的AFNetworking.framework拖放到您的Xcode项目中。

要求

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+。需要iOS 7或OS X 10.9才能使用NSURLSession子规格。
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://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 监控域和 IP 地址的网络可达性，适用于 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 在开发 Gowalla for iPhone 时创建。

AFNetworking 的标志由 Alan Defibaugh 设计。

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

安全披露

如果您认为已发现与 AFNetworking 相关的安全漏洞，请尽快通过电子邮件向 [email protected] 报告。请不要将其发布在公开的问题跟踪器上。

许可

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