YXHttpEncapsulation 0.0.1

YXHttpEncapsulation 0.0.1

测试已测试
语言语言 Obj-CObjective C
许可证 MIT
发布最后发布2017年3月

zhouzhiqiang1维护。



  • zhouzhiqiang1

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

然而,所有功能中最重要的是,使用并贡献给AFNetworking的出色开发者社群。AFNetworking为iPhone、iPad和Mac上的一些最受欢迎和备受好评的应用提供了动力。

为您的下一个项目选择AFNetworking,或将现有项目迁移到AFNetworking——您会为所做的决定感到高兴!

如何入门

通信

安装

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

CocoaPods 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 不适用 需要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监视WAN和WiFi网络接口的域名和地址的可达性。

  • 不要使用可达性确定原始请求是否应该发送。
    • 您应该尝试发送。
  • 您可以使用可达性(Reachability)来判断何时应该自动重试请求。
    • 尽管可能会有失败的情况,但当收到可达性通知,表明网络连接可用时,是一个很好的重试时机。
  • 网络可达性是确定请求可能失败原因的有用工具。
    • 在网络请求失败后,告诉用户他们已离线,比给出更技术化但更准确的错误信息(如“请求超时”)要好。

参见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文件。