https://github.com/neopixl/Spitfire
Android JSON networking library
https://github.com/neopixl/Spitfire
android android-library jackson jackson-json-processor network networking volley-library wrapper
Last synced: 7 months ago
JSON representation
Android JSON networking library
- Host: GitHub
- URL: https://github.com/neopixl/Spitfire
- Owner: neopixl
- License: apache-2.0
- Created: 2017-10-06T11:08:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-28T15:21:14.000Z (over 6 years ago)
- Last Synced: 2024-10-31T15:38:31.502Z (12 months ago)
- Topics: android, android-library, jackson, jackson-json-processor, network, networking, volley-library, wrapper
- Language: Java
- Size: 858 KB
- Stars: 12
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android - Spitfire - Android JSON networking library. (Uncategorized / Uncategorized)
README
[](http://twitter.com/neopixl)
[](https://neopixl.com)
[](https://android-arsenal.com/details/1/6290)
[](https://travis-ci.org/neopixl/Spitfire)
[](https://coveralls.io/github/neopixl/Spitfire?branch=master)
[]()
[](https://android-arsenal.com/api?level=8)
# Spitfire by @Neopixl
A simple Android Network library. This library can be used as a wrapper for Google Volley, FasterXML Jackson serializer.
All the Volley and Jackson method are fully operational.
All the documentations are available here :
- Volley : [https://developer.android.com/training/volley/index.html](https://developer.android.com/training/volley/index.html)
- Jackson : [https://github.com/FasterXML/jackson](https://github.com/FasterXML/jackson)
Contribution : [CONTRIBUTING.md](CONTRIBUTING.md)
## Usage
This library was designed to be as simple to use as possible. Here are the steps you'll need to follow:
* Include the maven dependencies for this library as well as it's dependencies build.gradle file. (Note: Event bus is required only if you use it.)
dependencies {
implementation 'com.neopixl:spitfire:2.0.0'
}
* Create the DTO that you would like your request to be parsed as.
public class DummyResponse {
private String message;
private int id;
private List childrens;
// TODO : Added getters and setters
}
* Create a new Volley RequestQueue, where all requests will be processed.
RequestQueue requestQueue = Volley.newRequestQueue(this);
* Add a new BaseRequest to your RequestQueue. This will kick off the process of accessing the network resource and parsing the response into your DTO.
BaseRequest request = new BaseRequest.Builder(Request.Method.GET,
"YOUR URL", DummyResponse.class).listener(new RequestListener() {
@Override
public void onSuccess(Request request, NetworkResponse response, DummyResponse result) {
Log.d("YOUR APP", "Dummy success");
}
@Override
public void onFailure(Request request, NetworkResponse response, VolleyError volleyError) {
Log.d("YOUR APP", "Dummy error");
}
}).build();
requestQueue.add(request);
* That's it!
## More Complex Usage
### Get / Post / Put
To launch a Get, Post, Put request simply use the BaseRequest as before.
All the parameters will be added to the URL for the GET requests and to the body for the others
### Json Body
If you want to send a full JSON in the body of your request, simply create a new DTO, for example our "DummyResponse"
DummyResponse objectToSerializeAndSend = new DummyResponse();
objectToSerializeAndSend.setMessage("My message");
BaseRequest request = new BaseRequest.Builder(Request.Method.GET, "YOUR URL", DummyResponse.class)
.json(objectToSerializeAndSend)
.listener(new RequestListener() {
@Override
public void onSuccess(Request request, NetworkResponse response, DummyResponse dummyResponse) {
Log.d("YOUR APP", "Dummy success");
}
@Override
public void onFailure(Request request, NetworkResponse response, VolleyError volleyError) {
Log.d("YOUR APP", "Dummy error");
}
}).build();
requestQueue.add(request);
### MultipartData
HashMap multipardData = new HashMap<>();
RequestData data = new RequestData("image1", new byte[] {1,1,1,1,0,0,1}, "image/jpeg");
multipardData.put("image1", data);
data = new RequestData("image1", new byte[] {1,1,1,1,0,0,1}, "image/jpeg");
multipardData.put("image1", data);
MultipartRequest multipartRequest = new MultipartRequest.Builder(Request.Method.PUT, "YOUR URL", Void.class)
.listener(new RequestListener() {
@Override
public void onSuccess(Request request, NetworkResponse response, Void v) {
Log.d("YOUR APP", "Dummy success");
}
@Override
public void onFailure(Request request, NetworkResponse response, VolleyError volleyError) {
Log.d("YOUR APP", "Dummy error");
}
})
.multiPartData(multipardData)
.build();
requestQueue.add(multipartRequest);
### Unique File Upload
UploadFileRequest uploadFileRequest = new UploadFileRequest.Builder(Request.Method.PUT, "YOUR URL", String[].class)
.listener(new RequestListener() {
@Override
public void onSuccess(Request request, NetworkResponse response, String[] v) {
Log.d("YOUR APP", "Dummy sucess");
}
@Override
public void onFailure(Request request, NetworkResponse response, VolleyError volleyError) {
Log.d("YOUR APP", "Dummy error");
}
})
.partData(data)
.build();
requestQueue.add(uploadFileRequest);
### SpitfireManager
SpitfireManager is a global class used to set settings for all the requests.
You can change :
* default request timeout
//Change the default timeout for the default retry policy used for all requests.
SpitfireManager.setRequestTimeout(10000);
* default retry policy
DefaultRetryPolicy retryPolicy = new DefaultRetryPolicy(
10000, // 10 seconds
DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
DefaultRetryPolicy.DEFAULT_BACKOFF_MULT);
//Change the default retry policy used for all requests.
SpitfireManager.setDefaultRetryPolicy(retryPolicy);
# Proguard
# Jackson 2.x
-keep class com.fasterxml.jackson.databind.ObjectMapper {
public ;
protected ;
}
-keep class com.fasterxml.jackson.databind.ObjectWriter {
public ** writeValueAsString(**);
}
-keep @com.fasterxml.jackson.annotation.JsonIgnoreProperties class * { *; }
-keep class com.fasterxml.** { *; }
-keep class org.codehaus.** { *; }
-keepnames class com.fasterxml.jackson.** { *; }
-keepclassmembers public final enum com.fasterxml.jackson.annotation.JsonAutoDetect$Visibility {
public static final com.fasterxml.jackson.annotation.JsonAutoDetect$Visibility *;
}
-keep class com.fasterxml.jackson.databind.ObjectMapper {
public ;
protected ;
}
-keep class com.fasterxml.jackson.databind.ObjectWriter {
public ** writeValueAsString(**);
}
-keepnames class com.fasterxml.jackson.** { *; }
-dontwarn com.fasterxml.jackson.databind.**
# They use it
- Cerbaliance
# License
Spitfire is released under the Apache 2.0 licence. See LICENSE for details.