关于AFNetworking请求封装的思考与实践

使用AFNetworking已经有将近三四年的时间，从最初的AFNetworking 2.x 到现在的AFNetworking 3.1.0。AFNetworking已经成为开发iOS项目的必备第三方库之一，不得不说它给开发者节省了大量的开发时间。网上有很多不同的关于AFNetworking的封装代码，但是都存在这这样的或那样的问题，下面是我开发app时封装用法，有不同见解的欢迎在下方留言。

一个好的`AFNetworking`网络请求框架应该具备的特征

1 良好的封装性，开发时方便快速接入
2 接口变更时便于修改 
3 适于多版本迭代开发
4 出现问题时方便定位修改

下面是我封装的AFNetworking网络请求引擎文件目录

QQ20170322-212611.png

扩展后的封装类是这样的，不同的版本的接口可以分成几个不同的文件

QQ20170322-220310.png

LSNetWorkManagerInterface.h 文件

主要存放app所有接口的参数
主要内容如下,使用这种方案的好处在于使用Interface[kServletLogin]取出接口的变动地址，且统一方便管理，后续版本升级时只需再声明一个个枚举和字符串数组就能轻松方便使用

#ifndef LSNetWorkManagerHeader_h
#define LSNetWorkManagerHeader_h

/**
 *  1.6版本接口，与后台版本号,teambition保持一致
 */
static NSString * const Interface[] = {
    @"",
    @"user/appLogin",                    // servlet用户登陆
    
};
/* HTTP接口对应的标识 */
typedef NS_ENUM(NSUInteger, InterfaceAction) {
    kNull = 0,
    kServletLogin,                        //servlet用户登陆
};


#endif /* LSNetWorkManagerHeader_h */

`LSBaseNetWorking.h` 文件

主要包含了请求的服务器返回码kStatusCode，数据字段kResData，STATUS_CODE请求返回的服务器与客户端约定的状态码，公开了两个方法分别对应GET方法与POST方法，其他的解释说明可以参看下面代码

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "LSConstants.h"

#define kStatusCode                 @"status"
#define kResData                    @"resData"

#define LOAD_DATA_PAGESIZE  10

typedef NS_ENUM(NSInteger, STATUS_CODE) {
    STATUS_CODE_CUSTOM_ERROR       = - 10000,
    STATUS_CODE_FAILED             = - 11001,//网络异常类型
    STATUS_CODE_SUCCESS            = 200,//接口调用成功
    STATUS_CODE_NEED_CHARGE        = 10088,//
    
    
};
//额外存储数据时使用
typedef void(^RES_SUCC_OPERATION_BLOCK)(id data);
/**
 *  封装二次请求到dataController时的处理
 *
 *  @param success    请求是否成功
 *  @param resultData 回调数据
 */
typedef void(^RES_SIM_CALLBACK)(BOOL success,id resultData);

typedef void(^RES_SUCC_BLOCK)(id data);
/**
 *  请求失败回调
 *
 *  @param resStatus 服务请请求返回状态码（主）、网络异常导致的失败也包括、不包括STATUS_CODE_SUCCESS
 *  @param data      暂时为字符串类型，包括@“当前网络异常，请稍后重试!”
 */
typedef void(^RES_FAIL_BLOCK)(NSInteger resStatus,id data);


@interface LSBaseNetWorking : NSObject

- (void)getHTTPRequestWithUrlString:(NSString *)urlStr
                         parameters:(NSDictionary *)paraDic
                            success:(RES_SUCC_BLOCK)succ
                            failure:(RES_FAIL_BLOCK)fail;

- (void)postHTTPRequestWithUrlString:(NSString *)urlStr
                          parameters:(NSDictionary *)paraDic
                             success:(RES_SUCC_BLOCK)succ
                             failure:(RES_FAIL_BLOCK)fail;

@end

`LSBaseNetWorking.m`文件

printHTTPUrlWithUrl:parameters:该方法主要是打印你的请求字符串用以方便在控制台查看，定位问题。
requestHTTPRequestWithReqType:UrlString:parameters:operation:success:failure:方法里面封装的主要是AFNetworking的常用GET与POST方法，其中RES_SUCC_OPERATION_BLOCK主要是数据持久化层需要使用到的，一般不常使用

#import "LSBaseNetWorking.h"
#import "AFNetworking.h"
#import "AFNetworkActivityIndicatorManager.h"
typedef NS_ENUM(NSUInteger, HttpRequestType) {
    DoGet,
    DoPost,
};

@interface LSBaseNetWorking ()

@property (nonatomic, strong) AFHTTPSessionManager* httpManager;

@end

