美文网首页
AFN框架使用

AFN框架使用

作者: 今天lgw | 来源:发表于2018-04-07 19:50 被阅读52次

    AFN框架使用

    1.AFN框架基本使用

        *   NSURLSession
    
            *   AFURLSessionManager
            *   AFHTTPSessionManager(封装了常用的 HTTP 方法)
                *   GET
                *   POST
                *   UIKit + AFNetworking 分类
                *   NSProgress :利用KVO
        *   半自动的序列化&反序列化的功能
    
            *   AFURLRequestSerialization :请求的数据格式/默认是二进制的
            *   AFURLResponseSerialization :响应的数据格式/默认是JSON格式
        *   附加功能
    
            *   安全策略
                *   HTTPS
                *   AFSecurityPolicy
            *   网络检测
                *   对苹果的网络连接检测做了一个封装
                *   AFNetworkReachabilityManager
    

    2 .AFN的基本使用

    (1)发送GET请求的两种方式(POST同)
     -(void)get1 {
        //1.创建AFHTTPRequestOperationManager管理者
        //AFHTTPRequestOperationManager内部是基于NSURLConnection实现的
        AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
    
        //2.发送请求
        /*
         http://120.25.226.186:32812/login?username=ee&pwd=ee&type=JSON
         第一个参数:NSString类型的请求路径,AFN内部会自动将该路径包装为一个url并创建请求对象
         第二个参数:请求参数,以字典的方式传递,AFN内部会判断当前是POST请求还是GET请求,以选择直接拼接还是转换为NSData放到请求体中传递
         第三个参数:请求成功之后回调Block
         第四个参数:请求失败回调Block
         */
    
        NSDictionary *param = @{
                                @"username":@"",
                                @"pwd":@""
                                };
    
        //注意:字符串中不能包含空格
        [manager GET:@"http://120.25.226.186:32812/login" parameters:param success:^(AFHTTPRequestOperation * _Nonnull operation, id  _Nonnull responseObject) {
    
            NSLog(@"请求成功---%@",responseObject);
    
        } failure:^(AFHTTPRequestOperation * _Nonnull operation, NSError * _Nonnull error) {
                NSLog(@"失败---%@",error);
        }];
    }
    
    
    -(void)get2 {
        //1.创建AFHTTPSessionManager管理者
        //AFHTTPSessionManager内部是基于NSURLSession实现的
        AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
    
        //2.发送请求
        NSDictionary *param = @{
                                @"username":@"",
                                @"pwd":@""
                                };
    
        //注意:responseObject:请求成功返回的响应结果(AFN内部已经把响应体转换为OC对象,通常是字典或数组)
        [manager GET:@"http://120.25.226.186:32812/login" parameters:param success:^(NSURLSessionDataTask * _Nonnull task, id  _Nonnull responseObject) {
                NSLog(@"请求成功---%@",[responseObject class]);
    
        } failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
            NSLog(@"失败---%@",error);
        }];
    }
    
    

    (2)使用AFN下载文件

    -(void)download {
        //1.创建一个管理者
        AFHTTPSessionManager *manage  = [AFHTTPSessionManager manager];
    
        //2.下载文件
        /*
         第一个参数:请求对象
         第二个参数:下载进度
         第三个参数:block回调,需要返回一个url地址,用来告诉AFN下载文件的目标地址
             targetPath:AFN内部下载文件存储的地址,tmp文件夹下
             response:请求的响应头
             返回值:文件应该剪切到什么地方
         第四个参数:block回调,当文件下载完成之后调用
            response:响应头
            filePath:文件存储在沙盒的地址 == 第三个参数中block的返回值
            error:错误信息
         */
    
        //2.1 创建请求对象
        NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://120.25.226.186:32812/resources/images/minion_02.png"]];
    
        //2.2 创建下载进度,并监听
        NSProgress *progress = nil;
    
        NSURLSessionDownloadTask *downloadTask = [manage downloadTaskWithRequest:request progress:&progress destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
    
            NSString *caches = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
    
            //拼接文件全路径
            NSString *fullpath = [caches stringByAppendingPathComponent:response.suggestedFilename];
            NSURL *filePathUrl = [NSURL fileURLWithPath:fullpath];
            return filePathUrl;
    
        } completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nonnull filePath, NSError * _Nonnull error) {
    
            NSLog(@"文件下载完毕---%@",filePath);
        }];
    
        //2.3 使用KVO监听下载进度
        [progress addObserver:self forKeyPath:@"completedUnitCount" options:NSKeyValueObservingOptionNew context:nil];
    
        //3.启动任务
        [downloadTask resume];
    }
    
    
    //获取并计算当前文件的下载进度
    -(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(NSProgress *)progress change:(NSDictionary<NSString *,id> *)change context:(void *)context
    {
        NSLog(@"%zd--%zd--%f",progress.completedUnitCount,progress.totalUnitCount,1.0 * progress.completedUnitCount/progress.totalUnitCount);
    }
    
    

    3.AFN文件上传

    1.文件上传拼接数据的第一种方式

    [formData appendPartWithFileData:data name:@"file" fileName:@"xxoo.png" mimeType:@"application/octet-stream"];
    
    

    2.文件上传拼接数据的第二种方式

     [formData appendPartWithFileURL:fileUrl name:@"file" fileName:@"xx.png" mimeType:@"application/octet-stream" error:nil];
    
    

    3.文件上传拼接数据的第三种方式

     [formData appendPartWithFileURL:fileUrl name:@"file" error:nil];
    
    
    -(void)upload {
        //1.创建一个请求管理者
        AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
    
        //2.发送POST请求上传数据
        /*
         第一个参数:请求路径:NSString类型
         第二个参数:要上传的非文件参数
         第三个参数:block回调
            在该回调中,需要利用formData拼接即将上传的二进制数据
         第三个参数:上传成功的block回调
            task:dataTask(任务)
            responseObject:服务器返回的数据
         第四个参数:上传失败的block回调
            error:错误信息,如果上传文件失败,那么error里面包含了错误的描述信息
         */
    
        NSDictionary *dict = @{
                               @"username":@""
                               };
    
        [manager POST:@"http://120.25.226.186:32812/upload" parameters:dict constructingBodyWithBlock:^(id<AFMultipartFormData>  _Nonnull formData) {
    
            //把本地的图片转换为NSData类型的数据
            UIImage *image = [UIImage imageNamed:@"123"];
            NSData *data = UIImagePNGRepresentation(image);
    
            /*
             //拼接二进制文件数据
             第一个参数:要上传的文件的二进制数据
             第二个参数:服务器接口规定的名称
             第三个参数:这个参数上传到服务器之后用什么名字来进行保存
             第四个参数:上传文件的MIMEType类型
             */
            [formData appendPartWithFileData:data name:@"file" fileName:@"xxoo.png" mimeType:@"application/octet-stream"];
    
        } success:^(NSURLSessionDataTask * _Nonnull task, id  _Nonnull responseObject) {
            NSLog(@"请求成功---%@",responseObject);
    
        } failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
            NSLog(@"请求失败--%@",error);
        }];
    }
    
    
    -(void)upload2 {
        NSLog(@"%s",__func__);
    
        //1.创建一个请求管理者
        AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
    
        //2.发送POST请求上传数据
        /*
         第一个参数:请求路径:NSString类型
         第二个参数:要上传的非文件参数
         第三个参数:block回调
         在该回调中,需要利用formData拼接即将上传的二进制数据
         第三个参数:上传成功的block回调
         task:dataTask(任务)
         responseObject:服务器返回的数据
         第四个参数:上传失败的block回调
         error:错误信息,如果上传文件失败,那么error里面包含了错误的描述信息
         */
    
        NSDictionary *dict = @{
                               @"username":@""
                               };
    
        [manager POST:@"http://120.25.226.186:32812/upload" parameters:dict constructingBodyWithBlock:^(id<AFMultipartFormData>  _Nonnull formData) {
    
            //本地文件的url
            NSURL *fileUrl = [NSURL fileURLWithPath:@"/Users/username/Desktop/KF[WTI`AQ3T`A@3R(B96D89.gif"];
            /*
             //拼接二进制文件数据
             第一个参数:要上传文件的url路径
             第二个参数:服务器要求的参数名称
             第三个参数:这个文件上传到服务器之后叫什么名称
             第四个参数:文件的mimetype类型
             第五个参数:错误信息
             */
    //        [formData appendPartWithFileURL:fileUrl name:@"file" fileName:@"xx.png" mimeType:@"application/octet-stream" error:nil];
    
            //另外一种上传文件的方式
            /*
             说明:该方法和上面的方法等价,不过该方法更加简单其内部会自动的的根据url路径确定文件保存名称,并通过内部方法获取上传文件的mimetype类型
             */
            [formData appendPartWithFileURL:fileUrl name:@"file" error:nil];
    
        } success:^(NSURLSessionDataTask * _Nonnull task, id  _Nonnull responseObject) {
            NSLog(@"请求成功---%@",responseObject);
    
        } failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
            NSLog(@"请求失败--%@",error);
        }];
    }
    
    

    4.使用AFN进行序列化处理

    1.AFN它内部默认把服务器响应的数据当做json来进行解析,所以如果服务器返回给我的不是JSON数据那么请求报错,这个时候需要设置AFN对响应信息的解析方式。AFN提供了三种解析响应信息的方式,分别是:

    • 1.AFXMLParserResponseSerializer----XML
      1. AFHTTPResponseSerializer---------默认二进制响应数据
    • 3.AFJSONResponseSerializer---------JSON

    *4.还有一种情况就是服务器返回给我们的数据格式不太一致(开发者工具Content-Type:text/xml),那么这种情况也有可能请求不成功。解决方法:
    1) 直接在源代码中修改,添加相应的Content-Type
    2) 拿到这个属性,添加到它的集合中

    -(void)serialized {
        //1.创建请求管理者,内部基于NSURLSession
        AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
    
        /* 知识点1:设置AFN采用什么样的方式来解析服务器返回的数据*/
    
        //如果返回的是XML,那么告诉AFN,响应的时候使用XML的方式解析
        manager.responseSerializer = [AFXMLParserResponseSerializer serializer];
    
        //如果返回的就是二进制数据,那么采用默认二进制的方式来解析数据
        //manager.responseSerializer = [AFHTTPResponseSerializer serializer];
    
        //采用JSON的方式来解析数据
        //manager.responseSerializer = [AFJSONResponseSerializer serializer];
    
        /* 告诉AFN,再序列化服务器返回的数据的时候,支持此种类型
        [AFJSONResponseSerializer serializer].acceptableContentTypes = [NSSet setWithObject:@"text/xml"];
    
        //2.把所有的请求参数通过字典的方式来装载,GET方法内部会自动把所有的键值对取出以&符号拼接并最后用?符号连接在请求路径后面
        NSDictionary *dict = @{
                               @"username":@"223",
                               @"pwd":@"ewr",
                               @"type":@"XML"
                               };
    
        //3.发送GET请求
        [manager GET:@"http://120.25.226.186:32812/login" parameters:dict success:^(NSURLSessionDataTask * _Nonnull task, id  _Nonnull responseObject) {
    
            //4.请求成功的回调block
            NSLog(@"%@",[responseObject class]);
        } failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
    
            //5.请求失败的回调,可以打印error的值查看错误信息
            NSLog(@"%@",error);
        }];
    }
    
    

    4.使用AFN来检测网络状态

    可以使用AFN框架中的AFNetworkReachabilityManager来监听网络状态的改变,也可以利用苹果提供的Reachability来监听。建议在开发中直接使用AFN框架处理。

    //使用AFN框架来检测网络状态的改变
    -(void)AFNReachability {
        //1.创建网络监听管理者
        AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager];
    
        //2.监听网络状态的改变
        /*
         AFNetworkReachabilityStatusUnknown          = 未知
         AFNetworkReachabilityStatusNotReachable     = 没有网络
         AFNetworkReachabilityStatusReachableViaWWAN = 3G
         AFNetworkReachabilityStatusReachableViaWiFi = WIFI
         */
        [manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
            switch (status) {
                case AFNetworkReachabilityStatusUnknown:
                    NSLog(@"未知");
                    break;
                case AFNetworkReachabilityStatusNotReachable:
                    NSLog(@"没有网络");
                    break;
                case AFNetworkReachabilityStatusReachableViaWWAN:
                    NSLog(@"3G");
                    break;
                case AFNetworkReachabilityStatusReachableViaWiFi:
                    NSLog(@"WIFI");
                    break;
    
                default:
                    break;
            }
        }];
    
        //3.开始监听
        [manager startMonitoring];
    }
    
    

    //使用苹果提供的Reachability来检测网络状态,如果要持续监听网络状态的概念,需要结合通知一起使用。

    -(void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
        //1.注册一个通知
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(networkChange) name:kReachabilityChangedNotification object:nil];
    
        //2.拿到一个对象,然后调用开始监听方法
        Reachability *r = [Reachability reachabilityForInternetConnection];
        [r startNotifier];
    
        //持有该对象,不要让该对象释放掉
        self.r = r;
    }
    
    //当控制器释放的时候,移除通知的监听
    -(void)dealloc
    {
        [[NSNotificationCenter defaultCenter] removeObserver:self];
    }
    
    -(void)networkChange
    {
        //获取当前网络的状态
       if ([Reachability reachabilityForInternetConnection].currentReachabilityStatus == ReachableViaWWAN)
        {
            NSLog(@"当前网络状态为3G");
            return;
        }
    
        if ([Reachability reachabilityForLocalWiFi].currentReachabilityStatus == ReachableViaWiFi)
        {
            NSLog(@"当前网络状态为wifi");
            return;
        }
    
        NSLog(@"当前没有网络");
    }
    
    

    5.AFN使用技巧

    1.在开发的时候可以创建一个工具类,继承自我们的AFN中的请求管理者,再控制器中真正发请求的代码使用自己封装的工具类。
    2.这样做的优点是以后如果修改了底层依赖的框架,那么我们修改这个工具类就可以了,而不用再一个一个的去修改。
    3.该工具类一般提供一个单例方法,在该方法中会设置一个基本的请求路径。
    4.该方法通常还会提供对GET或POST请求的封装。
    5.在外面的时候通过该工具类来发送请求
    6.单例方法:

    + (instancetype)shareNetworkTools {
        static XMGNetworkTools *instance;
        static dispatch_once_t onceToken;
        dispatch_once(&onceToken, ^{
            // 注意: BaseURL中一定要以/结尾
            instance = [[self alloc] initWithBaseURL:[NSURL URLWithString:@"http://120.25.226.186:32812/"]];
        });
        return instance;
    }
    
    

    相关文章

      网友评论

          本文标题:AFN框架使用

          本文链接:https://www.haomeiwen.com/subject/zazyhftx.html