YPMThatSDK 1.0.0

YPMThatSDK 1.0.0

×

测试已测试✗
语言语言 Obj-CObjective C
许可证 MIT
发布日期最新版本发布日期2017年4月

由 Sam 维护。

YPMThatSDK 1.0.0

  • 由
  • SamPan

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

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

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

如何开始

沟通

  • 如果您 需要帮助，请使用 Stack Overflow。(标签 'afnetworking')
  • 如果您想 提出一般性问题，请使用 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 n/a 需要 Xcode 7+。
2.0 -> 2.5.4 iOS 6 OS X 10.8 n/a n/a 需要Xcode 5或更高版本。 NSURLSession 子规格需要iOS 7或OS X 10.9。
1.x iOS 5 Mac OS X 10.7 n/a n/a
0.10.x iOS 4 Mac OS X 10.6 n/a n/a

（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监控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文件。