MWFramework0.0.1

MWFramework0.0.1

×

测试已测试✗
Lang语言 Obj-CObjective C
许可证 MIT
发布最后发布2016 年 12 月

由 Mike 维护。

 
依赖
AFNetworking>= 0
AFOAuth2Manager>= 0
 

MWFramework0.0.1

  • 由
  • Mike Wong

AFNetworking

Build Status codecov.io CocoaPods Compatible Carthage Compatible Platform Twitter

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

然而，最重要的特征可能是使用并提供给 AFNetworking 的强大开发者社区。AFNetworking 为 iPhone、iPad 和 Mac 上一些最受欢迎和最受好评的应用程序提供了支持。

选择 AFNetworking 作为你下一个项目的库，或者迁移现有项目——你会为自己的决定感到高兴！

如何开始

沟通

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

安装

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

使用 CocoaPods 进行安装

CocoaPods 是 Objective-C 的依赖关系管理器，它自动化并简化了在与项目使用第三方库如 AFNetworking 的过程。有关更多信息，请参阅 "入门" 指南。你可以使用以下命令安装它

$ 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

使用 Carthage 集成 AFNetworking 到您的 Xcode 项目，请在其 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 n/a 需要 Xcode 7+。
2.0 -> 2.5.4 iOS 6 OS X 10.8 n/a n/a 需要 Xcode 5+。需要 iOS 7 或 OS X 10.9 才可使用 NSURLSession 子规格。
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 Raymond和Mattt Thompson在开发iPhone上的Gowalla时创建。

AFNetworking的标志由Alan Defibaugh设计。

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

安全披露

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

许可

AFNetworking 授权使用 MIT 许可证。请见 LICENSE 文件以获取详细信息。