Retrofit2 turns your REST API into a Java interface.
Inspired by retrofit, compile-time version. (Implemented almost retrofit features. Bonus: @RetryHeaders, Global Headers)
@Retrofit("https://api.github.com")
public abstract class GitHub {
@GET("/users/{user}/repos")
public abstract Observable<Repo> repos(@Path("user") String user);
public static GitHub create() {
return new Retrofit_GitHub();
}
}GitHub github = GitHub.create();Each call on the generated instance of GitHub makes an HTTP request to the remote webserver.
github.repos("octocat").forEach(System.out::println);Use annotations to describe the HTTP request:
- URL parameter replacement and query parameter support
- Object conversion to request body (e.g., JSON, protocol buffers)
- Multipart request body and file upload
Annotations on the interface methods and its parameters indicate how a request will be handled.
Every method must have an HTTP annotation that provides the request method and relative URL. There are five built-in annotations: GET, POST, PUT, DELETE, and HEAD. The relative URL of the resource is specified in the annotation.
@GET("/users/list")You can also specify query parameters in the URL.
@GET("/users/list?sort=desc")A request URL can be updated dynamically using replacement blocks and parameters on the method. A replacement block is an alphanumeric string surrounded by { and }. A corresponding parameter must be annotated with @Path using the same string.
@GET("/group/{id}/users")
abstract Observable<List<User>> groupList(@Path("id") int groupId);Query parameters can also be added.
@GET("/group/{id}/users")
abstract Observable<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);For complex query parameter combinations a Map can be used.
@GET("/group/{id}/users")
abstract Observable<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);An object can be specified for use as an HTTP request body with the @Body annotation.
@POST("/users/new")
abstract Observable<User> createUser(@Body User user> cb);The object will also be converted using the converter.
Methods can also be declared to send form-encoded and multipart data.
Form-encoded data is sent when @FormUrlEncoded is present on the method. Each key-value pair is annotated with @Field containing the name and the object providing the value.
@FormUrlEncoded
@POST("/user/edit")
abstract Observable<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);Multipart requests are used when @Multipart is present on the method. Parts are declared using the @Part annotation.
@Multipart
@PUT("/user/photo")
abstract Observable<User> updateUser(@Part("photo") TypedFile photo, @Part("description") TypedString description);Multipart parts use the converter. In progress: or they can implement TypedOutput to handle their own serialization.
You can set static headers for a method using the @Headers annotation.
@Headers("Cache-Control: max-age=640000")
@GET("/widget/list")
abstract Observable<List<Widget>> widgetList();@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit2"
})
@GET("/users/{username}")
abstract Observable<User> getUser(@Path("username") String username);Note that headers do not overwrite each other. All headers with the same name will be included in the request.
A request Header can be updated dynamically using the @Header annotation. A corresponding parameter must be provided to the @Header. If the value is null, the header will be omitted. Otherwise, toString will be called on the value, and the result used.
@GET("/user")
Observable<User> getUser(@Header("Authorization") String authorization);Headers that need to be added to every request can be specified using @Headers on your service. The following code uses @Headers that will add a User-Agent header to every request.
@Retrofit("https://api.github.com")
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit2"
})
abstract class GitHub {
// ..
}Methods can be declared for either synchronous or asynchronous execution.
A method with a return type will be executed synchronously.
@GET("/user/{id}/photo")
Photo getUserPhoto(@Path("id") int id);Asynchronous execution requires the last parameter of the method be a Callback.
@GET("/user/{id}/photo")
void getUserPhoto(@Path("id") int id, Callback<Photo> cb);On Android, callbacks will be executed on the main thread. For desktop applications callbacks will happen on the same thread that executed the HTTP request.
Retrofit also integrates RxJava to support methods with a return type of rx.Observable
@GET("/user/{id}/photo")
Observable<Photo> getUserPhoto(@Path("id") int id);Observable requests are subscribed asynchronously and observed on the same thread that executed the HTTP request. To observe on a different thread (e.g. Android's main thread) call observeOn(Scheduler) on the returned Observable.
HTTP responses are automatically converted to a specified type using the RestAdapter's converter which defaults to JSON. The desired type is declared as the method return type or using the Callback or Observable.
@GET("/users/list")
List<User> userList();@GET("/users/list")
void userList(Callback<List<User>> cb);@GET("/users/list")
Observable<List<User>> userList();For access to the raw HTTP response use the Response type.
@GET("/users/list")
Response userList();@GET("/users/list")
void userList(Callback<Response> cb);@GET("/users/list")
Observable<Response> userList();Retrofit\_TARGET is the class through which your API interfaces are turned into callable objects. By default, Retrofit2 will give you sane defaults for your platform but it allows for customization.
Retrofit2 uses LoganSquare by default to convert HTTP bodies to and from JSON. If you want to specify behavior that is different from Gson's defaults (e.g. naming policies, date formats, custom types), provide a new Gson instance with your desired behavior when building a Retrofit_TARGET. Refer to the Gson documentation for more details on customization.
The following code creates a new Gson instance that will convert all fields from lower case with underscores to camel case and vice versa. It also registers a type adapter for the Date class. This DateTypeAdapter will be used anytime Gson encounters a Date field.
The gson instance is passed as a parameter to GsonConverter, which is a wrapper class for converting types.
public static GitHub create() {
Gson gson = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
.registerTypeAdapter(Date.class, new DateTypeAdapter())
.create();
return new Retrofit_GitHub(new GsonConverter(gson));
}Each call on the generated GitHub will return objects converted using the Gson implementation provided to the Retrofit_GitHub.
In addition to JSON, Retrofit can be configured to use other content formats. Retrofit provides alternate converters for XML (using Simple) and Protocol Buffers (using protobuf or Wire). Please see the retrofit-converters directory for the full listing of converters.
The following code shows how to use SimpleXMLConverter to communicate with an API that uses XML
@Retrofit("https://api.github.com")
class GitHub {
// ..
public static GitHub create() {
return new Retrofit_GitHub(new SimpleXMLConverter());
}
}
GitHub github = GitHub.create();If you need to communicate with an API that uses a content-format that Retrofit does not support out of the box (e.g. YAML, txt, custom format) or you wish to use a different library to implement an existing format, you can easily create your own converter. Create a class that implements the Converter interface and pass in an instance when building your adapter.
If you need custom error handling for requests, you may provide your own ErrorHandler. The following code shows how to throw a custom exception when a response returns a HTTP 401 status code
@Retrofit("https://api.github.com")
@ErrorHandler(MyErrorHandler.class)
class GitHub {
// ..
}Note that if the return exception is checked, it must be declared on the interface method. It is recommended that you pass the supplied RetrofitError as the cause to any new exceptions you throw.
If you need to take a closer look at the requests and responses you can easily add logging levels to the Retrofit_GitHub with the LogLevel property. The possible logging levels are BASIC, FULL, HEADERS, and NONE.
The following code shows the addition of a full log level which will log the headers, body, and metadata for both requests and responses.
@Retrofit("https://api.github.com")
@LogLevel(Retrofit.LogLevel.FULL)
class GitHub {
// ..
}For Retry Stale example:
@Retrofit("https://api.github.com")
@RetryHeaders(
value = "Cache-Control: max-age=640000",
exceptions = retrofit2.RequestException.class
)
public abstract class GitHub {
// ..
}Retry the request with cache if RequestException thats network issue.
repositories {
jcenter()
mavne { url "https://jitpack.io" }
}
dependencies {
compile 'com.github.yongjhih.retrofit2:retrofit2:-SNAPSHOT'
apt 'com.github.yongjhih.retrofit2:retrofit2-processor:-SNAPSHOT'
}- Support POST, DELTE, PUT: http://www.twitch.tv/yoandrew/v/7918907
- http://square.github.io/retrofit/
- https://github.com/square/okhttp/wiki/Recipes
- http://square.github.io/okhttp/javadoc/com/squareup/okhttp/RequestBody.html
Copyright 2015 8tory, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.