Latest 1.2.0
Homepage https://github.com/Andy888888/YRequestManager
License MIT
Platforms ios 7.0
Dependencies AFNetworking
Frameworks UIKit, Foundation
Authors

Logo

CocoaPods Compatible
Language
Platform
Download

Base AFNetworking Core Network Request Framework

联系我:[email protected]

Description

简介

基于AFNetworking作为网络请求核心,封装的网络请求管理工具。通过Api类作为请求配置描述,Manager做为管理发送方来发出请求;默认提供了三个拦截器:NetworkProtocalInterceptor(错误后处理状态码,网络层),ReqLogInterceptor(发起请求前打印日志),RespSucInterceptor(响应成功后做数据转实体,可用第三方转换工具);RequestManager提供了默认实例化方法:defaultMamanger,会把默认的三个拦截器加入进来,如果项目中不想用这三个拦截器,或不满足需求,可继承他们的父类自己重写,当然,RequestManager的实例化方法也要改为:initManagerWithYDelegate。

pod 使用

pod search YRequestManager
pod 'YRequestManager'

结构概览

1.ApiDelegate
2.AbsApi
3.BaseApi
4.BaseServiceManager
5.RequestManager

详解

1.ApiDelegate Protocal协议

该协议规范了凡遵守该协议的Api对象都拥有getReqUrl,getReqHeader,getReqBody,getRequestMethod,getTimeOut方法。这种设计方式借鉴了Java,C#语法的Interface接口的设计思想。

  • getReqUrl 用来配置请求地址Url,遵守者实现该方法需返回一个NSString对象。
  • getReqHeader 用来配置请求Header,遵守者实现该方法需返回一个NSDictionary对象。
  • getReqBody 用来配置请求Body,遵守者实现该方法需返回一个NSDictionary对象。
  • getRequestMethod用来配置该请求方式,用enum枚举RequestMethod来区分,可返回RequestMethodPOST(Post请求)、RequestMethodGET(Get请求)RequestMethodPUT(Put请求)、RequestMethodDELETE(Delete请求)。
  • getTimeOut 用来配置请求超时时间。

2.AbsApi abstract抽象类

请求抽象类,规范了继承自AbsApi需要实现的方法。这种设计方式借鉴了Java,C#语法的abstract抽象类的设计思想。

  • getRootUrl 请求域名url。默认为nil,遵守实现者必须实现。
  • getPath 请求url后半部分。默认为nil,遵守实现者必须实现。
  • getBaseHeader 基本header。默认为nil,若有每个请求必填的header字段,请实现此方法。
  • getHeader 基本header以外的请求header。默认为nil,遵守实现者必须实现。
  • getBaseBody 基本body。默认为nil,若有每个请求必填的body字段,请实现此方法。
  • getBody 基本body以外的请求body。默认为nil,遵守实现者必须实现
  • getRespClass 用来指定该请求返回的数据实体Class,遵守者重写该方法需返回一个Class类型[Entity class],将返回的数据转换成指定数据实体对象。同时在同一页面中发起n个不同api请求后,返回的数据,我们可以通过class来区别。

3.BaseApi 请求Api基类

请求基类,继承自AbsApi,且遵守了ApiDelegate协议。
内部实现了ApiDelegate协议的方法,大家使用时直接继承BaseApi。而如果BaseApi如果不符合你的口味,你可以来自定义一个继承AbsApi又遵守BaseApiDelegate协议的对象

4.BaseServiceManager

用来使用AFNetWorking发送请求,只是个管理者,本身并不具备发送请求能力;目前依赖于AFNetWorking来发送网络请求;在内部封装了一些默认创建AFHTTPSessionManager的方法。

/// 使用block方式发送数据请求;api:发送参数,sucBlock:成功回调,failBlock:失败回调
- (void)request:(AbsApi<ApiDelegate>*)api
       sucBlock:(RespSucBlock)sucBlock
      failBlock:(RespFailBlock)failBlock;

该方法使用Block回调来发送请求,api参数为继承AbsApi抽象类,且遵守ApiDelegate协议的对象,(PS:BaseApi就符合该约束,凡继承BaseApi的对象都符合该参数约束) BaseServiceManager内部通过api对象配置来发送请求。sucBlockfailBlock为请求成功/失败回调。

5.RequestManager

继承自BaseServiceManager;设计此Manager主要目的是,后期不采用AFNetWorking时,可在本类的发送方法sendRequest…中切换其他第三方请求框架即可,而不需要项目中到处修改AFNetWorking请求为其他方式请求,同时担任着控制第三方请求的角色;因此,即使看不惯本类,也不要修改;另外,本类增加了Protocal回调数据方式请求。

/// ResponseDelegate 数据响应回调协议
@property (nonatomic,assign) id<YResponseDelegate> ydelegate;

+ (id)initManagerWithDelegate:(id<ResponseDelegate>)delegate;
/// 发送数据请求,参数为继承AbsApi抽象类,且遵守BaseApiDelegate协议 的对象
- (void)sendRequest:(AbsApi<ApiDelegate>*)api;

我们可以直接使用initManagerWithYDelegate:或者defaultManager方法来初始化RequestManager对象,将数据回调协议delegate传入。
使用request:方法来发送请求,同父类一致,api参数为继承AbsApi抽象类,且遵守BaseApiDelegate协议的对象。而上述BaseApi就符合这一点,而BaseApi如果不符合你的口味,你可以来自定义一个继承AbsApi又遵守BaseApiDelegate协议的对象。

使用方式

1.Api配置类

  • Api配置类使用
