ZLDB 0.0.25

ZLDB 0.0.25

×

测试测试版✗
语言语言 Obj-CObjective C
许可证 MIT
发布日期最后发布日期2017年8月

由 wzhilong 维护。

ZLDB 0.0.25

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

然而，所有这些功能中最重要的可能是一个惊人的开发者社区，他们每天都在使用并贡献 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 目标 最小 macOS 目标 最小 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 子规范需要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项目必须支持 具有现代Cocoa运行时的64位）。

使用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。