易用包 0.0.1

EZKit 0.0.1

测试已测试
语言语言 Obj-CObjective C
许可证 MIT
发布最新版本2016 年 9 月

Ezreal 维护。



 
依赖
Masonry>= 0
FCUUID>= 0
pop>= 0
Reachability>= 0
MBProgressHUD~> 0.9.2
YTKNetwork>= 0
 

EZKit 0.0.1

  • 来自
  • Ezreal

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 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 在开发 iPhone 的 Gowalla时创建。

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

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

安全披露

如果您相信您已确定 AFNetworking 存在安全漏洞,请尽快通过电子邮件报告,地址为 [email protected]。请勿将其发布到公共问题跟踪器。

许可证

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