xn_base_Client_AF.m 15.5 KB

Edit Raw Blame History Permalink

//
//  xn_base_Client_AF.m
//  xn_base_ios
//
//  Created by 钱鋆 on 15/12/16.
//  Copyright © 2015年 xn. All rights reserved.
//

#import "xn_base_Client_AF.h"


@implementation xn_base_Client_AF

#pragma mark 创建单例
/**
 *  @author qianjun
 *
 *  @brief  创建单例
 *
 *  @return self
 */
+ (instancetype)sharedInstance {
    static id sharedInstance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedInstance = [[self alloc] init];
    });
    return sharedInstance;
}

#pragma mark -配置后台连接参数
/**
 *  @author qianjun
 *
 *  @brief 配置后台连接信息
 *
 *  @param urlString 连接地址
 *  @param appKey    key
 *  @param appSecret secret
 *  @param maxTask 任务最大并发操作数
 */
-(void)f_configByUrl:(NSString *)urlString appKey:(NSString *)appKey appSecret:(NSString *)appSecret maxTask:(NSInteger)maxTask
{
    _str_url = urlString;
    _str_key = appKey;
    _str_secret = appSecret;
    _integer_maxTask = maxTask;
    if (_manager) {
        [_manager.operationQueue cancelAllOperations];
        _manager = nil;
    }
    _manager = [AFHTTPSessionManager manager];

    [NSURLSessionConfiguration defaultSessionConfiguration].HTTPMaximumConnectionsPerHost = _integer_maxTask;
}

#pragma mark - 以异步方式发送请求(AF没有同步方法)
/**
 *  @author qianjun
 *
 *  @brief 以异步方式发送请求(AF没有同步方法)
 *
 *  @param request 发送的请求对象
 *  @param isPost  是否是Post请求
 *  @param tag     请求的下标(用于异步完成后的通知判定)
 */
