Fast Android Networking Library

About Fast Android Networking Library

Fast Android Networking Library is a powerful library for doing any type of networking in Android applications which is made on top of OkHttp Networking Layer.

Fast Android Networking Library takes care of each and everything. So you don't have to do anything, just make request and listen for the response.

Why use Fast Android Networking ?

Recent removal of HttpClient in Android Marshmallow(Android M) made other networking library obsolete.
No other single library do each and everything like making request, downloading any type of file, uploading file, loading image from network in ImageView, etc. There are libraries but they are outdated.
No other library provided simple interface for doing all types of things in networking like setting priority, cancelling, etc.
As it uses Okio , No more GC overhead in android application. Okio is made to handle GC overhead while allocating memory. Okio do some clever things to save CPU and memory.
As it uses OkHttp , most important it supports HTTP/2.

RxJava2 Support, check here.

RxJava2 + Fast Android Networking + Dagger2 with MVP Architecture Project, Check here

Find this project useful ? ❤️

Support it by clicking the ⭐ button on the upper right of this page. ✌️

For full details, visit the documentation on our web site :

Requirements

Fast Android Networking Library can be included in any Android application.

Fast Android Networking Library supports Android 2.3 (Gingerbread) and later.

Using Fast Android Networking Library in your application

Add this in your build.gradle

compile 'com.amitshekhar.android:android-networking:0.4.0'

Do not forget to add internet permission in manifest if already not present

<uses-permissionandroid:name="android.permission.INTERNET" />

Then initialize it in onCreate() Method of application class :

AndroidNetworking.initialize(getApplicationContext());

Initializing it with some customization , as it uses OkHttp as networking layer, you can pass custom okHttpClient while initializing it.

// Adding an Network Interceptor for Debugging purpose :OkHttpClientokHttpClient = newOkHttpClient() .newBuilder()
.addNetworkInterceptor(newStethoInterceptor())
.build();
AndroidNetworking.initialize(getApplicationContext(),okHttpClient);

Using the Fast Android Networking with Jackson Parser

compile 'com.amitshekhar.android:jackson-android-networking:0.4.0'

// Then set the JacksonParserFactory like belowAndroidNetworking.setParserFactory(newJacksonParserFactory());

Making a GET Request

AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAllUsers/{pageNumber}")
.addPathParameter("pageNumber", "0")
.addQueryParameter("limit", "3")
.addHeaders("token", "1234")
.setTag("test")
.setPriority(Priority.LOW)
.build()
.getAsJSONArray(newJSONArrayRequestListener() {
@OverridepublicvoidonResponse(JSONArrayresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

Making a POST Request

AndroidNetworking.post("https://fierce-cove-29863.herokuapp.com/createAnUser")
.addBodyParameter("firstname", "Amit")
.addBodyParameter("lastname", "Shekhar")
.setTag("test")
.setPriority(Priority.MEDIUM)
.build()
.getAsJSONObject(newJSONObjectRequestListener() {
@OverridepublicvoidonResponse(JSONObjectresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

You can also post java object, json, file, etc in POST request like this.

Useruser = newUser();
user.firstname = "Amit";
user.lastname = "Shekhar";
AndroidNetworking.post("https://fierce-cove-29863.herokuapp.com/createUser")
.addBodyParameter(user) // posting java object
.setTag("test")
.setPriority(Priority.MEDIUM)
.build()
.getAsJSONArray(newJSONArrayRequestListener() {
@OverridepublicvoidonResponse(JSONArrayresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});
JSONObjectjsonObject = newJSONObject();
try {
jsonObject.put("firstname", "Amit");
jsonObject.put("lastname", "Shekhar");
} catch (JSONExceptione) {
e.printStackTrace();
}
AndroidNetworking.post("https://fierce-cove-29863.herokuapp.com/createUser")
.addJSONObjectBody(jsonObject) // posting json
.setTag("test")
.setPriority(Priority.MEDIUM)
.build()
.getAsJSONArray(newJSONArrayRequestListener() {
@OverridepublicvoidonResponse(JSONArrayresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});
AndroidNetworking.post("https://fierce-cove-29863.herokuapp.com/postFile")
.addFileBody(file) // posting any type of file
.setTag("test")
.setPriority(Priority.MEDIUM)
.build()
.getAsJSONObject(newJSONObjectRequestListener() {
@OverridepublicvoidonResponse(JSONObjectresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

Using it with your own JAVA Object - JSON Parser

/*--------------Example One -> Getting the userList----------------*/AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAllUsers/{pageNumber}")
.addPathParameter("pageNumber", "0")
.addQueryParameter("limit", "3")
.setTag(this)
.setPriority(Priority.LOW)
.build()
.getAsObjectList(User.class, newParsedRequestListener<List<User>>() {
@OverridepublicvoidonResponse(List<User> users) {
// do anything with responseLog.d(TAG, "userList size : " + users.size());
for (Useruser : users) {
Log.d(TAG, "id : " + user.id);
Log.d(TAG, "firstname : " + user.firstname);
Log.d(TAG, "lastname : " + user.lastname);
}
}
@OverridepublicvoidonError(ANErroranError) {
// handle error
}
});
/*--------------Example Two -> Getting an user----------------*/AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAnUserDetail/{userId}")
.addPathParameter("userId", "1")
.setTag(this)
.setPriority(Priority.LOW)
.build()
.getAsObject(User.class, newParsedRequestListener<User>() {
@OverridepublicvoidonResponse(Useruser) {
// do anything with responseLog.d(TAG, "id : " + user.id);
Log.d(TAG, "firstname : " + user.firstname);
Log.d(TAG, "lastname : " + user.lastname);
}
@OverridepublicvoidonError(ANErroranError) {
// handle error
}
}); /*-- Note : YourObject.class, getAsObject and getAsObjectList are important here --*/

Downloading a file from server

AndroidNetworking.download(url,dirPath,fileName)
.setTag("downloadTest")
.setPriority(Priority.MEDIUM)
.build()
.setDownloadProgressListener(newDownloadProgressListener() {
@OverridepublicvoidonProgress(longbytesDownloaded, longtotalBytes) {
// do anything with progress 
}
})
.startDownload(newDownloadListener() {
@OverridepublicvoidonDownloadComplete() {
// do anything after completion
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error 
}
});

Uploading a file to server

AndroidNetworking.upload(url)
.addMultipartFile("image",file) .addMultipartParameter("key","value")
.setTag("uploadTest")
.setPriority(Priority.HIGH)
.build()
.setUploadProgressListener(newUploadProgressListener() {
@OverridepublicvoidonProgress(longbytesUploaded, longtotalBytes) {
// do anything with progress 
}
})
.getAsJSONObject(newJSONObjectRequestListener() {
@OverridepublicvoidonResponse(JSONObjectresponse) {
// do anything with response 
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error 
}
});

Getting Response and completion in an another thread executor

(Note : Error and Progress will always be returned in main thread of application)

AndroidNetworking.upload(url)
.addMultipartFile("image",file) .addMultipartParameter("key","value") .setTag("uploadTest")
.setPriority(Priority.HIGH)
.build()
.setExecutor(Executors.newSingleThreadExecutor()) // setting an executor to get response or completion on that executor thread
.setUploadProgressListener(newUploadProgressListener() {
@OverridepublicvoidonProgress(longbytesUploaded, longtotalBytes) {
// do anything with progress 
}
})
.getAsJSONObject(newJSONObjectRequestListener() {
@OverridepublicvoidonResponse(JSONObjectresponse) {
// below code will be executed in the executor provided// do anything with response 
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error 
}
});

Setting a Percentage Threshold For Not Cancelling the request if it has completed the given threshold

AndroidNetworking.download(url,dirPath,fileName)
.setTag("downloadTest")
.setPriority(Priority.MEDIUM)
.setPercentageThresholdForCancelling(50) // even if at the time of cancelling it will not cancel if 50% 
.build() // downloading is done.But can be cancalled with forceCancel.
.setDownloadProgressListener(newDownloadProgressListener() {
@OverridepublicvoidonProgress(longbytesDownloaded, longtotalBytes) {
// do anything with progress 
}
})
.startDownload(newDownloadListener() {
@OverridepublicvoidonDownloadComplete() {
// do anything after completion
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error 
}
});

Cancelling a request.

Any request with a given tag can be cancelled. Just do like this.

AndroidNetworking.cancel("tag"); // All the requests with the given tag will be cancelled.AndroidNetworking.forceCancel("tag"); // All the requests with the given tag will be cancelled , even if any percent threshold is// set , it will be cancelled forcefully. AndroidNetworking.cancelAll(); // All the requests will be cancelled. AndroidNetworking.forceCancelAll(); // All the requests will be cancelled , even if any percent threshold is// set , it will be cancelled forcefully.

Loading image from network into ImageView

 <com.androidnetworking.widget.ANImageView
android:id="@+id/imageView"android:layout_width="100dp"android:layout_height="100dp"android:layout_gravity="center" />
imageView.setDefaultImageResId(R.drawable.default);
imageView.setErrorImageResId(R.drawable.error);
imageView.setImageUrl(imageUrl);

Getting Bitmap from url with some specified parameters

AndroidNetworking.get(imageUrl)
.setTag("imageRequestTag")
.setPriority(Priority.MEDIUM)
.setBitmapMaxHeight(100)
.setBitmapMaxWidth(100)
.setBitmapConfig(Bitmap.Config.ARGB_8888)
.build()
.getAsBitmap(newBitmapRequestListener() {
@OverridepublicvoidonResponse(Bitmapbitmap) {
// do anything with bitmap
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

Error Code Handling

publicvoidonError(ANErrorerror) {
if (error.getErrorCode() != 0) {
// received error from server// error.getErrorCode() - the error code from server// error.getErrorBody() - the error body from server// error.getErrorDetail() - just an error detailLog.d(TAG, "onError errorCode : " + error.getErrorCode());
Log.d(TAG, "onError errorBody : " + error.getErrorBody());
Log.d(TAG, "onError errorDetail : " + error.getErrorDetail());
// get parsed error object (If ApiError is your class)ApiErrorapiError = error.getErrorAsObject(ApiError.class);
} else {
// error.getErrorDetail() : connectionError, parseError, requestCancelledErrorLog.d(TAG, "onError errorDetail : " + error.getErrorDetail());
}
}

Remove Bitmap from cache or clear cache

AndroidNetworking.evictBitmap(key); // remove a bitmap with key from LruCacheAndroidNetworking.evictAllBitmap(); // clear LruCache

Prefetch a request (so that it can return from cache when required at instant)

AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAllUsers/{pageNumber}")
.addPathParameter("pageNumber", "0")
.addQueryParameter("limit", "30")
.setTag(this)
.setPriority(Priority.LOW)
.build()
.prefetch();

Customizing OkHttpClient for a particular request

OkHttpClientokHttpClient = newOkHttpClient().newBuilder()
.addInterceptor(newGzipRequestInterceptor())
.build();
AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAllUsers/{pageNumber}")
.addPathParameter("pageNumber", "0")
.addQueryParameter("limit", "3")
.addHeaders("token", "1234")
.setTag("test")
.setPriority(Priority.LOW)
.setOkHttpClient(okHttpClient) // passing a custom okHttpClient 
.build()
.getAsJSONArray(newJSONArrayRequestListener() {
@OverridepublicvoidonResponse(JSONArrayresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

Making a conditional request (Building a request)

ANRequest.GetRequestBuildergetRequestBuilder = newANRequest.GetRequestBuilder(ApiEndPoint.BASE_URL + ApiEndPoint.CHECK_FOR_HEADER);
if(isHeaderRequired){
getRequestBuilder.addHeaders("token", "1234");
}
if(executorRequired){
getRequestBuilder.setExecutor(Executors.newSingleThreadExecutor());
}
ANRequestanRequest = getRequestBuilder.build(); anRequest.getAsJSONObject(newJSONObjectRequestListener() {
@OverridepublicvoidonResponse(JSONObjectresponse) {
// do anything with response
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error
}
});

ConnectionClass Listener to get current network quality and bandwidth

// Adding ListenerAndroidNetworking.setConnectionQualityChangeListener(newConnectionQualityChangeListener() {
@OverridepublicvoidonChange(ConnectionQualitycurrentConnectionQuality, intcurrentBandwidth) {
// do something on change in connectionQuality
}
});
// Removing Listener AndroidNetworking.removeConnectionQualityChangeListener();
// Getting current ConnectionQualityConnectionQualityconnectionQuality = AndroidNetworking.getCurrentConnectionQuality();
if(connectionQuality == ConnectionQuality.EXCELLENT) {
// do something
} elseif (connectionQuality == ConnectionQuality.POOR) {
// do something
} elseif (connectionQuality == ConnectionQuality.UNKNOWN) {
// do something
}
// Getting current bandwidthintcurrentBandwidth = AndroidNetworking.getCurrentBandwidth(); // Note : if (currentBandwidth == 0) : means UNKNOWN

Getting Analytics of a request by setting AnalyticsListener on that

AndroidNetworking.download(url,dirPath,fileName)
.setTag("downloadTest")
.setPriority(Priority.MEDIUM)
.build()
.setAnalyticsListener(newAnalyticsListener() {
@OverridepublicvoidonReceived(longtimeTakenInMillis, longbytesSent, longbytesReceived, booleanisFromCache) {
Log.d(TAG, " timeTakenInMillis : " + timeTakenInMillis);
Log.d(TAG, " bytesSent : " + bytesSent);
Log.d(TAG, " bytesReceived : " + bytesReceived);
Log.d(TAG, " isFromCache : " + isFromCache);
}
})
.setDownloadProgressListener(newDownloadProgressListener() {
@OverridepublicvoidonProgress(longbytesDownloaded, longtotalBytes) {
// do anything with progress 
}
})
.startDownload(newDownloadListener() {
@OverridepublicvoidonDownloadComplete() {
// do anything after completion
}
@OverridepublicvoidonError(ANErrorerror) {
// handle error 
}
}); Note : IfbytesSentorbytesReceivedis -1 , itmeansitisunknown

Getting OkHttpResponse in Response

AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAnUserDetail/{userId}")
.addPathParameter("userId", "1")
.setTag(this)
.setPriority(Priority.LOW)
.setUserAgent("getAnUser")
.build()
.getAsOkHttpResponseAndParsed(newTypeToken<User>() {
}, newOkHttpResponseAndParsedRequestListener<User>() {
@OverridepublicvoidonResponse(ResponseokHttpResponse, Useruser) {
// do anything with okHttpResponse and user
}
@OverridepublicvoidonError(ANErroranError) {
// handle error
}
});

Making Synchronous Request

ANRequestrequest = AndroidNetworking.get("https://fierce-cove-29863.herokuapp.com/getAllUsers/{pageNumber}")
.addPathParameter("pageNumber", "0")
.addQueryParameter("limit", "3")
.build();
ANResponse<List<User>> response = request.executeForParsed(newTypeToken<List<User>>() {});
if (response.isSuccess()) {
List<User> users = responseTwo.getResult();
} else {
//handle error
}

How caching works ?

First of all the server must send cache-control in header so that is starts working.
Response will be cached on the basis of cache-control max-age,max-stale.
If internet is connected and the age is NOT expired it will return from cache.
If internet is connected and the age is expired and if server returns 304(NOT MODIFIED) it will return from cache.
If internet is NOT connected if you are using getResponseOnlyIfCached() - it will return from cache even it date is expired.
If internet is NOT connected , if you are NOT using getResponseOnlyIfCached() - it will NOT return anything.
If you are using getResponseOnlyFromNetwork() , it will only return response after validation from server.
If cache-control is set, it will work according to the max-age,max-stale returned from server.
If internet is NOT connected only way to get cache Response is by using getResponseOnlyIfCached().

Enabling Logging

AndroidNetworking.enableLogging(); // simply enable loggingAndroidNetworking.enableLogging(LEVEL.HEADERS); // enabling logging with level

Enabling GZIP From Client to Server

// Enabling GZIP for Request (Not needed if your server doesn't support GZIP Compression), anyway responses // from server are automatically unGzipped if required. So enable it only if you need your request to be // Gzipped before sending to server(Make sure your server support GZIP Compression).OkHttpClientokHttpClient = newOkHttpClient().newBuilder()
.addInterceptor(newGzipRequestInterceptor())
.build();
AndroidNetworking.initialize(getApplicationContext(),okHttpClient);

IMPORTANT NOTE

Use IMMEDIATE Priority with caution - use is at appropriate place only when 1 or 2 (at max 2)IMMEDIATE request is required at instant.Otherwise use HIGH Priority.
Known Bug : As present if you are using GZIP Interceptor from client to server, Upload progress is not working perfectly in Multipart.
If you are using Proguard with Gradle build system (which is usually the case), you don't have to do anything. The appropriate Proguard rules will be automatically applied. If you still need the rules applied in proguard-rules.pro, it is as follows:
```
-dontwarn okio.**
```