Android ऐप में रेट्रोफ़िट 2 का उपयोग करना

रेट्रोफिट एक लाइब्रेरी है जिसे नेटवर्किंग के लिए एंड्रॉइड डेवलपर्स के बीच जाना जाता है, कुछ इसे किसी तरह से मानक भी मानते हैं। इस लोकप्रियता के कई कारण हैं: लाइब्रेरी पूरी तरह से REST एपीआई का समर्थन करती है, यह आसानी से परीक्षण और कॉन्फ़िगर किया गया है, और इसकी मदद से नेटवर्क पर अनुरोध बहुत सरलता से किए जाते हैं। इस लेख में, मैं आपको दिखाऊंगा कि अपने आवेदन के साथ नेटवर्किंग को लागू करने के लिए रेट्रोफिट को कैसे कॉन्फ़िगर और उपयोग किया जाए।

कॉन्फ़िगर करें

निम्न निर्भरता build.gradle फ़ाइल में जोड़ें:

 implementation 'com.squareup.retrofit2:retrofit:2.4.0' 

हम GSON का उपयोग JSON को POJO में बदलने के लिए करेंगे। रेट्रोफिट एक निर्भरता प्रदान करता है जो JSON को POJO में स्वचालित रूप से परिवर्तित करता है। ऐसा करने के लिए, build.gradle फ़ाइल में एक और निर्भरता जोड़ें:

 implementation 'com.squareup.retrofit2:converter-gson:2.3.0' 

यदि आपके एप्लिकेशन को अभी तक नेटवर्क के साथ काम करने की अनुमति नहीं है, तो AndroidManifest फ़ाइल में संबंधित लाइन जोड़ना सुनिश्चित करें:

 <uses-permission android:name="android.permission.INTERNET"/> 

निर्भरता जुड़ने के बाद, हमें रेट्रोफिट लाइब्रेरी को कॉन्फ़िगर करने के लिए कोड लिखना होगा।

NetworkService नामक एक क्लास बनाएँ:

 public class NetworkService { } 

यह क्लास एक सिंगलटन ऑब्जेक्ट होनी चाहिए, इसलिए एक स्टैटिक वेरिएबल और एक फंक्शन की घोषणा करें जो क्लास के समान ही एक वेरिएबल बनाता है और रिटर्न करता है। यदि आप नहीं जानते कि यह पैटर्न कैसे काम करता है, तो इस लेख को देखें , जिसमें जावा भाषा में कार्यान्वयन के उदाहरण हैं।

 public class NetworkService { private static NetworkService mInstance; public static NetworkService getInstance() { if (mInstance == null) { mInstance = new NetworkService(); } return mInstance; } } 

परीक्षण के लिए, हम JSONPlaceholder का उपयोग करते हैं, जो डेवलपर्स के लिए एक नकली ऑनलाइन REST API प्रदान करता है:

 https://jsonplaceholder.typicode.com 

अब हम NetworkService कंस्ट्रक्टर में रेट्रोफिट घोषित और आरंभ करेंगे:

 public class NetworkService { private static NetworkService mInstance; private static final String BASE_URL = "https://jsonplaceholder.typicode.com"; private Retrofit mRetrofit; private NetworkService() { mRetrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create()) .build(); } public static NetworkService getInstance() { if (mInstance == null) { mInstance = new NetworkService(); } return mInstance; } } 

कॉन्फ़िगरेशन पूर्ण है, अब हमें उन समापन बिंदुओं को निर्धारित करने की आवश्यकता है जो डेटा वापस करेंगे।

समापन बिंदु जोड़ना

JSONPlaceHolderApi नाम का इंटरफ़ेस बनाएँ:

 public interface JSONPlaceHolderApi { } 

