Skip to content
No description, website, or topics provided.
Objective-C Shell Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Example
Pod
.gitignore
.travis.yml
DRDNetworking.podspec
LICENSE
README.md
_Pods.xcodeproj

README.md

DRDNetworking

CI Status codecov.io Version License Platform Carthage compatible

DRDNetworking is a delightful networking library which provide you a convenient way to handle API request, it has no invasion to your project, you won't get into trouble when you remove it one day, even though that's not what I want to see. Currently, we are using AFNetworking 3.0.0+ with Session Manager.
DRDNetworking compatible with RESTFUL API and JSON-RPC API. If you needs to support with your own JSON Based RPC Call, just a few lines of code needed!
More detail, please run the Example project in the repo.

Usage


Installation

DRDNetworking is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "DRDNetworking"

Run Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Quick Start

  • In your podfile, just add pod 'DRDNetworking, then pod update.
  • In your project file where you want to use DRDNetworking, add #import "DRDNetworking.h"
  • Write api code to run a networking call:
DRDGeneralAPI *apiGet       = [[DRDGeneralAPI alloc] init];
apiGet.baseUrl              = @"http://ele.me";
apiGet.apiRequestMethodType = DRDRequestMethodTypeGET;
[apiGet setApiCompletionHandler:^(id responseObject, NSError * error) {
    // Your handle code
}];
[apiGet start];

CodeDetail


DRDAPIManager

DRDAPIManager manages DRDBaseAPI object. You can send an API request or a batch of API requests. Furthermore, you can cancel an API request which you sent before.

DRDConfig

DRDConfig is a global class that help us to maintain the whole behaviors.

    DRDConfig *networkConfig   = [[DRDConfig alloc] init];
    networkConfig.baseUrlStr   = @"https://httpbin.org";
    networkConfig.userAgent    = @"For example User-Agent";

    [[DRDAPIManager sharedDRDAPIManager] setConfiguration:networkConfig];
DRDAPIBatchAPIRequests

If you need to send a batch of api simultaneously, use DRDAPIBatchAPIRequests

    DRDGeneralAPI *generalAPIGet = [[DRDGeneralAPI alloc] init];
    generalAPIGet.apiRequestMethodType = DRDRequestMethodTypeGET;
    generalAPIGet.baseUrl = self.baseURLStr;
    
    DRDGeneralAPI *generalAPIPost = [[DRDGeneralAPI alloc] init];
    generalAPIPost.apiRequestMethodType = DRDRequestMethodTypePOST;
    generalAPIPost.baseUrl = self.baseURLStr;
    
    DRDAPIBatchAPIRequests *batchRequests = [[DRDAPIBatchAPIRequests alloc] init];
    [batchRequests addAPIRequest:generalAPIGet];
    [batchRequests addAPIRequest:generalAPIPost];
    
    [[DRDAPIManager sharedDRDAPIManager] sendBatchAPIRequests:batchRequests];
DRDBaseAPI

DRDBaseAPI is base class of all API request object. You will customize your API request by subclass of it.

@implementation DRDAPIPostCall

#pragma mark - init
- (instancetype)init {
    self = [super init];
    if (self) {
        
    }
    return self;
}

#pragma mark - DRD
- (NSString *)customRequestUrl {
    return @"http://httpbin.org";
}

- (NSString *)requestMethod {
    return nil;
}

- (id)requestParameters {
    return nil;
}

- (DRDRequestMethodType)apiRequestMethodType {
    return DRDRequestMethodTypePOST;
}

- (id)apiResponseObjReformer:(id)responseObject andError:(NSError *)error {
    // refrom JSON response to your model object
    return responseObject;
}
DRDGeneralAPI

