Latest 1.0.0
Homepage https://github.com/MxABC/LBXNetWork
License MIT
Platforms ios 7.0, requires ARC
Dependencies AFNetworking, YYCache
Authors

项目介绍

轻量级http请求,基于封装AFN3.x + YYCache,
接口设计上,通过block返回创建好的请求模型对象,调用者只有对非默认值属性进行修改即可,接口调用完成也只通过一个block来回调,具体情况通过响应模型对象来解析,请求参数及结果都通过一个对象来完成,方便扩展,具体使用时,可结合自己的app,增加一层业务层接口,业务层内部添加hud,默认参数,安全策略等

  • 支持GET、POST、PUT、DELETE
  • 支持批量请求
  • 支持缓存

install by cocoapods

需要AFNetworking3.x和YYCache1.x支持

pod 'LBXNetWork', '~> 1.0.0'

手动

将LBXNetWork文件夹拖到工程里,并且需要AFNetworking3.x和YYCache1.0.x库

使用示例

具体使用看Demo首页里面几个调用方法以及模拟业务层LBXNetwork (TheAPP)代码及说明

 [LBXNetwork HttpWithRequestBlock:^(LBXHttpRequest * request) {

       request.responseSerializerType = LBXHTTPSerializerTypeRAW;
       request.httpMethod = LBXHTTPMethodTypeGET;
       request.responseAcceptableContentTypes = [NSSet setWithObjects:@"text/html",@"application/javascript",nil];

       request.server = @"https://tcc.taobao.com/";
       request.api = @"cc/json/mobile_tel_segment.htm";
       //        request.requestUrl = @"https://tcc.taobao.com/cc/json/mobile_tel_segment.htm";

        request.requestParameters = @{@"tel":@"15852509988"};

    } complection:^(LBXHttpResponse * _Nonnull response) {
        NSLog(@"response");

        if (response.success && response.responseObject) {

            NSString *str = [[NSString alloc]initWithData:response.responseObject encoding:NSASCIIStringEncoding];

            NSLog(@"%@",str);
        }
        else if (response.error)
        {
            NSLog(@"error:%@",response.error);
            //用户主动取消请求
            if (response.error.code == NSURLErrorCancelled) {
                NSLog(@"user canceled");
            }
        }
    }];

LBXHttpRequest请求参数通过block回调回来,调用者根据主要根据接口实际业务填充相关参数即可
下面为LBXHttpRequest的定义,具体使用时,查看每个属性的说明即可

///请求或返回数据形式
typedef NS_ENUM(NSInteger, LBXHTTPSerializerType) {
    LBXHTTPSerializerTypeJSON = 0,      /// JSON object
    LBXHTTPSerializerTypeRAW = 1 //NSData object,二进制数据,内部已经默认设置 Content-Type  application/x-www-form-urlencoded
};

/**
 HTTP methods 请求方法.
 */
typedef NS_ENUM(NSInteger, LBXHTTPMethodType) {
    LBXHTTPMethodTypeGET    = 0,
    LBXHTTPMethodTypePOST   = 1,
    LBXHTTPMethodTypeDELETE = 2,
    LBXHTTPMethodTypePUT    = 3
};

@interface LBXHttpRequest : AFNNetworkRequest

/**
 The server address for request, eg. "http://example.com/v1/"
 */
@property (nonatomic, copy, nullable) NSString *server;

/**
 The API interface path for request, eg. "foo/bar", `nil` by default.
 */
@property (nonatomic, copy, nullable) NSString *api;

/**
 The final URL of request, which is combined by `server` and `api` properties, eg. "http://example.com/v1/foo/bar", `nil` by default.
 NOTE: when you manually set the value for `requestUrl`, the `server` and `api` properties will be ignored.
 */
@property (nonatomic, copy, nullable) NSString *requestUrl;

///上传参数形式,默认值 LBXHTTPSerializerTypeJSON
@property (nonatomic, assign) LBXHTTPSerializerType requestSerializerType;

///返回数据类型,默认值 LBXHTTPSerializerTypeJSON
@property (nonatomic, assign) LBXHTTPSerializerType responseSerializerType;

//请求方法,GET,POST,DELETE,PUT,默认POST
@property (nonatomic, assign) LBXHTTPMethodType httpMethod;

///请求超时时间,默认10s
@property (nonatomic, assign) NSTimeInterval timeoutInterval;

///设置http请求信息头(HTTPHeaderField),默认为nil
@property (nonatomic, strong,nullable) NSDictionary<NSString*,NSString*> *headers;