JSONPlaceHolder साइट पर , URL /posts/id अंतिम बिंदु है जो उचित पहचानकर्ता के साथ एक संदेश देता है। यह समापन बिंदु एक GET अनुरोध प्राप्त करता है और JSON प्रारूप में डेटा निम्नानुसार प्राप्त करता है:

 { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto" } 

सबसे पहले, हम JSON प्रतिक्रिया के लिए उपयुक्त POJO बनाएंगे:

 public class Post { @SerializedName("userId") @Expose private int userId; @SerializedName("id") @Expose private int id; @SerializedName("title") @Expose private String title; @SerializedName("body") @Expose private String body; public int getUserId() { return userId; } public void setUserId(int userId) { this.userId = userId; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public String getBody() { return body; } public void setBody(String body) { this.body = body; } } 

जैसा कि आप देख सकते हैं, यह एक सरल POJO वर्ग है। हमने वहां नाम पास करते हुए @SerializedName() का उपयोग करते हुए वेरिएबल्स को एनोटेट किया। ये नाम वास्तव में एपीआई से लौटे JSON डेटा की कुंजियाँ हैं, इसलिए आप अपनी @SerializedName() परिवर्तनशील नाम को बदल सकते हैं, लेकिन यह सुनिश्चित करें कि @SerializedName() एनोटेशन को पास किया गया नाम JSON में मौजूद है।

उपरोक्त इंटरफ़ेस में, आवश्यक मापदंडों के साथ समापन बिंदु को परिभाषित करें:

 public interface JSONPlaceHolderApi { @GET("/posts/{id}") public Call<Post> getPostWithID(@Path("id") int id); } 

चूंकि हम एक GET अनुरोध भेज रहे हैं, इसलिए हमें उस विधि पर @GET एनोटेशन लागू करना @GET , जिसके अंदर वह समापन बिंदु है जिसके लिए हम अनुरोध भेजना चाहते हैं। जैसा कि आप देख सकते हैं, हम पूर्ण URL नहीं जोड़ रहे हैं, जैसा कि BASE_URL स्वचालित रूप से BASE_URL को BASE_URL वर्ग में ले जाएगा और शेष URL में जोड़ देगा।

वापसी के तरीके को Call<Post> कहा जाता है। Call लाइब्रेरी द्वारा सीधे प्रदान किया जाने वाला एक वर्ग है। और इंटरफ़ेस के सभी तरीकों को इस प्रकार के मूल्यों को वापस करना चाहिए। यह एक सामान्य वर्ग है जो उस प्रकार के ऑब्जेक्ट में लेता है जिसे हम JSON में बदलना चाहते हैं। हमने Post पास कर ली क्योंकि यह वास्तव में वह वस्तु है जिसे हम JSON प्रतिक्रिया में बदलना चाहते हैं। हमने मापदंडों के लिए एक पूर्णांक पारित किया और @Path का उपयोग करके इसे एनोटेट किया, जिसके अंदर हमने id लिखा था। रेट्रोफिट यह मान लेगा और समापन बिंदु पर {id} को बदल देगा। इस प्रकार, यदि हम मान 1 को एक पैरामीटर के रूप में पास करते हैं, तो समापन बिंदु इस तरह दिखेगा - /posts/1 , यदि हम मान 10 पास करते हैं, तो समापन बिंदु होगा - /posts/10 ।

अब हमें JSONPlaceHolderApi इंटरफ़ेस का कार्यान्वयन प्रदान करने के लिए JSONPlaceHolderApi की JSONPlaceHolderApi है। ऐसा करने के लिए, create() विधि का उपयोग करें:

 public class NetworkService { private static NetworkService mInstance; private static final String BASE_URL = "https://jsonplaceholder.typicode.com"; private Retrofit mRetrofit; private NetworkService() { mRetrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create()) .build(); } public static NetworkService getInstance() { if (mInstance == null) { mInstance = new NetworkService(); } return mInstance; } public JSONPlaceHolderApi getJSONApi() { return mRetrofit.create(JSONPlaceHolderApi.class); } } 

इसके बाद, आपको JSONPlaceHolderApi से JSONPlaceHolderApi प्राप्त करने और एक अनुरोध भेजने की आवश्यकता है:

 NetworkService.getInstance() .getJSONApi() .getPostWithID(1) .enqueue(new Callback<Post>() { @Override public void onResponse(@NonNull Call<Post> call, @NonNull Response<Post> response) { Post post = response.body(); textView.append(post.getId() + "\n"); textView.append(post.getUserId() + "\n"); textView.append(post.getTitle() + "\n"); textView.append(post.getBody() + "\n"); } @Override public void onFailure(@NonNull Call<Post> call, @NonNull Throwable t) { textView.append("Error occurred while getting request!"); t.printStackTrace(); } }); 

लौटी हुई Call ऑब्जेक्ट में एक विधि होती है जिसे enqueue कहा जाता है, जो Callback<T> को एक पैरामीटर के रूप में लेता है। onResponse हमें Response<Post> परिणाम प्राप्त होता है जिसमें Post ऑब्जेक्ट सर्वर से वापस आ जाता है। Post ऑब्जेक्ट को स्वयं प्राप्त करने के लिए, हम response.body() पद्धति का उपयोग करते हैं। बाकी कोड आगे की व्याख्या के बिना समझ में आता है।

विभिन्न प्रकार के अनुरोध भेजना

JSONPlaceHolder API के कई अलग-अलग समापन बिंदु हैं जिनका आप उपयोग कर सकते हैं।

संदेशों की एक सूची प्राप्त करना

 @GET("/posts") public Call<List<Post>> getAllPosts(); 

सभी संदेशों की सूची प्राप्त करने के लिए, हमने समापन बिंदु और फ़ंक्शन का प्रकार बदला।

पैरामीटर के साथ अनुरोध भेजना

यदि आप एक पैरामीटर के साथ एक अनुरोध भेजना चाहते हैं, तो आपको विधि में संबंधित पैरामीटर के लिए @Query() एनोटेशन का उपयोग करने की आवश्यकता है:

 @GET("/posts") public Call<List<Post>> getPostOfUser(@Query("userId") int id); 

इसलिए, यदि हम विधि पैरामीटर में मान 6 पास करते हैं, तो समापन बिंदु अगला होगा - /posts?userId=6 ।

पोस्ट अनुरोध भेजना

POST अनुरोध भेजने के लिए, आपको बस विधि के एनोटेशन को बदलने की आवश्यकता है।

 @POST("/posts") public Call<Post> postData(@Body Post data); 

इस पद्धति के लिए अनुरोध निकाय बनाने के लिए, हम पारित पैरामीटर के लिए @Body एनोटेशन का उपयोग करते हैं। रेट्रोफिट Gson का उपयोग @Body को JSON में बदलने के लिए करेगा।

कई और विभिन्न प्रकार के प्रश्न हैं जिनका आप उपयोग कर सकते हैं, लेकिन यह एक अलग लेख के लिए एक विषय है।

अवरोधन का अनुरोध करें

रेट्रोफ़िट अनुरोधों को अवरोधन और उन्हें लॉगकैट में लॉग इन करने का एक तरीका प्रदान करता है। आइए एक इंटरसेप्टर सेट करें और इस जादू को देखें। निम्न निर्भरता build.gradle फ़ाइल में जोड़ें:

 implementation 'com.squareup.okhttp3:logging-interceptor:3.8.0' 

NetworkService वर्ग को इस तरह अपडेट करें:

 public class NetworkService { private static NetworkService mInstance; private static final String BASE_URL = "https://jsonplaceholder.typicode.com"; private Retrofit mRetrofit; private NetworkService() { HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor(); interceptor.setLevel(HttpLoggingInterceptor.Level.BODY); OkHttpClient.Builder client = new OkHttpClient.Builder() .addInterceptor(interceptor); mRetrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create()) .client(client.build()) .build(); } public static NetworkService getInstance() { if (mInstance == null) { mInstance = new NetworkService(); } return mInstance; } public JSONPlaceHolderApi getJSONApi() { return mRetrofit.create(JSONPlaceHolderApi.class); } } 