-(void)f_sendRequest:(BaseRequest *)request isPost:(BOOL)isPost tag:(NSInteger)tag
{
    // 后台配置检查
    [self f_configCheck];
    // 初始化出错信息
    _str_err = kNoError;
    // 网络状态监测
    if (![self f_checkNetworkState]) {
        _str_err = @"网络连接出现异常,请检查网络设置";
    }

    NSLog(@" api Methed=%@  %@,request: %@ ",request.method,[NSDate date],request.fields);
    // 生成签名
    request.app_key = _str_key;
    request.secret = _str_secret;
    request.sign = [request createSign];

    __block BaseResponse *_res_base = [[BaseResponse alloc]init];

    NSMutableDictionary *_muDic_parameter = [[NSMutableDictionary alloc] init];
    NSArray *_arr_key = [request.fields allKeys];

    NSLog(@"发送的Mehtod:%@",request.method);

    for (int i = 0; i < _arr_key.count; i++) {
        if ([[request.fields objectForKey:[_arr_key objectAtIndex:i]] isKindOfClass:[NSArray class]]) {
            [_muDic_parameter setObject:[self event_toJSONString:[request.fields objectForKey:[_arr_key objectAtIndex:i]]] forKey:[_arr_key objectAtIndex:i]];
        }else{
            [_muDic_parameter setObject:[request.fields objectForKey:[_arr_key objectAtIndex:i]] forKey:[_arr_key objectAtIndex:i]];
        }
    }

    // 定义successBlock
    void(^block_success)(NSURLSessionTask *task, id responseObject) = ^(NSURLSessionTask *task, id responseObject) {
        _str_err = kNoError;
        if ([responseObject isKindOfClass:[NSDictionary class]]) {
            _res_base.fields = [NSMutableDictionary dictionaryWithDictionary:responseObject];
        }else if([responseObject isKindOfClass:[NSString class]]){
            // TODO 用于捕捉404这种请求错误？
            if([responseObject hasPrefix:@"<html>"])
            {
                _str_err = kDefaultMsg;
            }
            else
            {
                _res_base = [_res_base analyzeJson:responseObject];
            }
        }

        // 设定业务错误
        [self l_setBusinessErr:_res_base];

        // 暴露错误信息给CommFun
//        [SharedDataManager sharedInstance].errMsg = [_str_err isEqualToString:kNoError]?nil:_str_err;

        if(![_str_err isEqualToString:kNoError])
        {
            NSLog(@"错误返回的Mehtod:%@",request.method);
            NSLog(@"错误返回的错误信息:%@",_str_err);
            NSLog(@"错误返回的response:%@",responseObject);
        }
        else
        {
            NSLog(@"正常返回的Mehtod:%@",request.method);
            NSLog(@"正常返回的response:%@",responseObject);
        }

        // 定义回调通知的userInfo字典
        NSDictionary *dic_userInfo = @{kResponseNotiKey_tag: [NSNumber numberWithInteger:tag],kResponseNotiKey_baseResponse:_res_base,kResponseNotiKey_error:_str_err?_str_err:kNoError};
        // 根据协议发送请求结果
        [self l_sendResponeByDic:dic_userInfo];
    };

    // 定义failureBlock
    void(^block_failure)(NSURLSessionTask *operation, NSError *error) = ^(NSURLSessionTask *operation, NSError *error) {

        NSLog(@" api Methed=%@  %@,response: %@ ",request.method,[NSDate date],error);
        _str_err = kNoError;

        // 如果有error，证明前面的task出错了，直接用第一个出错的task的异常信息
        // 如因某个task出现问题，执行了取消剩余task操作，那么剩余的所有task都会收到一个取消的错误信息，这个错误信息是没有必要告知用户的。只要告知那个出了问题的task的出错原因

        if ([_str_err isEqualToString:kNoError]) {
            NSLog(@"已经存在异常信息,使用第一个出错的异常");
            // 设定系统级别错误
            [self l_setSysError:error];
        }

        // 暴露错误信息给CommFun
//        [SharedDataManager sharedInstance].errMsg = [_str_err isEqualToString:kNoError]?nil:_str_err;

        // 定义回调通知的userInfo字典
        NSDictionary *dic_userInfo = @{kResponseNotiKey_tag: [NSNumber numberWithInteger:tag],kResponseNotiKey_baseResponse:_res_base,kResponseNotiKey_error: _str_err};


        // 根据协议发送请求结果
        [self l_sendResponeByDic:dic_userInfo];
    };

    // 创建请求
    if(isPost)
    {
        // post
        [_manager POST:_str_url parameters:_muDic_parameter progress:nil success:block_success failure:block_failure];
    }
    else
    {
        // get
        [_manager GET:_str_url parameters:_muDic_parameter progress:nil success:block_success failure:block_failure];
    }
}