DRDGeneralAPI avoid subclass of DRDBaseAPI which will lead to class explosion. It provide you a convenient way to send API request.

    DRDGeneralAPI *apiGeGet            = [[DRDGeneralAPI alloc] initWithRequestMethod:@"get"];
    apiGeGet.apiRequestMethodType      = DRDRequestMethodTypeGET;
    apiGeGet.apiRequestSerializerType  = DRDRequestSerializerTypeHTTP;
    apiGeGet.apiResponseSerializerType = DRDResponseSerializerTypeHTTP;
    [apiGeGet setApiCompletionHandler:^(id responseObject, NSError * error) {
        NSLog(@"responseObject is %@", responseObject);
        if (error) {
            NSLog(@"Error is %@", error.localizedDescription);
        }
    }];
    [apiGeGet start];
DRDRPCProtocol

DRDRPCProtocol is the way that where you could implements your custome JSON Based RPC Protocol. We already implemented JSON-RPC protocol in the Example.
Review it, and write your own protocol.

    DRDGeneralAPI *plusAPI = [[DRDGeneralAPI alloc]init];
    plusAPI.baseUrl        = @"http://www.raboof.com/projects/jayrock/demo.ashx?test";
    plusAPI.requestMethod  = @"add";
    plusAPI.requestParameters = @{
                                  @"a" : @(a),
                                  @"b" : @(b)
                                  };
    plusAPI.rpcDelegate    = [DRDJsonRpcVersionTwo sharedJsonRpcVersionTwo];
    __weak typeof(self) weakSelf = self;
    [plusAPI setApiCompletionHandler:^(NSNumber * responseObject, NSError * error) {
        if (error) {
            [[[UIAlertView alloc] initWithTitle:@"Error"
                                       message:[NSString stringWithFormat:@"%@", error.localizedDescription]
                                      delegate:nil
                             cancelButtonTitle:@"OK"
                              otherButtonTitles:nil, nil]show];
        } else {
            weakSelf.labelResult.text = [NSString stringWithFormat:@"%@", responseObject];
        }
    }];
    [plusAPI start];

中文说明

简介

DRDNetworking提供了一个方便实现API调用的网络库。
目前,内部使用AFNetworking 3.0.0+来简化JSONXML等网络序列化工作。

它有以下优势:

  1. 独立的网络层分工,易用且不断改进的API设计
  2. 支持RESTFUL, JSON-RPC及自定义RPC等通讯协议扩展
  3. 支持HTTP /2(iOS 9.0+)
  4. HTTP 1.1下,TCP/IP 连接复用,优化网络连接
  5. 提供BaseAPI,减少ViewController层的代码量

安装

您可以使用CocoaPods来集成DRDNetworking.
在您的Podfile里添加以下代码即可集成DRDNetworking:

pod "DRDNetworking"

示例项目

我们提供了一个示例项目来帮助您更好地了解和使用DRDNetworkingclone下来代码,Scheme选择 DRDNetworking-Example即可运行。

快速开始

  • 在您的podfile中,添加pod "DRDNetworking",然后 pod update
  • 在您需要使用DRDNetworking的地方,添加#import "DRDNetworking.h"
  • 以下的代码能够快速帮您开启一个网络API调用:
DRDGeneralAPI *apiGet       = [[DRDGeneralAPI alloc] init];
apiGet.baseUrl              = @"http://ele.me";
apiGet.apiRequestMethodType = DRDRequestMethodTypeGET;
[apiGet setApiCompletionHandler:^(id responseObject, NSError * error) {
    // Your handle code
}];
[apiGet start];

更多用法,可以参考代码中.h文件。您是幸运的,目前所有文档都以中文撰写。

ChangeLog

v0.6.1

  • Add ReformerDelegate for GeneralAPI
  • Add networking error observer
  • Remove useless code
  • Add networking reachability detection
  • Add customization frequest send error str
  • Fix bugs

v0.5.2

  • RPC Delegate enables corresponding APIs.

v0.5.1

  • Create APIs in one queue

v0.5.0

  • Reuse one session for same base url requests to reuse TCP/IP connection
  • More convenience API design
  • More unit testing for code coverage

v0.4.0

  • Project Init

Author

cendywang, cendymails@gmail.com

Contributor

Alex Ao, aozhimin0811@gmail.com

License

DRDNetworking is available under the MIT license. See the LICENSE file for more info.

You can’t perform that action at this time.