EDIT 2 (жовтень 2017):
Це 2017. Просто використовуйте Retrofit. Причин використовувати інше майже немає.
Редагувати:
Оригінальна відповідь на момент редагування становила понад півтора року. Хоча поняття, представлені в оригінальній відповіді, все ще зберігаються, як вказують інші відповіді, зараз там є бібліотеки, які полегшують вам це завдання. Що ще важливіше, деякі з цих бібліотек обробляють зміни конфігурації пристрою для вас.
Оригінал відповіді зберігається нижче для довідки. Але також знайдіть час, щоб вивчити деякі бібліотеки клієнтів «Відпочинок» для Android, щоб побачити, чи відповідають вони вашим випадкам використання. Далі подано список деяких бібліотек, які я оцінив. Це аж ніяк не є вичерпним списком.
Оригінальний відповідь:
Представляю мій підхід до отримання REST-клієнтів на Android. Я не стверджую, що це найкраще :) Також зауважте, що саме це я придумав у відповідь на мою вимогу. Можливо, вам доведеться мати більше шарів / додати більше складності, якщо цього вимагає ваш випадок використання. Наприклад, я зовсім не маю локального сховища; тому що мій додаток може терпіти втрату кількох відповідей REST.
Мій підхід використовує тільки AsyncTasks під прикриттями. У моєму випадку я "викликаю" ці Завдання зі свого Activityпримірника; але для повного обліку випадків, таких як обертання екрана, ви можете обрати їх до того Serviceчи іншого.
Я свідомо вибрав свого клієнта REST як API. Це означає, що додаток, який використовує мій REST-клієнт, навіть не повинен знати про фактичні URL-адреси REST та використовуваний формат даних.
Клієнт матиме два шари:
Верхній шар: Метою цього шару є надання методів, що відображають функціональність API REST. Наприклад, у вас може бути один метод Java, відповідний кожній URL-адресі вашого REST API (або навіть два - один для GET та один для POST).
Це точка входу в API клієнта REST. Це шар, який додаток використовує нормально. Це може бути сингл, але не обов’язково.
Відповідь на виклик REST цей рівень аналізується на POJO та повертається в додаток.
Це нижчий рівень AsyncTask, який використовує клієнтські методи HTTP для фактичного виходу та здійснення цього REST-дзвінка.
Крім того, я вирішив використовувати механізм AsyncTaskзворотного виклику для передачі результату s назад до програми.
Досить тексту. Давайте зараз подивимось якийсь код. Дозволяє приймати гіпотетичну URL-адресу API REST - 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
}
});
Я сподіваюся, що коментарів достатньо для пояснення дизайну; але я б радий надати більше інформації.