美文网首页O~1iOS 网络相关GitHub 中文社区
iOS网络请求封装,基于AFN(iOS)

iOS网络请求封装,基于AFN(iOS)

作者: Charles___ | 来源:发表于2017-03-14 16:41 被阅读2149次

项目地址:https://github.com/purejf/BaseRequest

AFNetWorking->CYRequestManager->CYBaseRequest

封装了一下网络请求,牵扯到三个类

1. AFNetworking
2. CYRequestManager
3. CYBaseRequest
设计思路
  1. 先封装一下AFNetworking,即CYRequestManager
  2. 但是CYRequestManager需要参数、链接,参数和链接还是过于暴露,所以设计CYBaseRequest类
  3. 使用时继承CYBaseRequest,将类的属性作为参数(模型转JSON),将属性转化为字典参数,发送请求,即可
  4. 简单封装,以后逐步完善
用例1

直接使用CYBaseRequest

    // 1. 创建请求
    CYBaseRequest *request = [CYBaseRequest new];
    request.url = @"www.baidu.com";
    
    // 2. 发送请求
    [request sendRequestWithCompletionHandle:^(BOOL success, id response, NSString *message) {
        
    }];
}
用例2

创建一个CYUserInfoRequest继承自CYBaseRequest

CYUserInfoRequest.h

@interface CYUserInfoRequest : CYBaseRequest

@property (nonatomic, assign) NSInteger userId;

@end

CYUserInfoRequest.m

@implementation CYUserInfoRequest

- (instancetype)init {
    self = [super init];
    if (self) {
        self.url = @"请求需要的链接";
    }
    return self;
}

@end

如何使用?

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // 1. 创建请求
    CYUserInfoRequest *userInfoR = [CYUserInfoRequest new];
    userInfoR.userId = 1;
    // 在.m中可以设置
    // userInfoR.url = @"www.baidu.com";
    // 可选
    // userInfoR.extraParams = @{
    //                              @"username" : @"xxx"
    //                              };
    
    // 2. 设置请求方式
    userInfoR.methodType = CYRequestMethodTypePOST;
    
    // 3. 发送请求
    [userInfoR sendRequestWithCompletionHandle:^(BOOL success, id response, NSString *message) {
        
    }];
    
}

@end

}
设计代码示例 - CYRequestManager

#import "AFNetworking.h"
#import "CYRequestConstant.h"

// 请求成功回调
typedef void(^CYRequestManagerSuccessHandle)(NSURLSessionTask *task, id response);

// 请求失败回调
typedef void(^CYRequestManagerFailureHandle)(NSURLSessionTask *task, NSError *error);

@interface CYRequestManager : NSObject

/**
 request By NSURLSession
 
 @param URLString 请求链接
 @param params 请求参数
 @param methodType 请求方式
 @param serializerType 数据解析类型
 @param successHandle 请求成功回调
 @param failureHandle 请求失败回调
 */
+ (void)requestWithURLString:(NSString *)URLString
                      params:(NSDictionary *)params
                  methodType:(CYRequestMethodType)methodType
              serializerType:(CYResponseSeializerType)serializerType
               successHandle:(CYRequestManagerSuccessHandle)successHandle
               failureHandle:(CYRequestManagerFailureHandle)failureHandle;

/**
 a multipart `POST` request By NSURLSession
 
 @param URLString 请求链接
 @param params 请求参数
 @param serializerType 数据解析类型
 @param constructingBody 添加请求体
 @param successHandle 请求成功回调
 @param failureHandle 请求失败回调
 */
+ (void)POSTWithURLString:(NSString *)URLString
                   params:(NSDictionary *)params
            serializerType:(CYResponseSeializerType)serializerType
         constructingBody:(void (^)(id<AFMultipartFormData> formData))constructingBody
            successHandle:(CYRequestManagerSuccessHandle)successHandle
            failureHandle:(CYRequestManagerFailureHandle)failureHandle;

@end
#import "CYRequestManager.h"
#import "AFNetworking.h"

