NX网络管理器 0.1.6

NX网络管理器 0.1.6

测试测试过
语言语言 Obj-CObjective C
许可证 MIT
发布时间上次发布2017年2月

nightx 维护。



 
依赖项
AFNetworking~> 3.1.0
CocoaLumberjack~> 2.3.0
 

  • 作者
  • nightx

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

然而,所有这些功能中最重要的也许是,AFNetworking拥有一个惊人的开发者社区,他们每天使用并贡献于AFNetworking。AFNetworking为iPhone、iPad和Mac上的一些最受欢迎和评论如潮的应用程序提供了支持。

选择AFNetworking作为您的下一个项目,或者迁移到现有的项目中——您会很高兴您这么做!

如何开始

交流

  • 如果您 需要帮助,请使用 Stack Overflow。(标签'afnetworking')
  • 如果您想 提问一般性问题,请使用 Stack Overflow
  • 如果您 发现了bug并能提供可靠重现步骤,请发起一个issue。
  • 如果您 有功能请求,请发起一个issue。
  • 如果您 想要贡献,请提交一个pull request。

安装

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 项目必须支持现代 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 RaymondMattt Thompson在开发Gowalla for iPhone时创建。

AFNetworking的标志是由Alan Defibaugh设计的。

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

安全披露

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

许可

AFNetworking在MIT许可下发布。请参阅LICENSE以获取详细信息。