【iOS 开发】AFNetworking 3.0 使用汇总(包括文件上传和文件下载)

【iOS 开发】AFNetworking 3.0 使用汇总(包括文件上传和文件下载)_第1张图片
AFNetworking

由于自己公司的项目使用的还是老的 AFNetworking 2.0 ,其中的网络请求使用的是 AFHTTPRequestOperationManager ,这个类在 AFNetworking 3.0 中已被废弃,所以需要将公司项目中的网络请求全部升级为 AFNetworking 3.0 ,现在分享一下使用汇总。


参数设置

AFNetworking 3.0 使用的是 AFHTTPSessionManager 来进行网络请求的,下面介绍一下参数的设置。

  • 关于 requestSerializer 它是 AFNetworking 参数编码的序列化器,它一共有三种编码格式,responseSerializer 同理,选择哪种看自己的需求。
1. AFHTTPRequestSerializer:是普通的 HTTP 的编码格式的,也就是 mid=10&method=userInfo&dateInt=20160818 这种格式的。
  
2. AFJSONRequestSerializer:是 JSON 编码格式的,也就是 {"mid":"11","method":"userInfo","dateInt":"20160818"} 这种格式的。
  
3. AFPropertyListRequestSerializer:这个没用过,但是看介绍说是编码成 plist 格式的参数。
  • HTTPHeaderField 请求头没有的话可以不用设置。
/* 创建网络请求对象 */
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
  
/* 设置请求和接收的数据编码格式 */
manager.requestSerializer = [AFJSONRequestSerializer serializer]; // 设置请求数据为 JSON 数据
manager.responseSerializer = [AFJSONResponseSerializer serializer]; // 设置接收数据为 JSON 数据
  
/* 设置请求头 */
[manager.requestSerializer setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[manager.requestSerializer setValue:@"xxx" forHTTPHeaderField:@"xxx"];
[manager.requestSerializer setValue:@"xxx" forHTTPHeaderField:@"xxx"];
  
/* 请求地址 */
NSString *url = @"http://xxx";
  
/* 请求参数 */
NSDictionary *parameters = @{@"xxx" : @"xxx",
                             @"xxx" : @"xxx",
                             @"xxx" : @"xxx"};

网络请求

网络请求有 GET 请求、POST 请求、文件上传 这几种,按自己需求选择相应请求的方法,参数设置使用上面的设置,文件下载 的话有点不一样,下面会单独说。

1. GET 请求

[manager GET:url parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
    
    NSLog(@"请求成功:%@", responseObject);
    
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
    
    NSLog(@"请求失败:%@", error);
}];

2. POST 请求

[manager POST:url parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
    
    NSLog(@"请求成功:%@", responseObject);
    
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
    
    NSLog(@"请求失败:%@", error);
}];

3. 文件上传

下面以图片上传为例,其他文件的上传都是差不多的。

[manager POST:url parameters:parameters constructingBodyWithBlock:^(id  _Nonnull formData) {
    
    /* 本地图片上传 */
    NSURL *imageUrl = [[NSBundle mainBundle] URLForResource:@"test" withExtension:@"png"];
    NSData *imageData = [NSData dataWithContentsOfURL:imageUrl];
    
    // 直接将图片对象转成 data 也可以
    // UIImage *image = [UIImage imageNamed:@"test"];
    // NSData *imageData = UIImageJPEGRepresentation(image, 1.0);
    
    /* 上传数据拼接 */
    [formData appendPartWithFileData:imageData name:@"file" fileName:@"test.png" mimeType:@"image/png"];
    
} progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
    
    NSLog(@"上传成功:%@", responseObject);
    
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
    
    NSLog(@"上传失败:%@", error);
}];

请求结果的处理

  • 以下方法能够将获取到的 responseObject 数据直接转成 NSString 字符串或者 NSDictionary 字典,也可以使用 MJExtension 这个第三方库,能够将获取到的 responseObject 直接转换成对象,如果要转成字典或是对象, responseObject 必须是 JSON 格式的。
[manager POST:url parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
    
    /* 将得到的数据转换成 NSString 字符串 */
    NSString *infoStr = [[NSString alloc] initWithData:responseObject encoding:NSUTF8StringEncoding];
    NSLog(@"请求到的数据:%@", infoStr);
    
    /* 将得到的 JSON 数据转换成 NSDictionary 字典 */
    NSDictionary *resultDic = [NSJSONSerialization JSONObjectWithData:responseObject options:NSJSONReadingMutableLeaves error:nil];
    NSLog(@"请求到的数据:%@", resultDic);
    
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
    
    NSLog(@"请求失败:%@", error);
}];
  • AFNetworking 2.0 的返回参数是 AFHTTPRequestOperation ,而 AFNetworking 3.0 的返回参数是 NSURLSessionDataTask ,所以还是有些区别的,如果需要得到 allHeaderFields 这个参数需要强转一下。
[manager POST:url parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
    
    /* allHeaderFields 参数获取 */
    NSHTTPURLResponse *response = (NSHTTPURLResponse *)task.response;
    NSDictionary *headerFields = response.allHeaderFields;
    NSLog(@"请求头:%@", headerFields);
    
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
    
    NSLog(@"请求失败:%@", error);
}];

文件下载

文件下载的话和上面三个不太一样,所以单独来说,上面那些设置的参数都不需要了,具体代码看下面。

/* 创建网络下载对象 */
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
  
/* 下载地址 */
NSURL *url = [NSURL URLWithString:@"http://xxx/test.mp4"];
NSURLRequest *request = [NSURLRequest requestWithURL:url];
  
/* 下载路径 */
NSString *path = [NSHomeDirectory() stringByAppendingPathComponent:@"Documents"];
NSString *filePath = [path stringByAppendingPathComponent:url.lastPathComponent];
  
/* 开始请求下载 */
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) {
    
    NSLog(@"下载进度:%.0f%", downloadProgress.fractionCompleted * 100);
    
} destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
    
    /* 设定下载到的位置 */
    return [NSURL fileURLWithPath:filePath];
    
} completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
    
    NSLog(@"下载完成");
    
}];
[downloadTask resume];

监听网络状态

AFNetWorking 也可以用来监听网络状态,当网络状态发生改变的时候会自动调用以下 Block 回调,具体方法如下。

/* 监听网络状态 */
AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager];
[manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
    if (status == AFNetworkReachabilityStatusUnknown) {
        NSLog(@"当前网络:未知网络");
    } else if (status == AFNetworkReachabilityStatusNotReachable) {
        NSLog(@"当前网络:没有网络");
    } else if (status == AFNetworkReachabilityStatusReachableViaWWAN) {
        NSLog(@"当前网络:手机流量");
    } else if (status == AFNetworkReachabilityStatusReachableViaWiFi) {
        NSLog(@"当前网络:WiFi");
    }
}];
[manager startMonitoring];

AFNetworking 3.0 的大致使用方法都在这了,有需要的可以收藏一下。

将来的你,一定会感激现在拼命的自己,愿自己与读者的开发之路无限美好。

我的传送门: 博客 、 、微博 、GitHub 。

你可能感兴趣的:(【iOS 开发】AFNetworking 3.0 使用汇总(包括文件上传和文件下载))