@interface AFHTTPSessionManager (Shared)

+ (instancetype)sharedManager;

@end

@implementation AFHTTPSessionManager (Shared)

+ (instancetype)sharedManager {
    static AFHTTPSessionManager *_singleton;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _singleton = [AFHTTPSessionManager manager];
        _singleton.responseSerializer.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/plain", @"text/json", @"text/javascript", @"text/html", nil];
    });
    return _singleton;
}

@end

@implementation CYRequestManager

+ (void)requestWithURLString:(NSString *)URLString
                      params:(NSDictionary *)params
                  methodType:(CYRequestMethodType)methodType
              serializerType:(CYResponseSeializerType)serializerType
               successHandle:(CYRequestManagerSuccessHandle)successHandle
               failureHandle:(CYRequestManagerFailureHandle)failureHandle {
    
    AFHTTPSessionManager *manager = [AFHTTPSessionManager sharedManager];
    
    manager.responseSerializer = [self responseSearalizerWithSerilizerType:serializerType];
    
    switch (methodType) {
        case CYRequestMethodTypeGET: [manager GET:URLString parameters:params progress:nil success:successHandle failure:failureHandle]; break;
        case CYRequestMethodTypePOST: [manager POST:URLString parameters:params progress:nil success:successHandle failure:failureHandle]; break;
        case CYRequestMethodTypePUT: [manager PUT:URLString parameters:params success:successHandle failure:failureHandle]; break;
        case CYRequestMethodTypePATCH: [manager PATCH:URLString parameters:params success:successHandle failure:failureHandle]; break;
        case CYRequestMethodTypeDELETE: [manager DELETE:URLString parameters:params success:successHandle failure:failureHandle]; break;
        case CYRequestMethodTypeHEAD: [manager HEAD:URLString parameters:params success:^(NSURLSessionDataTask * _Nonnull task) {
            !successHandle ?: successHandle(task, nil);
        } failure:failureHandle]; break;
    }
    
}

+ (void)POSTWithURLString:(NSString *)URLString
                   params:(NSDictionary *)params
           serializerType:(CYResponseSeializerType)serializerType
         constructingBody:(void (^)(id<AFMultipartFormData> formData))constructingBody
            successHandle:(CYRequestManagerSuccessHandle)successHandle
            failureHandle:(CYRequestManagerFailureHandle)failureHandle {
    
    AFHTTPSessionManager *manager = [AFHTTPSessionManager sharedManager];
    
    manager.responseSerializer = [self responseSearalizerWithSerilizerType:serializerType];
    
    [manager POST:URLString parameters:params constructingBodyWithBlock:constructingBody progress:nil success:successHandle failure:failureHandle];
}

+ (AFHTTPResponseSerializer *)responseSearalizerWithSerilizerType:(CYResponseSeializerType)serilizerType {
    switch (serilizerType) {
        case CYResponseSeializerTypeDefault: return [AFJSONResponseSerializer serializer]; break;
        case CYResponseSeializerTypeJSON: return [AFJSONResponseSerializer serializer]; break;
        case CYResponseSeializerTypeXML: return [AFXMLParserResponseSerializer serializer]; break;
        case CYResponseSeializerTypePlist: return [AFPropertyListResponseSerializer serializer]; break;
        case CYResponseSeializerTypeCompound: return [AFCompoundResponseSerializer serializer]; break;
        case CYResponseSeializerTypeImage: return [AFImageResponseSerializer serializer]; break;
        case CYResponseSeializerTypeData: return [AFHTTPResponseSerializer serializer]; break;
        default: return [AFJSONResponseSerializer serializer]; break;
    }
}

@end

设计代码示例 - CYBaseRequest
#import "CYRequestConstant.h"

typedef void(^CYBaseRequestCompletionHandle)(BOOL success, id response, NSString *message);

@interface CYBaseRequest : NSObject

@property (nonatomic, copy) NSString *url;

@property (nonatomic, assign) CYRequestMethodType methodType;

