TXLiteAVSDK_UGC 12.0.16292

TXLiteAVSDK_UGC 12.0.16292

×

测试已测试✗
语言语言 Obj-CObjective C
许可证 自定义
发布最新发布2024年8月

由 txvideocloud、Joey Law、jackyixue、AbySwifter、ggzgli、adamsfliu 维护。

TXLiteAVSDK_UGC 12.0.16292

  • 由
  • 腾讯视频云

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。
  • 如果您 发现了缺陷，并可以提供可靠复现步骤，请打开一个问题。
  • 如果您 有功能请求，请打开一个问题。
  • 如果您 想贡献力量，请提交一个拉取请求。

安装

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

使用 CocoaPods 进行安装

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

$ gem install cocoapods

CocoaPods 0.39.0+ 是构建 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

要将AFNetworking集成到您的Xcode项目中并使用Carthage，请在您的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+。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 （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监视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 Raymond 和 Mattt Thompson 在开发 Gowalla for iPhone 时创造的。

AFNetworking 的标志由 Alan Defibaugh 设计。

最重要的是，感谢 AFNetworking 一群不断壮大的 贡献者。

安全披露

如果您相信您已经识别出 AFNetworking 的一种安全漏洞，请尽快通过电子邮件向 [email protected] 报告。请不要将其发布到公开问题跟踪器。

许可证

AFNetworking 以 MIT 许可证发布。有关详情，请参阅 LICENSE。