TXLiteAVSDK_Smart 12.0.16292

TXLiteAVSDK_Smart 12.0.16292

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

txvideocloudJoey LawjackyixueAbySwifterggzgliadamsfliu 维护。



  • 腾讯视频云

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')
  • 如果您想 ask a general question,请使用 Stack Overflow
  • 如果您找到 bug,并且可以提供可靠重现它的步骤,请开一个问题。
  • 如果您有功能请求,请开一个问题。
  • 如果您想贡献,提交一个 pull request。

安装

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

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

github "AFNetworking/AFNetworking" ~> 3.0

运行 carthage 构建 framework 并将构建好的 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 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
    • (Mac OS X)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 监控 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 RaymondMattt Thompson在开发iPhone版Gowalla时创建。

AFNetworking的标志由Alan Defibaugh设计。

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

安全披露

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

许可证

AFNetworking采用MIT许可发布。有关详细信息,请参阅LICENSE。