// 导入
#import "BaseApi.h"

// PokemonBaseApi继承自BaseApi
@implementation PokemonBaseApi

- (NSString *)getRootUrl
{
    return @"https://pokevision.com/";
}

- (int)getTimeOut
{
    return 30;
}

- (int)getRequestMethod
{
    return RequestMethodGET;
}

- (NSString *)checkRespData:(id)data
{
    PokemonBaseDo *pokemon = data;
    NSString *status = pokemon.status;
    if(![status isEqualToString:@"success"]){
        return @"查询失败";
    }
    return nil;
}
@end
// PokemonPositionApi继承自PokemonBaseApi
@implementation PokemonPositionApi

- (NSString *)getPath
{
    return @"map/data/34.00/-118.5";
}

- (NSDictionary *)getBody
{
    return @{@"User":_user,@"Pwd":_pwd};
}

- (Class)getRespClass
{
    return [PkPositionDo class];
}

- (int)getRequestMethod
{
    return RequestMethodGET;
}

@end
  • Api配置类的实例化

// 初始化要请求的接口配置
PokemonPositionApi *api = [[PokemonPositionApi alloc]init];
// 设置配置:请求body参数
api.user = @"andy";
api.pwd = @"pwd";

2.RequestManager请求

  • RequestManager请求

#import "RequestManager.h"

// 初始化请求管理类
RequestManager *reqManager = [RequestManager defaultManager:self];
// 添加响应成功后,数据转换实体方式拦截器
[reqManager setInterceptorForSuc:[DataConvertInterceptor new]];
// 发送请求:Protocol方式接收数据
[reqManager request:api];

// 发送请求:Block方式接收数据
[reqManager request:api sucBlock:^(CentaResponse *result) {
        if(result.suc){
            PkPositionDo *position = result.data;
            NSString *status = position.status;
            NSLog(status);
        }else{
            NSLog(result.msg);
        }
    } failBlock:^(CentaResponse *error) {
        NSLog(error.msg);
    }];

  • DataConvertInterceptor (继承自InterceptorForRespSuc)

    DataConvertInterceptor并非框架自带,因为框架不应该绑架业务层使用什么做数据转换,
    因此,这个过程开放出来,自行决定。(示例代码中是使用yyModel转换)


@implementation DataConvertInterceptor

- (CentaResponse *)convertData:(id)task andRespData:(id)respData andApi:(AbsApi<ApiDelegate> *)api
{
    CentaResponse *resp =  [super convertData:task andRespData:respData andApi:api];
    NSDictionary *dic = resp.data;

    // 使用yymodel转换成目标实体
    Class cls = api.getRespClass;
    resp.data = [cls yy_modelWithDictionary:dic];

    return resp;
}
@end

Latest podspec

{
    "name": "YRequestManager",
    "version": "1.2.0",
    "summary": "Network Request Manager Base IOS AFNetworking Framework. Singleton Manager / Response NSDictionary / Get Params.",
    "description": "u57fau4e8eAFNetworkingu4f5cu4e3au7f51u7edcu8bf7u6c42u6838u5fc3uff0cu5c01u88c5u7684u7f51u7edcu8bf7u6c42u7ba1u7406u5de5u5177u3002u901au8fc7Apiu7c7bu4f5cu4e3au8bf7u6c42u914du7f6eu63cfu8ff0uff0cManageru505au4e3au7ba1u7406u53d1u9001u65b9u6765u53d1u51fau8bf7u6c42uff1bu9ed8u8ba4u63d0u4f9bu4e86u4e09u4e2au62e6u622au5668uff1aNetworkProtocalInterceptoruff08u9519u8befu540eu5904u7406u72b6u6001u7801uff0cu7f51u7edcu5c42uff09uff0cReqLogInterceptoruff08u53d1u8d77u8bf7u6c42u524du6253u5370u65e5u5fd7uff09uff0cRespSucInterceptoruff08u54cdu5e94u6210u529fu540eu505au6570u636eu8f6cu5b9eu4f53uff0cu53efu7528u7b2cu4e09u65b9u8f6cu6362u5de5u5177uff09uff1bRequestManageru63d0u4f9bu4e86u9ed8u8ba4u5b9eu4f8bu5316u65b9u6cd5uff1adefaultMamangeruff0cu4f1au628au9ed8u8ba4u7684u4e09u4e2au62e6u622au5668u52a0u5165u8fdbu6765uff0cu5982u679cu9879u76eeu4e2du4e0du60f3u7528u8fd9u4e09u4e2au62e6u622au5668uff0cu6216u4e0du6ee1u8db3u9700u6c42uff0cu53efu7ee7u627fu4ed6u4eecu7684u7236u7c7bu81eau5df1u91cdu5199uff0cu5f53u7136uff0cRequestManageru7684u5b9eu4f8bu5316u65b9u6cd5u4e5fu8981u6539u4e3auff1ainitManagerWithYDelegateu3002",
    "homepage": "https://github.com/Andy888888/YRequestManager",
    "license": "MIT",
    "authors": {
        "u71d5u6587u5f3a": "[email protected]"
    },
    "platforms": {
        "ios": "7.0"
    },
    "source": {
        "git": "https://github.com/Andy888888/YRequestManager.git",
        "tag": "1.2.0"
    },
    "source_files": "YRequestManager/RequestManager/**/*.{h,m}",
    "frameworks": [
        "UIKit",
        "Foundation"
    ],
    "dependencies": {
        "AFNetworking": [
            "~> 3.1.0"
        ]
    }
}

Pin It on Pinterest

Share This