EDIT 2 (अक्टूबर 2017):
यह 2017 है। बस रेट्रोफिट का उपयोग करें। कुछ और उपयोग करने का लगभग कोई कारण नहीं है।
संपादित करें:
इस एडिट के समय मूल उत्तर डेढ़ साल से अधिक पुराना है। यद्यपि मूल उत्तर में प्रस्तुत अवधारणाएं अभी भी पकड़ में हैं, क्योंकि अन्य उत्तर इंगित करते हैं, अब वहाँ पुस्तकालय हैं जो इस कार्य को आपके लिए आसान बनाते हैं। इससे भी महत्वपूर्ण बात, इन पुस्तकालयों में से कुछ आपके लिए डिवाइस कॉन्फ़िगरेशन परिवर्तन को संभालते हैं।
मूल उत्तर को संदर्भ के लिए नीचे रखा गया है। लेकिन कृपया यह भी देखें कि एंड्रॉइड के कुछ रेस्ट क्लाइंट पुस्तकालयों की जांच के लिए यह देखने के लिए कि क्या वे आपके उपयोग के मामलों में फिट हैं। निम्नलिखित उन कुछ पुस्तकालयों की सूची है जिनका मैंने मूल्यांकन किया है। यह किसी भी तरह से एक संपूर्ण सूची नहीं है।
मूल उत्तर:
Android पर REST क्लाइंट रखने के लिए मेरा दृष्टिकोण प्रस्तुत करना। मैं यह दावा नहीं करता कि यह सबसे अच्छा है :) इसके अलावा, ध्यान दें कि यह वही है जो मैं अपनी आवश्यकता के जवाब में आया था। यदि आपके उपयोग के मामले की मांग है, तो आपको और अधिक परतें / अधिक जटिलताएं जोड़ने की आवश्यकता हो सकती है। उदाहरण के लिए, मेरे पास स्थानीय भंडारण नहीं है; क्योंकि मेरा ऐप कुछ REST प्रतिक्रियाओं के नुकसान को सहन कर सकता है।
मेरा दृष्टिकोण AsyncTaskकवर के तहत सिर्फ एस का उपयोग करता है । मेरे मामले में, मैं अपने Activityउदाहरण से इन कार्यों को "कॉल" करता हूं ; लेकिन स्क्रीन रोटेशन जैसे मामलों के लिए पूरी तरह से खाते में, आप उन्हें ए से कॉल करना चुन सकते हैंService या ऐसे ।
मैंने सचेत रूप से अपने REST क्लाइंट को API के रूप में चुना। इसका मतलब है, कि जो ऐप मेरे REST क्लाइंट का उपयोग करता है, उसे वास्तविक REST URL और डेटा प्रारूप का उपयोग करने की भी जानकारी नहीं होनी चाहिए।
क्लाइंट की 2 परतें होंगी:
शीर्ष परत: इस परत का उद्देश्य उन तरीकों को प्रदान करना है जो REST API की कार्यक्षमता को प्रतिबिंबित करते हैं। उदाहरण के लिए, आप अपने REST API में प्रत्येक URL के अनुरूप एक जावा विधि (या यहां तक कि दो - GET के लिए एक और POST के लिए एक) रख सकते हैं।
यह REST क्लाइंट API में प्रवेश बिंदु है। यह वह परत है जिसे ऐप सामान्य रूप से उपयोग करेगा। यह एक सिंगलटन हो सकता है, लेकिन जरूरी नहीं।
REST कॉल की प्रतिक्रिया को इस परत द्वारा POJO में पार्स किया जाता है और ऐप पर वापस आ जाता है।
यह निचले स्तर की AsyncTaskपरत है, जो वास्तव में बाहर जाने और उस कॉल को करने के लिए HTTP क्लाइंट विधियों का उपयोग करती है।
इसके अलावा, मैंने के परिणाम को संप्रेषित करने के लिए एक कॉलबैक तंत्र का उपयोग करने के लिए चुना AsyncTask ऐप पर वापस जाने के ।
पाठ का पर्याप्त। अब कुछ कोड देखते हैं। आइए एक काल्पनिक REST API URL लें - 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 (या जो भी अन्य प्रारूप) का उपयोग नहीं करता है, वह सीधे REST API द्वारा लौटाया जाता है। इसके बजाय, ऐप केवल बीन को देखता है 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
}
});
मुझे उम्मीद है कि टिप्पणियां डिजाइन को समझाने के लिए पर्याप्त हैं; लेकिन मुझे अधिक जानकारी प्रदान करने में खुशी होगी।