/networking

A flutter http management library.

Primary LanguageDartOtherNOASSERTION

networking

support

Http client for Dart also Flutter. Networking supports Serilazation, Global Configuration, Learning, Timeout etc.

Get started

Add dependency

pubspec.yaml

  networking:
    git:
      url: https://github.com/oneframemobile/networking.git
      ref: 3.0.0

Requirement

  1. We define global configiration class.
  2. If you have complex scenario, you can define Learning class.
  3. And finally define model class but you dont't forget model class must be extends Serialable Object or List

Index

  • Introduction
  • Parse
  • Requesting
  • GET
  • POST
  • PUT
  • DELETE
  • Properties
  • Advanced
  • Network Exception Types
  • Learning
  • Manager
  • Configuration
  • URL
  • Connection Timeout
  • Success Codes
  • Headers
  • SSL Pinning
  • Log Enable

Introduction

Framework supports a networking component that works with a variety of networking providers. This article shows how to use Framework networking component API in your code.

Parse

Each request or response body can implement SerializationObject or SerializationList. So that it can be mappable from JSON to Model or vice versa. Or only can be single data exp. bool, string, double.

class MyResponse implements SerializableObject<MyResponse> {
String username;

MyResponse.fromJsonMap(Map<String, dynamic> map) : username = map["username"];

Map<String, dynamic> toJson() {
final Map<String, dynamic> data = new Map<String, dynamic>();
data['username'] = username;
return data;
}

@override
MyResponse fromJson(Map<String, dynamic> json) {
return MyResponse.fromJsonMap(json);
}
}

class MyResponseList implements SerializableList<MyResponse> {
@override
List<MyResponse> list;

@override
List<MyResponse> fromJsonList(List json) {
return json.map((fields) => MyResponse.fromJsonMap(fields)).toList();
}

@override
List<Map<String, dynamic>> toJsonList() {
throw new UnsupportedError("Not needed");
}
}

Requesting

These requests need no configuration. Designed for quick usage.

GET

Result type is ResultModel as default.

NetworkManager manager = NetworkingFactory.create();
    manager
        .get<UserInfoResponse, ErrorResponse>(url: "/user/getUserInfo", type: UserInfoResponse(), errorType: ErrorResponse(), listener: listener)
        .addHeader(BaseApiHelper.getInstance().tokenHeader)
        .fetch();

POST

Parsing given model to concrete object. Also error model must be defined. Aware of called function which is named post.

NetworkManager manager = NetworkingFactory.create();
    manager
        .post<RegisterRequest, RegisterResponse, ErrorResponse>(
            url: "/accounts/register", type: RegisterResponse(), body: registerRequest, errorType: ErrorResponse(), listener: listener)
        .fetch();

PUT