///上传参数,类型为NSDictionary或NSData,默认nil
@property (nonatomic, strong,nullable) id requestParameters;

/**
 接收http响应数据ContentTypes
 默认值:
 [NSSet setWithObjects:@"application/json",@"text/json",@"text/javascript",@"application/javascript",@"text/html",@"text/plain",@"multipart/form-data",nil];
 */
@property (nonatomic, copy, nullable) NSSet <NSString *> *responseAcceptableContentTypes;

/**
 如果设置YES,在requestParameters赋值的时候,会打印请求数据的日志
 默认值策略:
 - debug环境:YES
 - release环境:NO
 */
@property (nonatomic) BOOL debugLogEnabled;

/**
 支持缓存,调用成功后缓存到本地,调用失败,读取缓存,默认值NO
 */
@property (nonatomic, assign) BOOL cacheEnable;

/**
 先读取缓存,不调用接口,如果没有缓存则调用接口,默认值NO
 */
@property (nonatomic, assign) BOOL cachedPrior;

/**
 报错统一处理,供上层使用,LBXNetwork没有使用该参数
 默认值NO

 如业务层可以添加一层,报错自动弹出toast提示错误,
 如果有报错信息,且errAutoHandle为YES,则响应返回needHandle值为NO
 */
@property (nonatomic, assign) BOOL errAutoHandle;

@end

接口返回模型定义

@interface LBXHttpResponse : NSObject

/**
 LBXNetwork层没有使用该参数,上层封装时可以参考以下建议使用

 - 上层是否需要处理,部分业务可能底层统一处理了,如用户取消请求,业务上统一报错的toast提示等
 - 接口返回返回的地方,先判断值是否为YES,为NO一般不需要处理,其他情况:如果是下拉刷新则结束下拉刷新即可
 - 如果业务上不需要该参数,也可以忽略参数
 */
@property (nonatomic, assign,getter=isNeedHandle) BOOL needHandle;

/**
 接口是否调用成功,下面2种情况下值为YES
 - 接口调用成功,不是网络连接失败
 - 网络连接失败,但是读取缓存数据成功,cachedResponse设置为YES
 */
@property (nonatomic, assign) BOOL success;

///接口返回失败后的错误信息,如果成功则为nil,有错误信息,responseObject数据也可能读取了缓存的数据
@property (nonatomic, strong,nullable) NSError *error;

///保存的请求信息
@property (nonatomic, strong,nullable) LBXHttpRequest *request;

/**
 如果设置YES,在responseObject赋值的时候,会打印返回的数据的日志
 默认值策略:
 - debug环境:YES
 - release环境:NO
 */
@property (nonatomic) BOOL debugLogEnabled;

/**
 调用成功后的返回数据,接口返回或读取缓存的数据,类型为NSDictionary或NSData
 */
@property (nonatomic, strong,nullable) id responseObject;

///返回的数据是否是缓存的
@property (nonatomic, assign,getter=isCachedResponse) BOOL cachedResponse;

///返回参数,初始化默认值-1,成功请求后的值为http statuscode的值,如200,301,404,500等

/**
 http statusCode
 默认值为-1
 接口调用成功后,一般值为2xx,3xx,4xx,5xx
 */
@property (nonatomic, assign) NSInteger statusCode;

@end

参考

Latest podspec

{
    "name": "LBXNetWork",
    "version": "1.0.0",
    "summary": "http request,tcp stream",
    "homepage": "https://github.com/MxABC/LBXNetWork",
    "license": "MIT",
    "authors": {
        "lbxia": "[email protected]"
    },
    "source": {
        "git": "https://github.com/MxABC/LBXNetWork.git",
        "tag": "1.0.0"
    },
    "platforms": {
        "ios": "7.0"
    },
    "source_files": "LBXNetWork/**/*.{m,h}",
    "public_header_files": [
        "LBXNetWork/AFNetworkVendor/AFNNetworkRequest.h",
        "LBXNetWork/LBXHttpRequest.h",
        "LBXNetWork/LBXNetWork.h",
        "LBXNetWork/LBXTcpStream/LBXTcpStream.h"
    ],
    "ios": {
        "frameworks": [
            "Foundation",
            "UIKit"
        ]
    },
    "dependencies": {
        "AFNetworking": [
            "~> 3.2.0"
        ],
        "YYCache": [
            "~> 1.0.4"
        ]
    },
    "requires_arc": true
}

Pin It on Pinterest

Share This