@property (nonatomic, strong) NSDictionary *extraParams;

- (void)sendRequestWithCompletionHandle:(CYBaseRequestCompletionHandle)completionHandle;

@end

#import "CYBaseRequest.h"
#import "YYModel.h"
#import "CYRequestManager.h"

@implementation CYBaseRequest

- (void)sendRequestWithCompletionHandle:(CYBaseRequestCompletionHandle)completionHandle {
    if (!_url || !_url.length) return;
    [CYRequestManager requestWithURLString:_url
                                    params:[self params]
                                methodType:self.methodType
                            serializerType:CYResponseSeializerTypeJSON
                             successHandle:^(NSURLSessionTask *task, id response) {
                                 !completionHandle ?: completionHandle(YES, response, nil);
                             } failureHandle:^(NSURLSessionTask *task, NSError *error) {
                                 !completionHandle ?: completionHandle(NO, nil, error.description);
                             }];
}

- (NSDictionary *)params {
    NSDictionary *json = self.yy_modelToJSONObject;
    if ([json isKindOfClass:[NSDictionary class]]) {
        NSMutableDictionary *params = [(NSDictionary *)json mutableCopy];
        [params addEntriesFromDictionary:self.extraParams];
        for (NSString *delKey in @[@"url", @"methodType", @"extraParams"]) {
            if ([params.allKeys containsObject:delKey]) {
                [params removeObjectForKey:delKey];
            }
        }
        for (id key in params.allKeys) {
            id obj = [params objectForKey:key];
            if (!obj || [obj isKindOfClass:[NSNull class]] || obj == (id)kCFNull) {
                [params removeObjectForKey:key];
            }
        }
        return params;
    }
    return self.extraParams;
}
@end

相关文章

网友评论

  • 大猿媛:请问,通过创建一个request对象,内部进行url设置,参数设置,再进行网络请求,每个网络请求的创建都要创建一个reuqest对象,和下面这种普通方式比较有什么好处?
    如:在对AFN进行封装后的第二层,通过一个类,使用类方法传入参数,内部设置url,像这样 + (NSURLSessionDataTask *)getUserFollowListWithParam:(NSDictionary*)param completeHandler:(CompleteHandler)completeHandler;,内部调用对AFN封装后的网络请求单例
    您的这种方式有什么好处,相比较
  • 路要自己丶走:为啥调用之后success一直返回的NO呢
  • 90后大叔:请问 CYBaseRequest 里 params 两个for循环的removeObjectForKey什么意思
  • yzhxcql:据说大众点评就是这么干的
    thinkeryoon:@Charles姚 先点赞后阅读,实在亲戚!
    thinkeryoon:虽然我还没来及看,但是先给你个鼓励
    Charles___:是么,这个Request Model模式我一直在用,比较方便
  • 未来行者:其实本质换汤不换药,都是采用的block方式,简单的封装就能满足大部分需求,我个人更倾向于离散化网络请求方式,更好控制,可以研究下猿题库的方式,很强大
    Charles___:@未来行者 嗯,回头我加上代理回调方式,然后你说的这个销毁处理我没太明白具体是什么意思?
    未来行者:@Charles你这个是离散型,但我更倾向于用代理来回调数据,并且我不知道你有没有对还在放飞的请求退回的时候做销毁处理,并且要尽量做到每个请求管理自己的行为
    Charles___:嗯,这个应该就是离散式的吧
  • 90后大叔:额 很不错的封装 赞+收藏
    90后大叔:@Charles姚 如果有更新,麻烦一起更新下文章
    Charles___:@90后大叔 谢谢
  • 灯笼大人:很强大,结合yymodel 省去了很多的 步骤,封装性很强大
    ,正需要。
    Charles___:@灯笼大人 cd么哥
    灯笼大人:@CharlesJF :v:
    Charles___:嗯,谢谢哥
  • 丶活在当下:很好很强大
    Charles___:@丶活在当下 谢谢。。

本文标题:iOS网络请求封装,基于AFN(iOS)

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