@implementation LSBaseNetWorking
- (instancetype)init{
    self = [super init];
    if (self) {
        //
        [[AFNetworkActivityIndicatorManager sharedManager] setEnabled:YES];
        _httpManager = [[AFHTTPSessionManager alloc]initWithBaseURL:[NSURL URLWithString:BASE_URL_STR]];
        NSSet *set = [NSSet setWithObjects:@"text/html",@"text/plain",@"application/json", nil];
        _httpManager.requestSerializer.cachePolicy =  NSURLRequestReloadIgnoringLocalCacheData;
        _httpManager.responseSerializer.acceptableContentTypes = set;
        [_httpManager.reachabilityManager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
            NSLog(@"Reachability = %ld",(long)status);
            switch (status) {
                case AFNetworkReachabilityStatusReachableViaWWAN:
                case AFNetworkReachabilityStatusReachableViaWiFi:
//                    [operationQueue setSuspended:NO];
                    NSLog(@"network is now changed Reachable！！！");
                    break;
                case AFNetworkReachabilityStatusNotReachable:
//                    [operationQueue setSuspended:YES];
                    NSLog(@"network is now changed  NotReachable！！！");
                    break;
                default:
                    break;
            }
        }];
        [_httpManager.reachabilityManager startMonitoring];
    }
    return self;
}

- (void)printHTTPUrlWithUrl:(NSString *)url
                 parameters:(NSDictionary *)parameters{
    NSString *httpUrl = @"";
    NSString *dicKey = nil;
    for (int i = 0; i < [[parameters allKeys] count]; i++) {
        httpUrl = i == 0 ? @"?" : [httpUrl stringByAppendingString:@"&"];
        
        dicKey = [parameters allKeys][i];
        httpUrl = [httpUrl stringByAppendingFormat:@"%@=%@", dicKey, parameters[dicKey]];
    }
    //Warn httpUrl 非nil 否则追加会导致崩溃
    httpUrl = [url stringByAppendingString:httpUrl];
    
    NSLog(@"\n-----------------[HTTP Url]-----------------\n%@%@\
              \n--------------------------------------------", BASE_URL_STR,httpUrl);
}

- (void)requestHTTPRequestWithReqType:(HttpRequestType)reqType
                            UrlString:(NSString *)urlStr
                           parameters:(NSDictionary *)paraDic
                            operation:(RES_SUCC_OPERATION_BLOCK)operAction
                              success:(RES_SUCC_BLOCK)succ
                              failure:(RES_FAIL_BLOCK)fail{
    void (^success)(NSURLSessionTask *operation, id responseObject) = ^(NSURLSessionTask *operation, id responseObject) {
        NSInteger statuscode = [responseObject[ kStatusCode ] integerValue];
        id data = responseObject[kResData];
        if (succ || fail) {//成功或失败有处理就进行打印
            [self printHTTPUrlWithUrl:urlStr parameters:paraDic];
        }
        if (statuscode == STATUS_CODE_SUCCESS) {
            if (operAction) {
                operAction(data);
            }
            if (succ) {
                NSLog(@"\nStatus:%li \n%@\n---------------------------------------", (long)statuscode, responseObject);
                succ(data);
            }
        }else {
            NSString *errorTipMsg = responseObject[kResData];
            //调整输出模式,只有statuscode = 600提示且为字符串通通输出
            if (statuscode == 600 && [errorTipMsg respondsToSelector:@selector(length)] && kStrProperty(errorTipMsg)) {

            }else if (statuscode ==  601 && [errorTipMsg respondsToSelector:@selector(length)] && kStrProperty(errorTipMsg)) {
                UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"温馨提示" message:errorTipMsg delegate:nil cancelButtonTitle:@"我知道了" otherButtonTitles: nil];
                [alertView show];
            }
            if (fail) {
                NSLog(@"responseObject error:%@", responseObject);
                fail([responseObject[kStatusCode] integerValue],data);
            }
        }
    };
    
    void (^failure)(NSURLSessionTask *operation, NSError *error) = ^(NSURLSessionTask *operation, NSError *error) {
        if (succ && fail) {//成功失败都处理才进行打印
            [self printHTTPUrlWithUrl:urlStr parameters:paraDic];
        }
        NSLog(@"Error:%@", error);
        if (fail) {
            fail(STATUS_CODE_FAILED,@"当前网络异常，请稍后重试!");
        }
    };
    
    //    默认追加的参数
    NSMutableDictionary *newParameters = [NSMutableDictionary dictionaryWithDictionary:paraDic];
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        NSLog(@"参数值－－－－%@\n", newParameters);
    });
    if (reqType == DoGet) {
        [_httpManager GET:urlStr parameters:newParameters progress:nil success:success failure:failure];
    } else if (reqType == DoPost){
        [_httpManager POST:urlStr parameters:newParameters progress:nil success:success failure:failure];
    }
}

- (void)postHTTPRequestWithUrlString:(NSString *)urlStr
                          parameters:(NSDictionary *)paraDic
                             success:(RES_SUCC_BLOCK)succ
                             failure:(RES_FAIL_BLOCK)fail{
    [self requestHTTPRequestWithReqType:DoPost
                              UrlString:urlStr
                             parameters:paraDic
                              operation:nil
                                success:succ
                                failure:fail];
}

