BMNetworkAPIManager 3.1.1

BMNetworkAPIManager 3.1.1

×

测试测试✗
Lang语言 Obj-CObjective C
许可 MIT
发布最新发布2020年5月

由 aa335418265 维护。

 
依赖关系
AFNetworking/Serialization~> 4.0.1
AFNetworking/Security~> 4.0.1
AFNetworking/Reachability~> 4.0.1
AFNetworking/NSURLSession~> 4.0.1
 

BMNetworkAPIManager 3.1.1

  • 作者：
  • itx

AFNetworking

Build Status
codecov.io
CocoaPods Compatible
Carthage Compatible
Platform
Twitter

AFNetworking 是一个出色的 iOS 和 macOS X 的网络库。它在 Foundation URL 加载系统的之上构建，扩展了 Cocoa 中的强大高级网络抽象。它具有模块化架构和精心设计的丰富功能 API，易于使用。

然而，所有功能中最重要的可能是使用并贡献 AFNetworking 的开发者所组成的出色社区。AFNetworking 是一些最受欢迎和备受好评的 iPhone、iPad 和 mac 应用程序背后的强大动力。

选择 AFNetworking 作为您的下一个项目，或者迁移现有项目——您会为做了这样的选择而感到高兴！

如何开始

沟通

  • 如果您 需要帮助，请使用 Stack Overflow。 （标签 'afnetworking'）
  • 如果您想 提问一个一般性问题，请使用 Stack Overflow。
  • 如果您 发现了错误，并可以提供可靠地复现它的步骤，请打开一个问题。
  • 如果您 有一个功能请求，请打开一个问题。
  • 如果您 想做出贡献，请提交一个 pull 请求。

安装

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

CocoaPods 安装

CocoaPods 是一个 Objective-C 依赖关系管理器，用于自动化和简化在项目中使用像 AFNetworking 这样的第三方库的过程。关于更多信息，请参阅"Getting Started" 指南。您可以使用以下命令安装它：

$ 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

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

github "AFNetworking/AFNetworking" ~> 3.0

运行 carthage 生成框架，并将构建好的 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 无 需要 Xcode 7+。
2.0 -> 2.5.4 iOS 6 OS X 10.8 无 无 需要 Xcode 5+。需要 iOS 7 或 OS X 10.9 才能使用 NSURLSession subspec。
1.x iOS 5 Mac OS X 10.7 无 无
0.10.x iOS 4 Mac OS X 10.6 无 无

（OS X 项目必须支持 64 位和现代 Cocoa 运行时）。

在 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（https://github.com/sco/）和Mattt Thompson（https://github.com/mattt/）在iPhone版Gowalla（http://en.wikipedia.org/wiki/Gowalla）的开发中创建。

AFNetworking的标志由Alan Defibaugh（http://www.alandefibaugh.com/）设计。

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

安全披露

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

许可

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