Interrux is an Android Library which provides a comprehensive collection of interceptors designed to enhance the functionality of Android applications. It offers a wide range of interceptors that seamlessly integrate into Android projects to intercept and modify network requests and responses. These interceptors empower developers to implement essential features like authentication, logging, caching, error handling, and more, in a modular and reusable manner.
- Modularity: The library offers a set of independent interceptors, allowing developers to selectively choose and combine the interceptors that suit their specific requirements. Each interceptor can be used individually or in combination with other interceptors as per the desired functionality.
- Ease of Integration: The interceptors are designed to integrate seamlessly with popular HTTP client libraries used in Android, such as OkHttp or Retrofit. Developers can easily add the interceptors to their existing network stacks without major modifications.
- Customizability: The interceptors provide configurable options, allowing developers to customize their behavior based on application-specific needs. Parameters such as cache durations, error handling strategies, and authentication mechanisms can be tailored according to the requirements of the application.
- Error Handling: The interceptors can include error handling mechanisms to capture and process network errors in a structured way.
Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}Add the dependency:
dependencies {
implementation 'com.github.GDGVIT:interrux:v1.0.1-alpha'
}To start using Interrux, just plug in an interceptor to your OkHttp Client Builder:
val client = OkHttpClient.Builder()
.addInterceptor(/*Any of the Included Interceptors here*/)
.addInterceptor(/*Another Interceptor*/)
.build()An interceptor for handling authentication by adding authentication headers to outgoing requests. It intercepts network requests and adds an authorization header to the request using an authentication token, and also provides an optional token refresh functionality.
The AuthInterceptor class accepts the following parameters:
-
context : Context(required): An instance of the Context class representing the Android application context. It is used to access shared preferences and other application-specific resources. -
refreshAuthToken : ((String?) -> String)?(optional): The class also provides an additional constructor that allows passing a refreshAuthToken lambda function for token refreshing. The parameter string provides the function with the refresh token saved using saveTokens() function.
fun saveTokens(accessToken: String, refreshToken: String)accessToken: String: A string representing the access token to be saved. This token is used for authentication and authorization purposes.refreshToken: String: A string representing the refresh token to be saved. This token is used to obtain a new access token when the current one expires.
The method will save these tokens in the shared preferences, allowing us to retrieve and use them later for authentication and token refreshing purposes.
// Create an instance of AuthInterceptor with context
val authInterceptor = AuthInterceptor(applicationContext)
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(myAuthInterceptor)
.build()// Create an instance of AuthInterceptor with context and custom lambda function
val refreshAuthToken : (String?) -> String = {
refreshToken ->
// Refresh the access token using the provided refresh token
// Implement your own logic for refreshing the token
// Return the new access token
}
val myAuthInterceptor = AuthInterceptor(applicationContext, refreshAuthToken)
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(myAuthInterceptor)
.build()
//Save tokens when received
val accessToken = "sample_access_token"
val refreshToken = "sample_refresh_token"
myAuthInterceptor.saveTokens(accessToken, refreshToken)The LoggingInterceptor class is an interceptor for logging network requests and responses. It captures and logs information about the request URL, method, and headers as well as the response code, and headers.
// Create an instance of LoggingInterceptor
val loggingInterceptor = LoggingInterceptor()
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(loggingInterceptor)
.build()NOTE: Please note that the LoggingInterceptor relies on the HttpLoggingInterceptor from the OkHttp library for logging functionality.
The CacheInterceptor class is an interceptor that provides caching functionality for network requests. It allows you to control the caching behavior of responses by adding the appropriate Cache-Control header to the outgoing requests.
The CacheInterceptor class accepts the following parameters:
days(optional): An integer representing the number of days for which the response should be cached. It defaults to1day.
// Create an instance of CacheInterceptor with the desired caching duration
val cachingDays = 2
val cacheInterceptor = CacheInterceptor(cachingDays)
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(cacheInterceptor)
.build()The ErrorInterceptor class is an interceptor that handles common HTTP error responses and provides error logging functionality. It intercepts network requests and their corresponding responses, checks the response code, and logs and handles the appropriate error based on the code.
The ErrorInterceptor class accepts the following parameter:
errorHandler(optional): An implementation of theErrorHandlerinterface. This handler is responsible for handling the errors and providing a custom error response. If not provided, the errors will only be logged using Android'sLogclass.
// Create an implementation of the ErrorHandler interface and define the onError function
override fun onError(errorCode: Int, errorMessage: String) {
// Handle the error based on the error code and message
}
// Create an instance of ErrorInterceptor
val errorInterceptor = ErrorInterceptor(/*Pass the interface*/)
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(errorInterceptor)
.build()The RequestInterceptor class is an interceptor which allows modification of HTTP requests and their corresponding responses. It is used to add a custom header to outgoing requests.
The RequestInterceptor class accepts the following parameters:
headerName: The name of the header to be added to the request.headerValue: The value of the header to be added to the request.
// Create an instance of RequestInterceptor
val requestInterceptor = RequestInterceptor("CustomHeader", "CustomValue")
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(requestInterceptor)
.build()The ResponseInterceptor class is an interceptor which allows modification of HTTP responses. It is used to add a custom header to the response.
The ResponseInterceptor class accepts the following parameters:
headerName: The name of the header to be added to the response.headerValue: The value of the header to be added to the response.
// Create an instance of ResponseInterceptor
val responseInterceptor = ResponseInterceptor("CustomHeader", "CustomValue")
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(responseInterceptor)
.build()The RequestResponseInterceptor class is an interface which allows modification of both HTTP requests and responses. It is used to add custom headers to both outgoing requests and incoming responses.
The RequestResponseInterceptor class accepts the following parameters:
requestHeaderName: The name of the header to be added to the request.requestHeaderValue: The value of the header to be added to the request.responseHeaderName: The name of the header to be added to the response.responseHeaderValue: The value of the header to be added to the response.
// Create an instance of RequestResponseInterceptor
val requestResponseInterceptor = RequestResponseInterceptor(
"RequestHeader", "RequestValue",
"ResponseHeader", "ResponseValue"
)
// Add the interceptor to your OkHttp client
val client = OkHttpClient.Builder()
.addInterceptor(requestResponseInterceptor)
.build()
|
Rudrank Basant
|
Made with ❤ by GDSC-VIT