- (void)getHTTPRequestWithUrlString:(NSString *)urlStr
                         parameters:(NSDictionary *)paraDic
                            success:(RES_SUCC_BLOCK)succ
                            failure:(RES_FAIL_BLOCK)fail{
    [self requestHTTPRequestWithReqType:DoGet
                              UrlString:urlStr
                             parameters:paraDic
                              operation:nil
                                success:succ
                                failure:fail];
}

@end

`LSBaseNetWorking.h`文件

提供了一个单例方法，与一个登陆的事例，该类继承自LSBaseNetWorking


#import "LSBaseNetWorking.h"

@interface LSNetWorkManager : LSBaseNetWorking

+ (instancetype)shareInstance;

//kServletLogin,                        //第三方用户登陆
- (void)doReqLoginWithUserName:(NSString *)userName
                      password:(NSString *)password
                       success:(RES_SUCC_BLOCK)succ
                       failure:(RES_FAIL_BLOCK)fail;

@end

`LSNetWorkManager.m` 文件

介绍登陆接口的一种写法，可仿照此示例进行编写

#import "LSNetWorkManager.h"
#import "MJExtension.h"
#import "LSNetWorkManagerInterface.h"

static LSNetWorkManager *networkManager = nil;

@interface LSNetWorkManager ()


@end

@implementation LSNetWorkManager

+ (instancetype)shareInstance{
    @synchronized (self) {
        if (networkManager == nil) {
            networkManager = [[LSNetWorkManager alloc] init];
        }
    }
    return networkManager;
}

+ (instancetype)allocWithZone:(NSZone *)zone
{
    @synchronized (self) {
        if (networkManager == nil) {
            networkManager = [super allocWithZone:zone];
        }
        return networkManager;
    }
    return nil;
}

#pragma mark - HTTP request
//kServletLogin,                        //用户登陆
- (void)doReqLoginWithUserName:(NSString *)userName
                      password:(NSString *)password
                       success:(RES_SUCC_BLOCK)succ
                       failure:(RES_FAIL_BLOCK)fail{
    NSDictionary *params = @{@"userName" : userName,
                             @"userPsw" : password,
                             };
    [self postHTTPRequestWithUrlString:Interface[kServletLogin]
                            parameters:params
                               success:succ
                               failure:fail];
}

@end

下面是用法

-(IBAction)buttonClick :(UIButton *)butt{
    NSString *userName = self.userNameTF.text;
    NSString *usePsw = self.userPswTF.text;
    [[LSNetWorkManager shareInstance] doReqLoginWithUserName:userName password:usePsw success:^(id data) {
        
    } failure:^(NSInteger resStatus, id data) {
        
    }];
    
}

返回的数据时这样的

QQ20170322-223548.png

设计思想

每个方法都写一个接口看似是多了一些工作量，但是大部分内容都是复制粘贴的，然后修改一些接口和参数，方便后续重复调用。以前也使用过一段时间只封装一层提供两个接口（get+set）的方案，后续发现很多问题；

当接口多的时候，遇到问题进行调试，简直连断点都不知道往哪里打，返回错误的状态码也不知道是哪个接口返回的，所以个人不推荐使用那种只提供两个接口的方案。
然后就是接口的url地址随便乱写，想要修改接口不知道要找多少个类，还有很多接口重复写了多次。
参数乱写，很可能多写或者少写一个参数。

注意事项

1 _httpManager = [[AFHTTPSessionManager alloc]initWithBaseURL:
              [NSURL URLWithString:BASE_URL_STR]];
  BASE_URL_STR不要忘记设置
2 不同接口之间在数组中声明不要忘记写逗号，否则可能将他们拼装起来，
  导致找到不到接口 404错误
3 打印url接口不论是GET接口还是POST接口都是会打印成&链接的URL，请知悉。
4 工程使用了cocoaspod，不了解的同鞋可上网搜索，网上很多教程

demo工程地址

最后编辑于：2017.12.06 05:09:44

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 159,117评论 4赞 362
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 67,328评论 1赞 293
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 108,839评论 0赞 243
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 44,007评论 0赞 206
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 52,384评论 3赞 287
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 40,629评论 1赞 219
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 31,880评论 2赞 313
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 30,593评论 0赞 198
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 34,313评论 1赞 243
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 30,575评论 2赞 246
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 32,066评论 1赞 260
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 28,392评论 2赞 253
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 33,052评论 3赞 236
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 26,082评论 0赞 8
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 26,844评论 0赞 195
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 35,662评论 2赞 274
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 35,575评论 2赞 270

关于AFNetworking请求封装的思考与实践

一个好的AFNetworking网络请求框架应该具备的特征

LSNetWorkManagerInterface.h 文件

LSBaseNetWorking.h 文件

LSBaseNetWorking.m文件

LSBaseNetWorking.h文件

LSNetWorkManager.m 文件