-(void)f_sendRequest:(BaseRequest *)request isPost:(BOOL)isPost completion:(COMPLETIONBLOCK)block
{
    // 后台配置检查
    [self f_configCheck];
    // 初始化出错信息
    _str_err = kNoError;
    // 网络状态监测
    if (![self f_checkNetworkState]) {
        _str_err = @"网络连接出现异常,请检查网络设置";
    }

    // 生成签名
    request.app_key = _str_key;
    request.secret = _str_secret;
    request.sign = [request createSign];

    __block BaseResponse *_res_base = [[BaseResponse alloc]init];

    NSMutableDictionary *_muDic_parameter = [[NSMutableDictionary alloc] init];
    NSArray *_arr_key = [request.fields allKeys];

    NSLog(@"发送的Mehtod:%@",request.method);

    for (int i = 0; i < _arr_key.count; i++) {
        if ([[request.fields objectForKey:[_arr_key objectAtIndex:i]] isKindOfClass:[NSArray class]]) {
            [_muDic_parameter setObject:[self event_toJSONString:[request.fields objectForKey:[_arr_key objectAtIndex:i]]] forKey:[_arr_key objectAtIndex:i]];
        }else{
            [_muDic_parameter setObject:[request.fields objectForKey:[_arr_key objectAtIndex:i]] forKey:[_arr_key objectAtIndex:i]];
        }
    }

    // 定义successBlock
    void(^block_success)(NSURLSessionTask *task, id responseObject) = ^(NSURLSessionTask *task, id responseObject) {
        _str_err = kNoError;
        if ([responseObject isKindOfClass:[NSDictionary class]]) {
            _res_base.fields = [NSMutableDictionary dictionaryWithDictionary:responseObject];
        }else if([responseObject isKindOfClass:[NSString class]]){
            // TODO 用于捕捉404这种请求错误？
            if([responseObject hasPrefix:@"<html>"])
            {
                _str_err = kDefaultMsg;
            }
            else
            {
                _res_base = [_res_base analyzeJson:responseObject];
            }
        }

        // 设定业务错误
        [self l_setBusinessErr:_res_base];

        // 暴露错误信息给CommFun
//        [SharedDataManager sharedInstance].errMsg = [_str_err isEqualToString:kNoError]?nil:_str_err;

        if(![_str_err isEqualToString:kNoError])
        {
            NSLog(@"错误返回的Mehtod:%@",request.method);
            NSLog(@"错误返回的错误信息:%@",_str_err);
            NSLog(@"错误返回的response:%@",responseObject);
        }
        else
        {
            NSLog(@"正常返回的Mehtod:%@",request.method);
            NSLog(@"正常返回的response:%@",responseObject);
        }

         NSDictionary *dic_userInfo = @{kResponseNotiKey_baseResponse:_res_base,kResponseNotiKey_error:_str_err?_str_err:kNoError};
        block(dic_userInfo);

    };

    // 定义failureBlock
    void(^block_failure)(NSURLSessionTask *operation, NSError *error) = ^(NSURLSessionTask *operation, NSError *error) {

        NSLog(@" api Methed=%@  %@,response: %@ ",request.method,[NSDate date],error);
        _str_err = kNoError;

        // 如果有error，证明前面的task出错了，直接用第一个出错的task的异常信息
        // 如因某个task出现问题，执行了取消剩余task操作，那么剩余的所有task都会收到一个取消的错误信息，这个错误信息是没有必要告知用户的。只要告知那个出了问题的task的出错原因

        if ([_str_err isEqualToString:kNoError]) {
            NSLog(@"已经存在异常信息,使用第一个出错的异常");
            // 设定系统级别错误
            [self l_setSysError:error];
        }

        // 暴露错误信息给CommFun
//        [SharedDataManager sharedInstance].errMsg = [_str_err isEqualToString:kNoError]?nil:_str_err;
         NSDictionary *dic_userInfo = @{kResponseNotiKey_baseResponse:_res_base,kResponseNotiKey_error:_str_err?_str_err:kNoError};
        block(dic_userInfo);
    };

    // 创建请求
    if(isPost)
    {

        // post
        [_manager POST:_str_url parameters:_muDic_parameter progress:nil success:block_success failure:block_failure];
    }
    else
    {
        // get
        [_manager GET:_str_url parameters:_muDic_parameter progress:nil success:block_success failure:block_failure];
    }
}


#pragma mark 设定系统级别错误
/**
 *  @author qianjun
 *
 *  @brief 设定系统级别错误
 *
 *  @param error NSError对象
 */
-(void)l_setSysError:(NSError *)error
{
    if (kShowSysErr) {
        // 调试状态下
        if (error.localizedDescription) {
            _str_err = [NSString stringWithFormat:@"%@",error.localizedDescription];
        }else{
            _str_err = kDefaultMsg;
        }
        _str_err = [NSString stringWithFormat:@"%@",error.localizedDescription];
    }else{
        // 发布状态下
        _str_err = kDefaultMsg;
    }
}

#pragma mark 设定业务毕节错误(非请求本身出错)
/**
 *  @author qianjun
 *
 *  @brief 设定业务错误(非请求本身出错)
 *
 *  @param response 请求返回
 */
-(void)l_setBusinessErr:(BaseResponse *)response
{
    if (!response || !response.fields || response.fields.count == 0) {
        _str_err = kDefaultMsg;
    }else{
        if([_str_err isEqualToString:kNoError]) {
            if (response.code || response.message || response.solution) {
                _str_err =  response.message;
            }
        }
    }
}

#pragma mark 利用断言检查后台核心配置项是否已经设置
/**
 *  @author qianjun
 *
 *  @brief 利用断言检查后台核心配置项是否已经设置
 */
-(void)f_configCheck
{
    NSAssert(_str_url, @"未设定后台URL!");
    NSAssert(_str_key, @"未设定后台appKey!");
    NSAssert(_str_secret, @"未设定后台secret!");
}

