DRDNetworking

KO | EN

gitlite — search

#javascript #typescript #llm #golang #android #machine-learning #deep-learning #macos #windows #cli #kubernetes #vue #openai #ios

(★ 308)

No description available.

DRDNetworking Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DRDNetworking
[![CI Status](http://img.shields.io/travis/Eleme-IMF/DRDNetworking.svg?style=flat)](https://travis-ci.org/Eleme-IMF/DRDNetworking)
[![codecov.io](https://codecov.io/github/Eleme-IMF/DRDNetworking/coverage.svg?branch=master)](https://codecov.io/github/Eleme-IMF/DRDNetworking?branch=master)
[![Version](https://img.shields.io/cocoapods/v/DRDNetworking.svg?style=flat)](http://cocoapods.org/pods/DRDNetworking)
[![License](https://img.shields.io/cocoapods/l/DRDNetworking.svg?style=flat)](http://cocoapods.org/pods/DRDNetworking)
[![Platform](https://img.shields.io/cocoapods/p/DRDNetworking.svg?style=flat)](http://cocoapods.org/pods/DRDNetworking)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

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](http://cocoapods.org). 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:

###### 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+`来简化`JSON`、`XML`等网络序列化工作。  
    
它有以下优势:

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

您可以使用[CocoaPods](http://cocoapods.org)来集成`DRDNetworking`.   
在您的`Podfile`里添加以下代码即可集成`DRDNetworking`:  
  
```
pod "DRDNetworking"
```

### 示例项目  
我们提供了一个示例项目来帮助您更好地了解和使用`DRDNetworking`。
`clone`下来代码，`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.

DRDNetworking

DRDNetworking Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

DRDNetworking

DRDNetworking Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README