अब, जब आप कोई अनुरोध भेजते या प्राप्त करते हैं, तो URL, हेडर, बॉडी सहित उसके सभी डेटा लॉग में प्रदर्शित होंगे:

 D/OkHttp: <-- 200 https://jsonplaceholder.typicode.com/posts/1 (3030ms) date: Tue, 24 Apr 2018 15:25:19 GMT content-type: application/json; charset=utf-8 set-cookie: __cfduid=d16d4221ddfba20b5464e6829eed4e3d11524583519; expires=Wed, 24-Apr-19 15:25:19 GMT; path=/; domain=.typicode.com; HttpOnly x-powered-by: Express vary: Origin, Accept-Encoding access-control-allow-credentials: true cache-control: public, max-age=14400 pragma: no-cache expires: Tue, 24 Apr 2018 19:25:19 GMT 04-24 15:25:16.204 7023-7056/com.thetehnocafe.gurleensethi.retrofitexample D/OkHttp: x-content-type-options: nosniff etag: W/"124-yiKdLzqO5gfBrJFrcdJ8Yq0LGnU" via: 1.1 vegur cf-cache-status: HIT expect-ct: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct" server: cloudflare cf-ray: 410994f328963066-SIN 04-24 15:25:16.246 7023-7056/com.thetehnocafe.gurleensethi.retrofitexample D/OkHttp: { 04-24 15:25:16.247 7023-7056/com.thetehnocafe.gurleensethi.retrofitexample D/OkHttp: "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto" } <-- END HTTP (292-byte body) 

इससे हमारा लेख समाप्त होता है। आप इस प्रोजेक्ट के लिए GitHub पर कोड पा सकते हैं।