РЕДАКТИРОВАТЬ 2 (октябрь 2017):
Это 2017 год. Просто используйте Retrofit. Почти нет причин использовать что-либо еще.
EDIT:
Первоначальный ответ на момент этого редактирования был старше полутора лет. Хотя концепции, представленные в первоначальном ответе, остаются в силе, как указывают другие ответы, в настоящее время существуют библиотеки, которые облегчают эту задачу для вас. Что еще более важно, некоторые из этих библиотек обрабатывают изменения конфигурации устройства для вас.
Оригинальный ответ сохраняется ниже для справки. Но, пожалуйста, найдите время, чтобы изучить некоторые клиентские библиотеки Rest для Android, чтобы убедиться, что они подходят для ваших случаев использования. Ниже приведен список некоторых библиотек, которые я оценил. Это ни в коем случае не является исчерпывающим списком.
Оригинальный ответ:
Представление моего подхода к использованию REST-клиентов на Android. Я не утверждаю, что это лучший вариант :) Кроме того, обратите внимание, что это то, что я придумал в ответ на мое требование. Вам может понадобиться больше слоев / добавить больше сложности, если этого требует ваш вариант использования. Например, у меня вообще нет локального хранилища; потому что мое приложение может терпеть потерю нескольких ответов REST.
Мой подход использует только AsyncTask s под крышками. В моем случае я «вызываю» эти Задачи из моего Activity экземпляра; но чтобы полностью учитывать такие случаи, как поворот экрана, вы можете позвонить им с номера Service или около того.
Я сознательно выбрал сам мой REST-клиент в качестве API. Это означает, что приложению, использующему мой клиент REST, даже не нужно знать фактические URL-адреса REST и используемый формат данных.
У клиента будет 2 слоя:
Верхний уровень. Цель этого уровня - предоставить методы, которые отражают функциональность REST API. Например, у вас может быть один метод Java, соответствующий каждому URL в вашем REST API (или даже два - один для GET и один для POST).
Это точка входа в клиентский API REST. Это слой, который приложение будет использовать в обычном режиме. Это может быть одиночка, но не обязательно.
Ответ на вызов REST анализируется этим слоем в POJO и возвращается в приложение.
Это нижний уровень AsyncTask, который использует методы HTTP-клиента для фактического выхода и выполнения этого вызова REST.
Кроме того, я решил использовать механизм обратного вызова для передачи результатов AsyncTask обратно в приложение.
Достаточно текста. Давайте посмотрим код сейчас. Давайте возьмем гипотетический URL REST API - http://myhypotheticalapi.com/user/profile
Верхний слой может выглядеть так:
/**
* Entry point into the API.
*/
public class HypotheticalApi{
public static HypotheticalApi getInstance(){
//Choose an appropriate creation strategy.
}
/**
* Request a User Profile from the REST server.
* @param userName The user name for which the profile is to be requested.
* @param callback Callback to execute when the profile is available.
*/
public void getUserProfile(String userName, final GetResponseCallback callback){
String restUrl = Utils.constructRestUrlForProfile(userName);
new GetTask(restUrl, new RestTaskCallback (){
@Override
public void onTaskComplete(String response){
Profile profile = Utils.parseResponseAsProfile(response);
callback.onDataReceived(profile);
}
}).execute();
}
/**
* Submit a user profile to the server.
* @param profile The profile to submit
* @param callback The callback to execute when submission status is available.
*/
public void postUserProfile(Profile profile, final PostCallback callback){
String restUrl = Utils.constructRestUrlForProfile(profile);
String requestBody = Utils.serializeProfileAsString(profile);
new PostTask(restUrl, requestBody, new RestTaskCallback(){
public void onTaskComplete(String response){
callback.onPostSuccess();
}
}).execute();
}
}
/**
* Class definition for a callback to be invoked when the response data for the
* GET call is available.
*/
public abstract class GetResponseCallback{
/**
* Called when the response data for the REST call is ready. <br/>
* This method is guaranteed to execute on the UI thread.
*
* @param profile The {@code Profile} that was received from the server.
*/
abstract void onDataReceived(Profile profile);
/*
* Additional methods like onPreGet() or onFailure() can be added with default implementations.
* This is why this has been made and abstract class rather than Interface.
*/
}
/**
*
* Class definition for a callback to be invoked when the response for the data
* submission is available.
*
*/
public abstract class PostCallback{
/**
* Called when a POST success response is received. <br/>
* This method is guaranteed to execute on the UI thread.
*/
public abstract void onPostSuccess();
}
Обратите внимание, что приложение не использует JSON или XML (или любой другой формат), возвращаемый API REST напрямую. Вместо этого приложение видит только компонент Profile.
Тогда нижний слой (слой AsyncTask) может выглядеть так:
/**
* An AsyncTask implementation for performing GETs on the Hypothetical REST APIs.
*/
public class GetTask extends AsyncTask<String, String, String>{
private String mRestUrl;
private RestTaskCallback mCallback;
/**
* Creates a new instance of GetTask with the specified URL and callback.
*
* @param restUrl The URL for the REST API.
* @param callback The callback to be invoked when the HTTP request
* completes.
*
*/
public GetTask(String restUrl, RestTaskCallback callback){
this.mRestUrl = restUrl;
this.mCallback = callback;
}
@Override
protected String doInBackground(String... params) {
String response = null;
//Use HTTP Client APIs to make the call.
//Return the HTTP Response body here.
return response;
}
@Override
protected void onPostExecute(String result) {
mCallback.onTaskComplete(result);
super.onPostExecute(result);
}
}
/**
* An AsyncTask implementation for performing POSTs on the Hypothetical REST APIs.
*/
public class PostTask extends AsyncTask<String, String, String>{
private String mRestUrl;
private RestTaskCallback mCallback;
private String mRequestBody;
/**
* Creates a new instance of PostTask with the specified URL, callback, and
* request body.
*
* @param restUrl The URL for the REST API.
* @param callback The callback to be invoked when the HTTP request
* completes.
* @param requestBody The body of the POST request.
*
*/
public PostTask(String restUrl, String requestBody, RestTaskCallback callback){
this.mRestUrl = restUrl;
this.mRequestBody = requestBody;
this.mCallback = callback;
}
@Override
protected String doInBackground(String... arg0) {
//Use HTTP client API's to do the POST
//Return response.
}
@Override
protected void onPostExecute(String result) {
mCallback.onTaskComplete(result);
super.onPostExecute(result);
}
}
/**
* Class definition for a callback to be invoked when the HTTP request
* representing the REST API Call completes.
*/
public abstract class RestTaskCallback{
/**
* Called when the HTTP request completes.
*
* @param result The result of the HTTP request.
*/
public abstract void onTaskComplete(String result);
}
Вот как приложение может использовать API (в Activity или Service):
HypotheticalApi myApi = HypotheticalApi.getInstance();
myApi.getUserProfile("techie.curious", new GetResponseCallback() {
@Override
void onDataReceived(Profile profile) {
//Use the profile to display it on screen, etc.
}
});
Profile newProfile = new Profile();
myApi.postUserProfile(newProfile, new PostCallback() {
@Override
public void onPostSuccess() {
//Display Success
}
});
Надеюсь, комментариев достаточно, чтобы объяснить дизайн; но я был бы рад предоставить больше информации.