NetworkManager manager = NetworkingFactory.create();
    manager
        .put<ChangePasswordRequest, DefaultResponse, ErrorResponse>(
            url: "/accounts/changePassword", errorType: ErrorResponse(), type: DefaultResponse(), body: changePasswordRequest, listener: listener)
        .addHeader(Header("Authorization", "Bearer token")
        .fetch();

DELETE

NetworkManager manager = NetworkingFactory.create();
    manager
        .delete<DefaultResponse, ErrorResponse>(url: "/accounts/" + userMail, errorType: ErrorResponse(), type: DefaultResponse(), listener: listener)
        .addHeader(Header("Authorization", "Bearer token")
        .fetch();

Properties

You are able to customize each request with chain methods.

    _manager
        .post<RegisterRequest, RegisterResponse, ErrorResponse>(
            url: "/accounts/register", type: RegisterResponse(), body: registerRequest, errorType: ErrorResponse(), listener: listener)
        .addHeader(BaseApiHelper.getInstance().tokenHeader)
        .isList(true)
        .parseKeys(["result","applicatonError"])
        .query("userId", "10")
        .path("register")
        .timeout(new Duration(mins : 1))
        .fetch();

Advanced

Advanced implementation lets you to change behavior. By implementing learning module you can define success and error cases, or you can customize custom error codes like 400~500. Manager class will be declared which effects url, header and timeout values in all the other requests.

Network Exception Types

NO_CONNECTION_ERROR, TIMEOUT_ERROR, AUTH_FAILURE_ERROR, SERVER_ERROR, NETWORK_ERROR, PARSE_ERROR, CLIENT_ERROR, SOCKET_ERROR were added. When you get error about them, it will trigger error listener.

Learning

Following example demonstrates scenario likewise isSucceed is true. Custom error codes are added for fail cases. CheckCustomError function will be called whenever HTTP error codes comes like 400, 401 and etc.

Learning

class MyLearning extends NetworkLearning {
@override
void checkCustomError(NetworkListener listener, ErrorModel error) {
// TODO: implement checkCustomError
    try {
      error.data = error.data.error;
      return sendError(listener, error);
    } catch (e) {
      return sendError(listener, error);
    }
}

@override
void checkSuccess(NetworkListener listener, ResultModel result) {
    try {
          var data = result.data as dynamic;
          bool isDataList;
          try{
            isDataList = data.list is List;
          }
          catch(e){
            isDataList = false;
          }
          if (isDataList || data.errorMessage == null) {
            return sendSuccess(listener, result as dynamic);
          } else {
            ErrorModel<String> error = new ErrorModel();
            error.description = "Error";
            return sendError(listener, error);
          }
        } on NoSuchMethodError catch (e) {
          ErrorModel<StackTrace> error = new ErrorModel();
          error.data = e.stackTrace;
          return sendError(listener, error);
        }
    }
}

Then you can use manager instance for following operations.

MyLearning _learning = new Learning();
NetworkManager manager = NetworkingFactory.create(learning: _learning);

Configuration

Config class is kind of parameters class for managers.

NetworkConfig _config = new NetworkConfig();
config.setBaseUrl("www.google.com");
NetworkManager manager = NetworkingFactory.create(config: _config);

This one shows how to add base URL.

Connection Timeout

Connection timeouts are critical for slow network cases. Make sure implement them.

NetworkConfig _config = new NetworkConfig();
config.setTimeout(60000);
NetworkManager manager = NetworkingFactory.create(config: _config);

Success Codes

You can specify the Success Code range and easily manage the returned status code.

NetworkConfig _config = new NetworkConfig();
_config.addSuccessCodes(200, 205);
NetworkManager manager = NetworkingFactory.create(config: _config);
// * If the reply returned from http is within the range you specify by _config.addSuccessCodes, it will fall to onsuccess in the Learning class, to onError if it is not within the range you specify.

Headers

You can set default headers for every request that created from manager with given config.

NetworkConfig _config = new NetworkConfig();
_config
.addHeader(new Header("hello", "wold"))
.addHeader(new Header("its a new", "world"));

_config.addHeaders([
Header("CompanyId", "1"),
Header("UserId", "2"),
]);

_config
.addHeaderWithParameters("Nice", "Easy")
.addHeaderWithParameters("John", "Doe");

NetworkManager manager = NetworkingFactory.create(config: _config);

Cancel

You can cancel ongoing request by calling GenericRequestObject<dynamic>.cancel() function

NetworkManager manager = NetworkingFactory.create();
    var request = manager
        .delete<DefaultResponse, ErrorResponse>(url: "/accounts/" + userMail, errorType: ErrorResponse(), type: DefaultResponse(), listener: listener)
        .addHeader(Header("Authorization", "Bearer token");
        
    request.fetch();
    request.cancel();

You can also cancel ongoing request by tagging NetworkCancellation.getInstance().cancel(tag: "MyTag"") function

_manager.post<CampaignRequestModel, CampaignResponseModel, ErrorResponse>(
        url: "Campaign/GetCampaigns",
        type: CampaignResponseModel(),
        errorType: ErrorResponse(),
        body: campaignRequestModel,
        isList: false,
        tag: "Hello",
        listener: NetworkListener<CampaignResponseModel, ErrorResponse>());
        
NetworkCancellation
    .getInstance()
    .cancel(tag: "Hello");

Or just cancel all.

NetworkCancellation
    .getInstance()
    .cancelAll();

SSL Pinning

You can use certificates which has .cer extension. Make sure put your .cer file in assets resource folder.

SecurityContext _context = new SecurityContext();
context.setTrustedCertificates(file);
HttpClient _client = new HttpClient(context: _context);

NetworkManager manager = NetworkingFactory.create(client: _client);

Log Enable

if release, profile mode -> hide logs
else
  config.setEnableLog(true); // true show log-> false hide log

NetworkConfig _config = new NetworkConfig();
config.setEnableLog(true); // true show log-> false hide log
NetworkManager manager = NetworkingFactory.create(config: _config);