#pragma mark - 检测当前的网络状态
/**
 *  @brief 检测当前的网络状态
 *
 *  @return BOOL 是否有网络可用
 */
- (BOOL)f_checkNetworkState
{
    return YES;
    // 1.检测wifi状态
//    Reachability *wifi = [Reachability reachabilityForLocalWiFi];
//
//    // 2.检测手机是否能上网络(WIFI\3G\2.5G)
//    Reachability *conn1 = [Reachability reachabilityForInternetConnection];
//
//    // 3.判断网络状态
//    if ([wifi currentReachabilityStatus] != NotReachable) { // 有wifi
//        NSLog(@"有wifi");
//        return YES;
//
//    } else if ([conn1 currentReachabilityStatus] != NotReachable) { // 没有使用wifi, 使用手机自带网络进行上网
//        NSLog(@"使用手机自带网络进行上网");
//        return YES;
//    } else { // 没有网络
//
//        NSLog(@"没有网络");
//        return NO;
//    }
}

#pragma mark -取消所有任务
/**
 *  @author qianjun
 *
 *  @brief 取消所有任务
 */
-(void)f_cancelAllTask
{
    for (NSURLSessionTask *task in _manager.tasks) {
        NSLog(@"取消task！！！");
        [task cancel];
    }
}

#pragma mark -挂起所有任务
/**
 *  @author qianjun
 *
 *  @brief 挂起所有任务
 */
-(void)f_suspendAllTask
{
    for (NSURLSessionTask *task in _manager.tasks) {
        NSLog(@"挂起task！！！");
        [task suspend];
    }
}

#pragma mark -返回当前剩余未执行的任务数
/**
 *  @author qianjun
 *
 *  @brief 返回当前剩余未执行的任务数
 */
-(NSInteger)f_getCurrentTaskCount
{
    return _manager.tasks.count;
}

#pragma mark -执行当前剩余任务(一般是用在挂起后)
/**
 *  @author qianjun
 *
 *  @brief 执行当前剩余任务(一般是用在挂起后)
 */
-(void)f_resumeAllTask
{
    for (NSURLSessionTask *task in _manager.tasks) {
        NSLog(@"挂起task！！！");
        [task resume];
    }
}

#pragma mark -添加后台请求的tag
/**
 *  @author qianjun
 *
 *  @brief 添加后台请求的tag
 *
 *  @param tags tag数组
 */
-(void)f_addBackgroundTaskTags:(NSArray *)tags
{
    if (!_muArr_backgroundTaskTags) {
        _muArr_backgroundTaskTags = [[NSMutableArray alloc]initWithArray:tags];
    }
    else
    {
        for (NSNumber *tag in tags) {
            [_muArr_backgroundTaskTags addObject:tag];
        }
    }
}

#pragma mark -------内部方法
#pragma mark -使用协议传递请求结果
-(void)l_sendResponeByDic:(NSDictionary *)userInfo
{

    // 判断是前台请求还是后台请求
    if (_muArr_backgroundTaskTags && [_muArr_backgroundTaskTags containsObject:[userInfo objectForKey:kResponseNotiKey_tag]]) {
        // 后台任务
        if ([self.backgourndTaskDelegate respondsToSelector:@selector(l_backgourndTask:)]) {
            [self.backgourndTaskDelegate l_backgourndTask:userInfo];
        }
        else
        {
//            XNLog(@"不存在后台任务的protocol实现！！");
        }
    }
    else
    {
        // 前台任务
        if ([self.foregroundTaskDelegate respondsToSelector:@selector(l_foregroundTask:)]) {
            [self.foregroundTaskDelegate l_foregroundTask:userInfo];
        }
        else
        {
//            XNLog(@"不存在前台任务的protocol实现！！");
        }
    }
}

- (NSString *)event_toJSONString:(id)theData
{

    if(theData)
    {
        NSData *jsonData = [NSJSONSerialization dataWithJSONObject:theData
                                                           options:NSJSONWritingPrettyPrinted
                                                             error:nil];

        NSString *jsonString = [[NSString alloc] initWithData:jsonData
                                                     encoding:NSUTF8StringEncoding];

        return jsonString;
    }
    return nil;
}

@end