1. रेट्रोफिट

1.1। रेट्रोफिट क्या है?

रेट्रोफिट जावा और एंड्रॉइड के लिए एक REST क्लाइंट है। यह REST- आधारित वेब सेवा के माध्यम से JSON (या अन्य संरचित डेटा) को प्राप्त करना और लोड करना आसान बनाता है। रेट्रोफ़िट में, आप कॉन्फ़िगर करते हैं कि डेटा को अनुक्रमित करने के लिए किस कनवर्टर का उपयोग किया जाता है। आमतौर पर GSON का उपयोग JSON के लिए किया जाता है, लेकिन आप XML या अन्य प्रोटोकॉल को संसाधित करने के लिए अपने स्वयं के कन्वर्टर्स जोड़ सकते हैं। रेट्रोफिट HTTP अनुरोधों के लिए OkHttp लाइब्रेरी का उपयोग करता है।

आप निम्नलिखित टूल का उपयोग करके JSON- आधारित जावा ऑब्जेक्ट बना सकते हैं: www.jsonschema2pojo.org यह मौजूदा JSON से जटिल जावा डेटा स्ट्रक्चर्स बनाने के लिए उपयोगी हो सकता है।

1.2। रेट्रोफिट का उपयोग करना

रेट्रोफिट के साथ काम करने के लिए, आपको निम्नलिखित तीन वर्गों की आवश्यकता होगी:

• मॉडल वर्ग जिसे JSON मॉडल के रूप में उपयोग किया जाता है
• संभावित HTTP संचालन की पहचान करने वाले इंटरफेस
• Retrofit.Builder वर्ग एक उदाहरण है जो HTTP ऑपरेशन के लिए URL समापन बिंदु परिभाषा को परिभाषित करने के लिए बिल्डर इंटरफ़ेस और एपीआई का उपयोग करता है।

प्रत्येक इंटरफ़ेस विधि संभव एपीआई कॉल में से एक का प्रतिनिधित्व करती है। अनुरोध के प्रकार और रिश्तेदार URL को इंगित करने के लिए इसमें HTTP एनोटेशन (GET, POST, आदि) होना चाहिए। वापसी मूल्य अपेक्षित परिणाम प्रकार के साथ कॉल ऑब्जेक्ट में प्रतिक्रिया को पूरा करता है।

@GET("users") Call<List<User>> getUsers(); 

URL को कॉन्फ़िगर करने के लिए आप प्रतिस्थापन ब्लॉक और क्वेरी पैरामीटर का उपयोग कर सकते हैं। रिप्लेसमेंट ब्लॉक को {} का उपयोग करके संबंधित URL से जोड़ा जाता है। विधि पैरामीटर के लिए @ पथ एनोटेशन का उपयोग करते हुए, इस पैरामीटर का मान एक विशिष्ट प्रतिस्थापन ब्लॉक से बंधा होता है।

 @GET("users/{name}/commits") Call<List<Commit>> getCommitsByName(@Path("name") String name); 

विधि पैरामीटर के लिए @ क्वेरी एनोटेशन का उपयोग करके क्वेरी पैरामीटर जोड़े जाते हैं। वे URL के अंत में स्वचालित रूप से जुड़ जाते हैं।

 @GET("users") Call<User> getUserById(@Query("id") Integer id); 

विधि पैरामीटर के लिए @ बॉडी एनोटेशन, ऑब्जेक्ट को कॉल करने के लिए अनुरोध निकाय के रूप में उपयोग करने के लिए रेट्रोफ़िट को बताता है।

 @POST("users") Call<User> postUser(@Body User user) 

2. पूर्वापेक्षाएँ

निम्न उदाहरण ग्रेड निर्माण के साथ ग्रहण आईडीई का उपयोग करते हैं।
यह अभ्यास मानता है कि आप ग्रैडल से परिचित हैं और ग्रहण के साथ ग्रैडल का उपयोग कर रहे हैं।

अन्य विकास वातावरण, जैसे कि Visual Studio Code या IntelliJ, वही करते हैं, जिससे आप अपने पसंदीदा टूल का उपयोग कर सकते हैं।

3. व्यायाम: पहले रेट्रोफिट क्लाइंट

इस अभ्यास में, आप एक स्वसंपूर्ण REST ग्राहक बनाएंगे। प्रतिक्रियाएँ मॉक सर्वर द्वारा उत्पन्न की जाती हैं।

3.1। प्रोजेक्ट बनाना और स्थापित करना

Com.vogella.retrofitgerrit नाम से एक नया ग्रेडल प्रोजेक्ट बनाएं। Com.vogella.retrofitgerrit नाम के src / main / java में एक नया पैकेज जोड़ें।

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

 // retrofit implementation 'com.squareup.retrofit2:retrofit:2.1.0' implementation 'com.squareup.retrofit2:converter-gson:2.1.0' // Junit testImplementation("org.junit.jupiter:junit-jupiter-api:5.0.0") testRuntime("org.junit.jupiter:junit-jupiter-engine:5.0.0") // to run JUnit 3/4 tests: testImplementation("junit:junit:4.12") testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0") 

3.2। एपीआई और रेट्रोफिट एडाप्टर को परिभाषित करें

जेरिट की JSON प्रतिक्रिया में, हम केवल परिवर्तनों के प्रश्न में रुचि रखते हैं। इसलिए, पहले जोड़े गए डिफ़ॉल्ट पैकेज में निम्न डेटा वर्ग बनाएं।

 package com.vogella.java.retrofitgerrit; public class Change { String subject; public String getSubject() { return subject; } public void setSubject(String subject) { this.subject = subject; } } 

निम्नलिखित इंटरफ़ेस के माध्यम से रेट्रोफिट के लिए REST API को परिभाषित करें।

 package com.vogella.java.retrofitgerrit; import java.util.List; import retrofit2.Call; import retrofit2.http.GET; import retrofit2.http.Query; public interface GerritAPI { @GET("changes/") Call<List<Change>> loadChanges(@Query("q") String status); } 

निम्न नियंत्रक वर्ग बनाएँ। यह वर्ग एक रेट्रोफिट क्लाइंट बनाता है, जेरिट एपीआई को कॉल करता है, और परिणाम को संसाधित करता है (कंसोल पर कॉल के परिणाम को प्रिंट करता है)।

 package com.vogella.java.retrofitgerrit; import java.util.List; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import retrofit2.Retrofit; import retrofit2.converter.gson.GsonConverterFactory; public class Controller implements Callback<List<Change>> { static final String BASE_URL = "https://git.eclipse.org/r/"; public void start() { Gson gson = new GsonBuilder() .setLenient() .create(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create(gson)) .build(); GerritAPI gerritAPI = retrofit.create(GerritAPI.class); Call<List<Change>> call = gerritAPI.loadChanges("status:open"); call.enqueue(this); } @Override public void onResponse(Call<List<Change>> call, Response<List<Change>> response) { if(response.isSuccessful()) { List<Change> changesList = response.body(); changesList.forEach(change -> System.out.println(change.subject)); } else { System.out.println(response.errorBody()); } } @Override public void onFailure(Call<List<Change>> call, Throwable t) { t.printStackTrace(); } } 

नियंत्रक शुरू करने के लिए एक मुख्य विधि के साथ एक वर्ग बनाएं।

 package com.vogella.java.retrofitgerrit; public class Main { public static void main(String[] args) { Controller controller = new Controller(); controller.start(); } } 

4. रेट्रोफिट कन्वर्टर्स और एडेप्टर

4.1। रेट्रोफिट कन्वर्टर्स

एक विशिष्ट कनवर्टर का उपयोग करने के लिए रेट्रोफिट को कॉन्फ़िगर किया जा सकता है। यह कन्वर्टर डेटा का क्रमबद्धकरण (डी) करता है। कई कन्वर्टर्स विभिन्न क्रमांकन प्रारूपों के लिए पहले से ही उपलब्ध हैं।

• JSON में परिवर्तित करने के लिए और इसके विपरीत:
  
  • Gson: com.squareup.retrofit: कनवर्टर-जीसन
  • जैक्सन: com.squareup.retrofit: कनवर्टर-जैकसन
  • मोशी: com.squareup.retrofit: कनवर्टर-मोशी
  
  
• प्रोटोकॉल बफ़र्स में कनवर्ट करने के लिए और इसके विपरीत:
  
  • प्रोटोबॉफ़: com.squareup.retrofit: कनवर्टर-प्रोटोबॉफ़
  • तार: com.squareup.retrofit: कनवर्टर-तार
  
  
• XML में परिवर्तित करने के लिए और इसके विपरीत:
  
  • सिंपल XML: com.squareup.retrofit: कनवर्टर-सिम्प्लेक्स एमएल
  
  

सूचीबद्ध कन्वर्टर्स के अलावा, आप कनवर्टर.फैक्टरी क्लास को बढ़ाकर अन्य प्रोटोकॉल को संसाधित करने के लिए अपना खुद का बना सकते हैं।

4.2। रेट्रोपरिट एडेप्टर

RxJava 2.x, Java 8, और Guava जैसे अन्य पुस्तकालयों के साथ इंटरफेस करने के लिए एडाप्टर्स के साथ रेट्रोफिट भी बढ़ाया जा सकता है।

उपलब्ध एडेप्टर का अवलोकन जीथब स्क्वायर / रेट्रोफिट / रेट्रोफिट-एडेप्टर / में पाया जा सकता है।

उदाहरण के लिए, RxJava 2.x एडेप्टर ग्रैडल का उपयोग करके जोड़ा जा सकता है:

 compile 'com.squareup.retrofit2:adapter-rxjava2:latest.version' 

या अपाचे मावेन का उपयोग कर:

 <dependency> <groupId>com.squareup.retrofit2</groupId> <artifactId>adapter-rxjava2</artifactId> <version>latest.version</version> </dependency> 

एडेप्टर जोड़ने के लिए, आपको retrofit2.Retrofit.Builder.addCallAdapterFactory (फ़ैक्टरी) विधि का उपयोग करना होगा।

 Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.example.com/") .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) .build(); 

इस एडेप्टर का उपयोग करते हुए, रेट्रोफिट इंटरफेस RxJava 2.x प्रकारों को वापस कर सकते हैं, उदाहरण के लिए, ऑब्जर्वेबल, फ्लोएबल या सिंगल, आदि।

 @GET("users") Observable<List<User>> getUsers(); 

5. रेट्रोफिट प्रमाणीकरण

रेट्रोफ़िट एपीआई कॉल का समर्थन करता है जिसे प्रमाणीकरण की आवश्यकता होती है। प्रमाणीकरण उपयोगकर्ता नाम और पासवर्ड (Http बेसिक प्रमाणीकरण) या API टोकन का उपयोग करके किया जा सकता है।

प्रमाणीकरण को प्रबंधित करने के दो तरीके हैं। पहली विधि एनोटेशन का उपयोग करके अनुरोध हेडर का प्रबंधन करना है। एक और तरीका है कि इसके लिए एक OkHttp इंटरसेप्टर का उपयोग किया जाए।

5.1। एनोटेशन के साथ प्रमाणीकरण

मान लीजिए कि आप उस उपयोगकर्ता के बारे में जानकारी का अनुरोध करना चाहते हैं जिसके लिए प्रमाणीकरण आवश्यक है। आप उदाहरण के लिए, एपीआई परिभाषा में एक नया पैरामीटर जोड़कर ऐसा कर सकते हैं:

 @GET("user") Call<UserDetails> getUserDetails(@Header("Authorization") String credentials) 

@ हैडर ("ऑथराइज़ेशन") एनोटेशन का उपयोग करके, आप रिट्रेफ़िट को ऑथराइज़ेशन हेडर को उस मूल्‍य के साथ जोड़ने का अनुरोध करते हैं जिसे आप पास कर रहे हैं।

मूल प्रमाणीकरण के लिए क्रेडेंशियल उत्पन्न करने के लिए, आप इसका आधार (स्ट्रिंग, स्ट्रिंग) विधि के साथ OkHttps क्रेडेंशियल्स वर्ग का उपयोग कर सकते हैं। विधि एक उपयोगकर्ता नाम और पासवर्ड स्वीकार करती है और Http बेसिक स्कीम के लिए प्रमाणीकरण क्रेडेंशियल लौटाती है।

 Credentials.basic("ausername","apassword"); 

यदि आप API टोकन का उपयोग करना चाहते हैं और मूल योजना का उपयोग नहीं करना चाहते हैं, तो बस अपने टोकन के साथ getUserDetails (स्ट्रिंग) विधि को कॉल करें।

5.2। OkHttp इंटरसेप्टर के साथ प्रमाणीकरण।

यदि आप उपयोगकर्ता डेटा का अनुरोध करते हैं तो उपरोक्त विधि केवल क्रेडेंशियल जोड़ती है। यदि आपके पास प्रमाणीकरण के लिए अधिक कॉल हैं, तो आप ऐसा करने के लिए इंटरसेप्टर का उपयोग कर सकते हैं। इंटरसेप्टर का उपयोग निष्पादित होने से पहले प्रत्येक अनुरोध को संशोधित करने और अनुरोध हेडर को सेट करने के लिए किया जाता है। लाभ यह है कि आपको प्रत्येक एपीआई विधि परिभाषा में @ हैडर ("प्राधिकरण") जोड़ने की आवश्यकता नहीं है।

इंटरसेप्टर जोड़ने के लिए, आपको OkHttp बिल्डर में okhttp3.OkHttpClient.Builder.addInterceptor (इंटरसेप्टर) विधि का उपयोग करना होगा।

 OkHttpClient okHttpClient = new OkHttpClient().newBuilder().addInterceptor(new Interceptor() { @Override public okhttp3.Response intercept(Chain chain) throws IOException { Request originalRequest = chain.request(); Request.Builder builder = originalRequest.newBuilder().header("Authorization", Credentials.basic("aUsername", "aPassword")); Request newRequest = builder.build(); return chain.proceed(newRequest); } }).build(); 

OkHttp द्वारा बनाए गए क्लाइंट को Retrofit2.Retrofit.Builder.client (OkHttpClient) विधि का उपयोग करके अपने रेट्रोफिट क्लाइंट में जोड़ा जाना चाहिए।

 Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.example.com/") .client(okHttpClient) .build(); 

जैसा कि आपने देखा है, यहां बेसिक ऑथराइजेशन के लिए क्रेडेंशियल्स क्लास का उपयोग किया जाता है।
फिर, यदि आप एपीआई टोकन का उपयोग करना चाहते हैं, तो इसके बजाय सिर्फ टोकन का उपयोग करें।

6. एक्सरसाइज: जावा में रीट्रोफिट टू रिक्वेस्ट गेरिट का इस्तेमाल

निम्न अनुभाग वर्णन करता है कि एक न्यूनतम जावा एप्लिकेशन कैसे बनाया जाए जो कि Gerrit API से खुली परिवर्तन वस्तुओं को पुनः प्राप्त करने के लिए रेट्रोफिट का उपयोग करता है। परिणाम कंसोल में मुद्रित होते हैं।

6.1। प्रोजेक्ट बनाना और स्थापित करना

यह अभ्यास मानता है कि आप ग्रहण के लिए ग्रैडल और बिल्डशिप से परिचित हैं।

Com.vogella.java.retrofitgerrit नाम से एक नया ग्रेडल प्रोजेक्ट बनाएं। Com.vogella.java.retrofitgerrit नाम के src / main / java में एक नया पैकेज जोड़ें।

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

 // retrofit implementation 'com.squareup.retrofit2:retrofit:2.1.0' implementation 'com.squareup.retrofit2:converter-gson:2.1.0' // Junit testImplementation("org.junit.jupiter:junit-jupiter-api:5.0.0") testRuntime("org.junit.jupiter:junit-jupiter-engine:5.0.0") // to run JUnit 3/4 tests: testImplementation("junit:junit:4.12") testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0") 

6.2। एपीआई और रेट्रोफिट एडाप्टर को परिभाषित करें

जेरिट की JSON प्रतिक्रिया में, हम केवल परिवर्तनों के प्रश्न में रुचि रखते हैं। इसलिए, पहले जोड़े गए डिफ़ॉल्ट पैकेज में निम्न डेटा वर्ग बनाएं।

 package com.vogella.java.retrofitgerrit; public class Change { String subject; public String getSubject() { return subject; } public void setSubject(String subject) { this.subject = subject; } } 

निम्नलिखित इंटरफ़ेस का उपयोग करके रेट्रोफिट के लिए REST API को परिभाषित करें।

 package com.vogella.java.retrofitgerrit; import java.util.List; import retrofit2.Call; import retrofit2.http.GET; import retrofit2.http.Query; public interface GerritAPI { @GET("changes/") Call<List<Change>> loadChanges(@Query("q") String status); } 

निम्न नियंत्रक वर्ग बनाएँ। यह वर्ग एक रेट्रोफिट क्लाइंट बनाता है, जेरिट एपीआई को कॉल करता है, और परिणाम को संसाधित करता है (कंसोल पर कॉल के परिणाम को प्रिंट करता है)।

 package com.vogella.java.retrofitgerrit; import java.util.List; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import retrofit2.Retrofit; import retrofit2.converter.gson.GsonConverterFactory; public class Controller implements Callback<List<Change>> { static final String BASE_URL = "https://git.eclipse.org/r/"; public void start() { Gson gson = new GsonBuilder() .setLenient() .create(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addConverterFactory(GsonConverterFactory.create(gson)) .build(); GerritAPI gerritAPI = retrofit.create(GerritAPI.class); Call<List<Change>> call = gerritAPI.loadChanges("status:open"); call.enqueue(this); } @Override public void onResponse(Call<List<Change>> call, Response<List<Change>> response) { if(response.isSuccessful()) { List<Change> changesList = response.body(); changesList.forEach(change -> System.out.println(change.subject)); } else { System.out.println(response.errorBody()); } } @Override public void onFailure(Call<List<Change>> call, Throwable t) { t.printStackTrace(); } } 

नियंत्रक शुरू करने के लिए एक मुख्य विधि के साथ एक वर्ग बनाएं।

 package com.vogella.java.retrofitgerrit; public class Main { public static void main(String[] args) { Controller controller = new Controller(); controller.start(); } } 

7. एक्सरसाइज: आरएसएस फ़ीड से एक्सएमएल रिस्पॉन्स को कन्वर्ट करने के लिए रेट्रोफिट का उपयोग करना

यह अनुभाग बताता है कि सिम्पलेक्स XMLConverter का उपयोग करके एक्सएमएल प्रतिक्रिया को बदलने के लिए रेट्रोफिट का उपयोग कैसे करें

एक न्यूनतम जावा एप्लिकेशन बनाया जाता है जो वोगेला आरएसएस फ़ीड ( http://vogella.com/article.rss ) का अनुरोध करता है और चैनल का नाम, शीर्षक और लेख लिंक प्रिंट करता है।

7.1। प्रोजेक्ट बनाना और स्थापित करना

यह अभ्यास मानता है कि आप ग्रहण के लिए ग्रैडल और बिल्डशिप से परिचित हैं।

Com.vogella.java.retrofitxml नाम से एक नया ग्रेडल प्रोजेक्ट बनाएं। Com.vogella.java.retrofitxml नाम के src / main / java में एक नया पैकेज जोड़ें।

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

 implementation 'com.squareup.retrofit2:retrofit:2.1.0' implementation 'com.squareup.retrofit2:converter-simplexml:2.1.0' 

7.2। एक XML दृश्य परिभाषित करना

एक आरएसएस फ़ीड इस प्रकार है:

 <?xml version="1.0" encoding="UTF-8"?> <rss version="2.0"> <channel> <title>Eclipse and Android Information</title> <link>http://www.vogella.com</link> <description>Eclipse and Android Information</description> <language>en</language> <copyright>Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Germany (CC BY-NC-SA 3.0)</copyright> <pubDate>Tue, 03 May 2016 11:46:11 +0200</pubDate> <item> <title>Android user interface testing with Espresso - Tutorial</title> <description> This tutorial describes how to test Android applications with the Android Espresso testing framework.</description> <link>http://www.vogella.com/tutorials/AndroidTestingEspresso/article.html</link> <author>lars.vogel@vogella.com (Lars Vogel)</author> <guid>http://www.vogella.com/tutorials/AndroidTestingEspresso/article.html</guid> </item> <item> <title>Using the Gradle build system in the Eclipse IDE - Tutorial</title> <description>This article describes how to use the Gradle tooling in Eclipse</description> <link>http://www.vogella.com/tutorials/EclipseGradle/article.html</link> <author>lars.vogel@vogella.com (Lars Vogel)</author> <guid>http://www.vogella.com/tutorials/EclipseGradle/article.html</guid> </item> <item> <title>Unit tests with Mockito - Tutorial</title> <description>This tutorial explains testing with the Mockito framework for writting software tests.</description> <link>http://www.vogella.com/tutorials/Mockito/article.html</link> <author>lars.vogel@vogella.com (Lars Vogel)</author> <guid>http://www.vogella.com/tutorials/Mockito/article.html</guid> </item> </channel> </rss> 

XML हेडर के अलावा, इस फ़ाइल में विभिन्न XML तत्व होते हैं। एक आरएसएस तत्व में एक चैनल तत्व होता है जिसमें अन्य तत्व होते हैं (उदाहरण के लिए, शीर्षक, विवरण, पबडेट) और कई आइटम तत्व (लेख)।

निम्नलिखित दो डेटा कक्षाएं बनाएँ: RSSFeed और अनुच्छेद।

 package com.vogella.java.retrofitxml; import org.simpleframework.xml.Element; import org.simpleframework.xml.Root; @Root(name = "item", strict = false) public class Article { @Element(name = "title") private String title; @Element(name = "link") private String link; public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public String getLink() { return link; } public void setLink(String link) { this.link = link; } } 

 package com.vogella.java.retrofitxml; import java.util.List; import org.simpleframework.xml.Element; import org.simpleframework.xml.ElementList; import org.simpleframework.xml.Path; import org.simpleframework.xml.Root; @Root(name="rss", strict=false) public class RSSFeed { @Element(name="title") @Path("channel") private String channelTitle; @ElementList(name="item", inline=true) @Path("channel") private List<Article> articleList; public String getChannelTitle() { return channelTitle; } public void setChannelTitle(String channelTitle) { this.channelTitle = channelTitle; } public List<Article> getArticleList() { return articleList; } public void setArticleList(List<Article> articleList) { this.articleList = articleList; } } 

अनुच्छेद वर्ग एक लेख का प्रतिनिधित्व करता है और केवल शीर्षक और लेख के लिंक को बरकरार रखता है। ये एकमात्र ऐसे क्षेत्र हैं जो हमारी रुचि रखते हैं।

एनोटेशन @ रूट एक वर्ग को (डी) क्रमांकन के विषय के रूप में चिह्नित करता है। वैकल्पिक रूप से, आप @ रूट एनोटेशन में एक नाम निर्दिष्ट कर सकते हैं जो XML तत्व के नाम से मेल खाता है। यदि कोई नाम निर्दिष्ट नहीं है, तो वर्ग नाम का उपयोग XML तत्व के नाम के रूप में किया जाता है। चूंकि वर्ग नाम (RSSFeed) XML तत्व नाम (rss) से अलग है, हमें नाम निर्दिष्ट करने की आवश्यकता है।

जब सख्त को गलत पर सेट किया जाता है, तो सख्त पार्सिंग अक्षम हो जाती है। यह पार्सर को बताता है कि एक्सएमएल तत्व या विशेषता पाए जाने पर कोई अपवाद नहीं मिलता है, जिसके लिए कोई मैपिंग प्रदान नहीं की जाती है। चूँकि rss एलिमेंट में एक वर्जन विशेषता होती है जिसके लिए संबंधित क्षेत्र नहीं होता है, यदि सख्त पैरामीटर गलत पर सेट नहीं किया जाता है तो एप्लिकेशन एक त्रुटि उत्पन्न करेगा।

@ तत्व एनोटेशन का उपयोग करते हुए, एक XML तत्व का प्रतिनिधित्व किया जाता है। यदि आवश्यक हो, तो आप इस फ़ील्ड द्वारा दर्शाए गए तत्व का XML नाम निर्दिष्ट कर सकते हैं। यदि कोई नाम निर्दिष्ट नहीं है, तो फ़ील्ड नाम का उपयोग किया जाता है।

ArticleList फ़ील्ड को @ ElementList के साथ एनोटेट किया गया है। इससे पता चलता है कि इस फ़ील्ड का उपयोग XML तत्वों के संग्रह (हमारे मामले में: सूची) को उसी नाम से संग्रहीत करने के लिए किया जाता है। जब इनलाइन को सही पर सेट किया जाता है, तो इसका मतलब है कि संग्रह में आइटम को निर्दिष्ट आइटम के अंदर एक के बाद एक सूचीबद्ध किया गया है और एक मध्यवर्ती माता-पिता नहीं है।

@ पथ एनोटेशन का उपयोग करके, आप XML ट्री के भीतर किसी XML तत्व के लिए पथ निर्दिष्ट कर सकते हैं। यह उपयोगी है यदि आप जावा ऑब्जेक्ट के साथ एक पूर्ण XML ट्रीड मॉडल नहीं करना चाहते हैं। चैनल और कई आइटम-तत्वों के नाम के लिए, हम सीधे चैनल-तत्व में विशिष्ट तत्वों को इंगित कर सकते हैं।

7.3। एक एपीआई और रेट्रोफिट एडाप्टर को परिभाषित करना

निम्नलिखित इंटरफ़ेस के माध्यम से रेट्रोफिट के लिए REST API को परिभाषित करें।

 package com.vogella.java.retrofitxml; import retrofit2.Call; import retrofit2.http.GET; public interface VogellaAPI { @GET("article.rss") Call<RSSFeed> loadRSSFeed(); } 

निम्न नियंत्रक वर्ग बनाएँ। यह वर्ग एक रेट्रोफिट क्लाइंट बनाता है, वोगेला एपीआई को कॉल करता है, और परिणाम को संसाधित करता है।

 package com.vogella.java.retrofitxml; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import retrofit2.Retrofit; import retrofit2.converter.simplexml.SimpleXmlConverterFactory; public class Controller implements Callback<RSSFeed> { static final String BASE_URL = "http://vogella.com/"; public void start() { Retrofit retrofit = new Retrofit.Builder().baseUrl(BASE_URL) .addConverterFactory(SimpleXmlConverterFactory.create()).build(); VogellaAPI vogellaAPI = retrofit.create(VogellaAPI.class); Call<RSSFeed> call = vogellaAPI.loadRSSFeed(); call.enqueue(this); } @Override public void onResponse(Call<RSSFeed> call, Response<RSSFeed> response) { if (response.isSuccessful()) { RSSFeed rss = response.body(); System.out.println("Channel title: " + rss.getChannelTitle()); rss.getArticleList().forEach( article -> System.out.println("Title: " + article.getTitle() + " Link: " + article.getLink())); } else { System.out.println(response.errorBody()); } } @Override public void onFailure(Call<RSSFeed> call, Throwable t) { t.printStackTrace(); } } 

अंतिम चरण नियंत्रक को शुरू करने के लिए एक मुख्य विधि के साथ एक वर्ग बनाना है।

 package com.vogella.java.retrofitxml; public class Application { public static void main(String[] args) { Controller ctrl = new Controller(); ctrl.start(); } } 

8. व्यायाम: StackOverflow के लिए एक आवेदन पत्र बनाना

StackOverflow प्रोग्रामिंग से संबंधित मुद्दों के लिए एक लोकप्रिय साइट है। यह एक REST API भी प्रदान करता है, जो Stackoverflow API पेज पर अच्छी तरह से प्रलेखित है।

इस अभ्यास में आप REST रेट्रोफिट लाइब्रेरी का उपयोग करेंगे। आप इसका उपयोग StackOverflow टैग प्रश्नों और उनके उत्तरों को क्वेरी करने के लिए करेंगे।

हमारे उदाहरण में, हम निम्नलिखित अनुरोध URL का उपयोग करते हैं। इस URL को ब्राउज़र में खोलें और उत्तर देखें।

 https://api.stackexchange.com/2.2/search?order=desc&sort=votes&tagged=android&site=stackoverflow 

8.1। प्रोजेक्ट बनाना और स्थापित करना

Com.vogella.android.stackoverflow नामक एक Android ऐप बनाएं। शीर्ष स्तर के पैकेज के नाम के रूप में com.vogella.android.stackoverflow का उपयोग करें।

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

 compile "com.android.support:recyclerview-v7:25.3.1" compile 'com.google.code.gson:gson:2.8.1' 

8.2। डेटा मॉडल बनाना

हम Stackoverflow से सवाल और जवाब में रुचि रखते हैं। इस प्रयोजन के लिए, निम्नलिखित दो डेटा कक्षाएं बनाएं।

 package com.vogella.android.stackoverflow; import com.google.gson.annotations.SerializedName; public class Question { public String title; public String body; @SerializedName("question_id") public String questionId; @Override public String toString() { return(title); } } 

 package com.vogella.android.stackoverflow; import com.google.gson.annotations.SerializedName; public class Answer { @SerializedName("answer_id") public int answerId; @SerializedName("is_accepted") public boolean accepted; public int score; @Override public String toString() { return answerId + " - Score: " + score + " - Accepted: " + (accepted ? "Yes" : "No"); } } 

8.3। गतिविधि और लेआउट बनाना

अपनी गतिविधि के लिए activity_main.xml सेट करें।

 <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/activity_main" android:layout_width="match_parent" android:layout_height="match_parent" android:layout_margin="8dp" android:orientation="vertical" tools:context="com.vogella.android.stackoverflow.MainActivity"> <Spinner android:id="@+id/questions_spinner" android:layout_width="match_parent" android:layout_height="wrap_content" /> <android.support.v7.widget.RecyclerView android:id="@+id/list" android:layout_width="match_parent" android:layout_height="0dp" android:layout_weight="1" /> <Button android:id="@+id/authenticate_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="onClick" android:text="Authenticate" /> </LinearLayout> 

एडेप्टर रिसाइकलर व्यू क्लास को अपने प्रोजेक्ट में RecyclerViewAdapter नाम दें।

एक संभावित कार्यान्वयन इस प्रकार है।

 package com.vogella.android.stackoverflow; import android.support.v7.widget.RecyclerView; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; import android.widget.TextView; import java.util.List; public class RecyclerViewAdapter extends RecyclerView.Adapter<RecyclerViewAdapter.ViewHolder> { private List<Answer> data; public class ViewHolder extends RecyclerView.ViewHolder { public TextView text; public ViewHolder(View v) { super(v); text = (TextView) v.findViewById(android.R.id.text1); } } public RecyclerViewAdapter(List<Answer> data) { this.data = data; } @Override public RecyclerViewAdapter.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { View v; v = LayoutInflater.from(parent.getContext()).inflate(android.R.layout.simple_selectable_list_item, parent, false); return new ViewHolder(v); } @Override public void onBindViewHolder(RecyclerViewAdapter.ViewHolder holder, int position) { Answer answer = ((Answer) data.get(position)); holder.text.setText(answer.toString()); holder.itemView.setTag(answer.answerId); } @Override public int getItemCount() { return data.size(); } } 

निम्नानुसार MainActivity क्लास को संशोधित करें:

 package com.vogella.android.stackoverflow; import android.app.Activity; import android.content.Intent; import android.os.Bundle; import android.support.v7.widget.LinearLayoutManager; import android.support.v7.widget.RecyclerView; import android.util.Log; import android.view.View; import android.widget.AdapterView; import android.widget.ArrayAdapter; import android.widget.Button; import android.widget.Spinner; import android.widget.Toast; import java.util.ArrayList; import java.util.List; public class MainActivity extends Activity implements View.OnClickListener { private String token; private Button authenticateButton; private Spinner questionsSpinner; private RecyclerView recyclerView; protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); questionsSpinner = (Spinner) findViewById(R.id.questions_spinner); questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() { @Override public void onItemSelected(AdapterView<?> parent, View view, int position, long id) { Toast.makeText(MainActivity.this, "Spinner item selected", Toast.LENGTH_LONG).show(); } @Override public void onNothingSelected(AdapterView<?> parent) { } }); authenticateButton = (Button) findViewById(R.id.authenticate_button); recyclerView = (RecyclerView) findViewById(R.id.list); recyclerView.setHasFixedSize(true); recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this)); } @Override protected void onResume() { super.onResume(); if (token != null) { authenticateButton.setEnabled(false); } } @Override public void onClick(View v) { switch (v.getId()) { case android.R.id.text1: if (token != null) { // TODO } else { Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show(); } break; case R.id.authenticate_button: // TODO break; } } @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { if (resultCode == RESULT_OK && requestCode == 1) { token = data.getStringExtra("token"); } } } 

8.4। एक नकली डेटा प्रदाता का उपयोग करना

एक नकली डेटा प्रदाता बनाएं और स्पिनर को नकली सवालों के साथ भरें और नकली उत्तरों के साथ पुनर्नवीनीकरण करें (स्पिनर में चयन बदलने के बाद)।

 package com.vogella.android.stackoverflow; import java.util.ArrayList; import java.util.List; public class FakeDataProvider { public static List<Question> getQuestions(){ List<Question> questions = new ArrayList<>(); for (int i = 0; i<10; i++) { Question question = new Question(); question.questionId = String.valueOf(i); question.title = String.valueOf(i); question.body = String.valueOf(i) + "Body"; questions.add(question); } return questions; } public static List<Answer> getAnswers(){ List<Answer> answers = new ArrayList<>(); for (int i = 0; i<10; i++) { Answer answer = new Answer(); answer.answerId = i; answer.accepted = false; answer.score = i; answers.add(answer); } return answers; } } 

अब इस फर्जी डेटा का उपयोग करने के लिए स्पिनर और रिसाइकलव्यू को कॉन्फ़िगर करें।

 package com.vogella.android.stackoverflow; import android.app.Activity; import android.content.Intent; import android.os.Bundle; import android.support.v7.widget.LinearLayoutManager; import android.support.v7.widget.RecyclerView; import android.view.View; import android.widget.AdapterView; import android.widget.ArrayAdapter; import android.widget.Button; import android.widget.Spinner; import android.widget.Toast; import java.util.List; public class MainActivity extends Activity implements View.OnClickListener { private String token; private Button authenticateButton; private Spinner questionsSpinner; private RecyclerView recyclerView; protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); questionsSpinner = (Spinner) findViewById(R.id.questions_spinner); questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() { @Override public void onItemSelected(AdapterView<?> parent, View view, int position, long id) { Toast.makeText(MainActivity.this, "Spinner item selected", Toast.LENGTH_LONG).show(); } @Override public void onNothingSelected(AdapterView<?> parent) { } }); List<Question> questions = FakeDataProvider.getQuestions(); ArrayAdapter<Question> arrayAdapter = new ArrayAdapter<Question>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, questions); questionsSpinner.setAdapter(arrayAdapter); authenticateButton = (Button) findViewById(R.id.authenticate_button); recyclerView = (RecyclerView) findViewById(R.id.list); recyclerView.setHasFixedSize(true); recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this)); List<Answer> answers = FakeDataProvider.getAnswers(); RecyclerViewAdapter adapter = new RecyclerViewAdapter(answers); recyclerView.setAdapter(adapter); } @Override protected void onResume() { super.onResume(); if (token != null) { authenticateButton.setEnabled(false); } } @Override public void onClick(View v) { switch (v.getId()) { case android.R.id.text1: if (token != null) { // TODO } else { Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show(); } break; case R.id.authenticate_button: // TODO break; } } @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { if (resultCode == RESULT_OK && requestCode == 1) { token = data.getStringExtra("token"); } } } 

8.5। ग्रेड पे निर्भरता और अनुमतियाँ जोड़ना

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

 implementation 'com.squareup.retrofit2:retrofit:2.1.0' implementation 'com.squareup.retrofit2:converter-gson:2.1.0' 

मेनिफेस्ट में इंटरनेट एक्सेस करने की अनुमति जोड़ें।

 <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.vogella.android.stackoverflow"> <uses-permission android:name="android.permission.INTERNET"/> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest> 

8.6। एक एपीआई और रेट्रोफिट एडाप्टर को परिभाषित करना

Stackoverflow API JSON ऑब्जेक्ट नाम की वस्तुओं में उत्तर या प्रश्न लपेटता है। इसे संभालने के लिए, निम्न डेटा वर्ग बनाएँ, जिन्हें ListWrapper कहा जाता है। Stackoverflow तत्वों के आवरण को संसाधित करने के लिए यह आवश्यक है। यह वर्ग एक प्रकार का पैरामीटर लेता है और बस इस प्रकार की वस्तुओं की सूची पैक करता है।

 package com.vogella.android.stackoverflow; import java.util.List; public class ListWrapper<T> { List<T> items; } 

निम्नलिखित इंटरफ़ेस के माध्यम से रेट्रोफिट के लिए REST API को परिभाषित करें।

 package com.vogella.android.stackoverflow; import java.util.List; import okhttp3.ResponseBody; import retrofit2.http.Field; import retrofit2.http.FormUrlEncoded; import retrofit2.http.GET; import retrofit2.http.POST; import retrofit2.http.Path; import retrofit2.Call; public interface StackOverflowAPI { String BASE_URL = "https://api.stackexchange.com/"; @GET("/2.2/questions?order=desc&sort=votes&site=stackoverflow&tagged=android&filter=withbody") Call<ListWrapper<Question>> getQuestions(); @GET("/2.2/questions/{id}/answers?order=desc&sort=votes&site=stackoverflow") Call<ListWrapper<Answer>> getAnswersForQuestion(@Path("id") String questionId); } 

8.7। गतिविधि सेटिंग

निम्नानुसार MainActivity कोड बदलें।

 package com.vogella.android.stackoverflow; import android.app.Activity; import android.content.Intent; import android.os.Bundle; import android.support.v7.widget.LinearLayoutManager; import android.support.v7.widget.RecyclerView; import android.util.Log; import android.view.View; import android.widget.AdapterView; import android.widget.ArrayAdapter; import android.widget.Button; import android.widget.Spinner; import android.widget.Toast; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import java.util.ArrayList; import java.util.List; import okhttp3.ResponseBody; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import retrofit2.Retrofit; import retrofit2.converter.gson.GsonConverterFactory; public class MainActivity extends Activity implements View.OnClickListener { private StackOverflowAPI stackoverflowAPI; private String token; private Button authenticateButton; private Spinner questionsSpinner; private RecyclerView recyclerView; protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); questionsSpinner = (Spinner) findViewById(R.id.questions_spinner); questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() { @Override public void onItemSelected(AdapterView<?> parent, View view, int position, long id) { Question question = (Question) parent.getAdapter().getItem(position); stackoverflowAPI.getAnswersForQuestion(question.questionId).enqueue(answersCallback); } @Override public void onNothingSelected(AdapterView<?> parent) { } }); authenticateButton = (Button) findViewById(R.id.authenticate_button); recyclerView = (RecyclerView) findViewById(R.id.list); recyclerView.setHasFixedSize(true); recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this)); createStackoverflowAPI(); stackoverflowAPI.getQuestions().enqueue(questionsCallback); } @Override protected void onResume() { super.onResume(); if (token != null) { authenticateButton.setEnabled(false); } } private void createStackoverflowAPI() { Gson gson = new GsonBuilder() .setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ") .create(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(StackOverflowAPI.BASE_URL) .addConverterFactory(GsonConverterFactory.create(gson)) .build(); stackoverflowAPI = retrofit.create(StackOverflowAPI.class); } @Override public void onClick(View v) { switch (v.getId()) { case android.R.id.text1: if (token != null) { //TODO } else { Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show(); } break; case R.id.authenticate_button: // TODO break; } } @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { if (resultCode == RESULT_OK && requestCode == 1) { token = data.getStringExtra("token"); } } Callback<ListWrapper<Question>> questionsCallback = new Callback<ListWrapper<Question>>() { @Override public void onResponse(Call<ListWrapper<Question>> call, Response<ListWrapper<Question>> response) { if (response.isSuccessful()) { ListWrapper<Question> questions = response.body(); ArrayAdapter<Question> arrayAdapter = new ArrayAdapter<Question>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, questions.items); questionsSpinner.setAdapter(arrayAdapter); } else { Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message()); } } @Override public void onFailure(Call<ListWrapper<Question>> call, Throwable t) { t.printStackTrace(); } }; Callback<ListWrapper<Answer>> answersCallback = new Callback<ListWrapper<Answer>>() { @Override public void onResponse(Call<ListWrapper<Answer>> call, Response<ListWrapper<Answer>> response) { if (response.isSuccessful()) { List<Answer> data = new ArrayList<>(); data.addAll(response.body().items); recyclerView.setAdapter(new RecyclerViewAdapter(data)); } else { Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message()); } } @Override public void onFailure(Call<ListWrapper<Answer>> call, Throwable t) { t.printStackTrace(); } }; Callback<ResponseBody> upvoteCallback = new Callback<ResponseBody>() { @Override public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) { if (response.isSuccessful()) { Toast.makeText(MainActivity.this, "Upvote successful", Toast.LENGTH_LONG).show(); } else { Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message()); Toast.makeText(MainActivity.this, "You already upvoted this answer", Toast.LENGTH_LONG).show(); } } @Override public void onFailure(Call<ResponseBody> call, Throwable t) { t.printStackTrace(); } }; } 

8.8। वैकल्पिक: उपयोगकर्ता प्रोफ़ाइल छवि प्राप्त करना

उपयोगकर्ता प्रोफ़ाइल छवि को प्रदर्शित करने के लिए पुनरावर्ती दृश्य में लाइनों के लेआउट को बदलें। प्रश्न का उत्तर देने वाले उपयोगकर्ता का प्रोफ़ाइल चित्र प्राप्त करने के लिए अपने डेटा मॉडल का विस्तार करें। लेआउट लाइनों में एक ImageView जोड़ें और छवि को लोड करने के लिए ग्लाइड लाइब्रेरी का उपयोग करें।

8.9। वैकल्पिक: सम और विषम रेखाओं के लिए अलग-अलग लेआउट का उपयोग करें

समान और विषम रेखाओं के लिए अलग-अलग लेआउट का उपयोग करने के लिए एडेप्टर कार्यान्वयन को बदलें।

इसके लिए डेटा प्रकार के आधार पर विभिन्न लेआउट के निर्माण की आवश्यकता होती है। एडेप्टर में getItemViewType () का उपयोग करें।

8.10। वैकल्पिक: नेटवर्क त्रुटि हैंडलिंग

यदि आप एक नेटवर्क विफलता का अनुभव करते हैं, तो मुख्य उपयोगकर्ता इंटरफ़ेस के बजाय पुनः अनुरोध बटन दिखाएं।

9. व्यायाम: Android पर GitHub API एक्सेस करने के लिए रेट्रोफिट का उपयोग करना

यह अभ्यास बताता है कि रिट्रोफिट का उपयोग करके एंड्रॉइड ऐप में उपयोगकर्ता के लिए सभी GitHub रिपॉजिटरी को कैसे सूचीबद्ध किया जाए। आप ड्रॉप-डाउन सूची से रिपॉजिटरी का चयन कर सकते हैं और चयनित रिपॉजिटरी के लिए उपयोगकर्ता से संबंधित चर्चाओं को निर्दिष्ट कर सकते हैं।

फिर आप अतिरिक्त ड्रॉप-डाउन फ़ील्ड से चर्चा का चयन कर सकते हैं और उस पर एक टिप्पणी पोस्ट कर सकते हैं। प्रमाणीकरण के लिए क्रेडेंशियल दर्ज करने के लिए DialogFragment का उपयोग किया जाएगा।

सुनिश्चित करें कि आपके पास जीथब खाता है, क्योंकि यह इस अभ्यास के लिए आवश्यक है। चूंकि इस अभ्यास के दौरान RxJava2 के साथ रेट्रोफिट का उपयोग किया जाएगा, इसलिए RxJava2 ट्यूटोरियल पर भी ध्यान दें ।

9.1। प्रोजेक्ट सेटअप

एक एंड्रॉइड ऐप बनाएं, जिसे रेट्रोफिट जीथब कहा जाता है। शीर्ष स्तर के पैकेज के नाम के रूप में com.vogella.android.retrofitgithub का उपयोग करें और एक खाली टेम्पलेट का उपयोग करें। सुनिश्चित करें कि "पश्चगामी संगतता" ध्वज की जाँच की गई है।

Retrofit और RxJava2 CallAdapter का उपयोग करने के लिए, बिल्ड.gradle फ़ाइल में निम्न निर्भरताएँ जोड़ें

 implementation 'com.squareup.retrofit2:retrofit:2.3.0' implementation 'com.squareup.retrofit2:converter-gson:2.3.0' implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0' implementation 'io.reactivex.rxjava2:rxandroid:2.0.1' 

मेनिफेस्ट में इंटरनेट एक्सेस करने की अनुमति जोड़ें।

 <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.vogella.android.retrofitgithub"> <uses-permission android:name="android.permission.INTERNET"/> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name="com.vogella.android.retrofitgithub.MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest> 

9.2। एपीआई परिभाषा

निम्नलिखित दो डेटा वर्ग बनाएँ: GithubIssue और GithubRepo।

 package com.vogella.android.retrofitgithub; import com.google.gson.annotations.SerializedName; public class GithubIssue { String id; String title; String comments_url; @SerializedName("body") String comment; @Override public String toString() { return id + " - " + title; } } 

 package com.vogella.android.retrofitgithub; public class GithubRepo { String name; String owner; String url; @Override public String toString() { return(name + " " + url); } } 

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

हम ड्रॉप-डाउन फ़ील्ड में केवल आईडी और चर्चा का शीर्षक दिखाते हैं, इसलिए हम उनमें से प्रत्येक के लिए एक फ़ील्ड बनाते हैं। इसके अलावा, Github की प्रतिक्रिया में टिप्पणी पोस्ट करने के लिए एक URL है, जो टिप्पणियों_url फ़ील्ड में संग्रहीत है। बाद में Github API पर एक नई टिप्पणी पोस्ट करने के लिए, टिप्पणी नामक फ़ील्ड जोड़ें। जीठूब आपीइंगित करता है कि टिप्पणी की सामग्री JSON अनुरोध में निकाय नामक फ़ील्ड से बंधी होनी चाहिए। चूंकि रेट्रोफिट (डी) उनके नाम के आधार पर सभी क्षेत्रों को क्रमबद्ध करता है, और चूंकि हम शरीर को अपने जीथ्यूबआईसाइड्स वर्ग में फ़ील्ड नाम के रूप में उपयोग नहीं करना चाहते हैं, इसलिए हम @SerializedName एनोटेशन का उपयोग करते हैं। इस एनोटेशन के साथ, हम उस नाम को बदल सकते हैं जिसके साथ क्षेत्र JSON के लिए अनुक्रमित (डी) है।

दुर्भाग्य से, GithubRepo वर्ग भंडार के बारे में सभी आवश्यक जानकारी का अनुरोध करने के लिए पर्याप्त नहीं है। जैसा कि आप यहां देख रहे हैंरिपॉजिटरी का मालिक रिपॉजिटरी प्रतिक्रिया में एक अलग JSON ऑब्जेक्ट है, और इसलिए आमतौर पर सीरीज़ के लिए उपयुक्त जावा क्लास की आवश्यकता होती है। सौभाग्य से, रेट्रोफ़िट आपको एक विशिष्ट प्रकार के डीरियलाइज़ेशन को नियंत्रित करने के लिए अपने स्वयं के टाइप किए गए JSONDeserializer को जोड़ने की अनुमति देता है। हर बार एक निश्चित प्रकार के ऑब्जेक्ट को deserialized करने की आवश्यकता होती है, इस कस्टम deserializer का उपयोग किया जाता है।

ऐसा करने के लिए, निम्न GithubRepoDeserialzer वर्ग जोड़ें।

 package com.vogella.android.retrofitgithub; import com.google.gson.JsonDeserializationContext; import com.google.gson.JsonDeserializer; import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.JsonParseException; import java.lang.reflect.Type; public class GithubRepoDeserializer implements JsonDeserializer<GithubRepo> { @Override public GithubRepo deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException { GithubRepo githubRepo = new GithubRepo(); JsonObject repoJsonObject = json.getAsJsonObject(); githubRepo.name = repoJsonObject.get("name").getAsString(); githubRepo.url = repoJsonObject.get("url").getAsString(); JsonElement ownerJsonElement = repoJsonObject.get("owner"); JsonObject ownerJsonObject = ownerJsonElement.getAsJsonObject(); githubRepo.owner = ownerJsonObject.get("login").getAsString(); return githubRepo; } } 

निम्नलिखित इंटरफ़ेस के माध्यम से रेट्रोफिट के लिए REST API परिभाषित करें:

 package com.vogella.android.retrofitgithub; import java.util.List; import io.reactivex.Single; import okhttp3.ResponseBody; import retrofit2.http.Body; import retrofit2.http.GET; import retrofit2.http.POST; import retrofit2.http.Path; import retrofit2.http.Url; public interface GithubAPI { String ENDPOINT = "https://api.github.com"; @GET("user/repos?per_page=100") Single<List<GithubRepo>> getRepos(); @GET("/repos/{owner}/{repo}/issues") Single<List<GithubIssue>> getIssues(@Path("owner") String owner, @Path("repo") String repository); @POST Single<ResponseBody> postComment(@Url String url, @Body GithubIssue issue); } 

आपके पास @ Url एनोटेशन के बारे में एक प्रश्न हो सकता है। इस एनोटेशन का उपयोग करके, हम इस अनुरोध के लिए URL निर्दिष्ट कर सकते हैं। यह हमें गतिशील रूप से प्रत्येक अनुरोध के लिए URL बदलने की अनुमति देता है। हमें GithubIssue वर्ग के comments_url फ़ील्ड के लिए इसकी आवश्यकता है।

@ पथ एनोटेशन अनुरोध URL में संबंधित वैरिएबल (घुंघराले ब्रेस) के पैरामीटर मान को बांधते हैं। मालिक को और रिपॉजिटरी के नाम को इंगित करना आवश्यक है, जिसके लिए विचार-विमर्श का अनुरोध किया जाना चाहिए।

9.3। क्रेडेंशियल डायलॉग बॉक्स बनाएं

उपयोगकर्ता को अपने क्रेडेंशियल्स को एप्लिकेशन में संग्रहीत करने की क्षमता देने के लिए, DialogFragment का उपयोग किया जाता है। इसलिए क्रेडेंशियलडायलॉग नामक निम्न वर्ग बनाएं, और संसाधन लेआउट फ़ोल्डर में डायलॉग_सीडेंशियलएक्सएक्सएमएल नामक एक लेआउट फ़ाइल भी जोड़ें।

परिणाम निम्न स्क्रीनशॉट की तरह कुछ दिखना चाहिए।

 <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical"> <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:layout_marginBottom="8dp" android:layout_marginLeft="16dp" android:layout_marginRight="16dp" android:layout_marginTop="16dp" android:text="Fill you credentials here" /> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginLeft="16dp" android:layout_marginRight="16dp" android:orientation="horizontal"> <TextView android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="0.3" android:text="Username:" /> <EditText android:id="@+id/username_edittext" android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="0.7" /> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginLeft="16dp" android:layout_marginRight="16dp" android:orientation="horizontal"> <TextView android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="0.3" android:text="Password" /> <EditText android:id="@+id/password_edittext" android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="0.7" android:inputType="textPassword" /> </LinearLayout> </LinearLayout> 

 package com.vogella.android.retrofitgithub; import android.app.Dialog; import android.content.Context; import android.content.DialogInterface; import android.os.Bundle; import android.support.annotation.NonNull; import android.support.v4.app.DialogFragment; import android.support.v7.app.AlertDialog; import android.view.View; import android.widget.EditText; import okhttp3.Credentials; public class CredentialsDialog extends DialogFragment { EditText usernameEditText; EditText passwordEditText; ICredentialsDialogListener listener; public interface ICredentialsDialogListener { void onDialogPositiveClick(String username, String password); } @Override public void onAttach(Context context) { super.onAttach(context); if (getActivity() instanceof ICredentialsDialogListener) { listener = (ICredentialsDialogListener) getActivity(); } } @NonNull @Override public Dialog onCreateDialog(Bundle savedInstanceState) { View view = getActivity().getLayoutInflater().inflate(R.layout.dialog_credentials, null); usernameEditText = (EditText) view.findViewById(R.id.username_edittext); passwordEditText = (EditText) view.findViewById(R.id.password_edittext); usernameEditText.setText(getArguments().getString("username")); passwordEditText.setText(getArguments().getString("password")); AlertDialog.Builder builder = new AlertDialog.Builder(getActivity()) .setView(view) .setTitle("Credentials") .setNegativeButton("Cancel", null) .setPositiveButton("Continue", new DialogInterface.OnClickListener() { @Override public void onClick(DialogInterface dialog, int which) { if (listener != null) { listener.onDialogPositiveClick(usernameEditText.getText().toString(), passwordEditText.getText().toString()); } } }); return builder.create(); } } 

9.4। गतिविधि बनाएँ

इस प्रकार से गतिविधि_main.xml संशोधित करें।

 <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/activity_main" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" tools:context="com.vogella.android.retrofitgithub.MainActivity"> <android.support.v7.widget.Toolbar android:id="@+id/my_toolbar" android:layout_width="match_parent" android:layout_height="?attr/actionBarSize" android:background="?attr/colorPrimary" android:elevation="4dp" /> <RelativeLayout android:layout_width="match_parent" android:layout_height="match_parent" android:paddingBottom="@dimen/activity_vertical_margin" android:paddingLeft="@dimen/activity_horizontal_margin" android:paddingRight="@dimen/activity_horizontal_margin" android:paddingTop="@dimen/activity_vertical_margin"> <Spinner android:id="@+id/repositories_spinner" android:layout_width="match_parent" android:layout_height="wrap_content" /> <Spinner android:id="@+id/issues_spinner" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_below="@id/repositories_spinner" /> <EditText android:id="@+id/comment_edittext" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_below="@id/issues_spinner" android:enabled="false" android:hint="Your comment" android:imeOptions="actionDone" android:inputType="text" android:maxLines="1" /> <Button android:id="@+id/loadRepos_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_alignParentBottom="true" android:enabled="false" android:gravity="center" android:onClick="onClick" android:text="Load user repositories" /> <Button android:id="@+id/send_comment_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_above="@id/loadRepos_button" android:enabled="false" android:onClick="onClick" android:text="Send comment" /> </RelativeLayout> </LinearLayout> 

दो बटन (रिपॉजिटरी डाउनलोड करने और टिप्पणियां भेजने के लिए), दो स्पिनर (रिपॉजिटरी और चर्चा प्रदर्शित करने के लिए ड्रॉप-डाउन फ़ील्ड) और एडिट टेक्स्ट (टिप्पणी लिखने के लिए)। क्रेडेंशियलडायलॉग लॉन्च करने के लिए, एंड्रॉइड टूलबार पर मेनू का उपयोग करें। इसे बनाने के लिए, मेनू रिसोर्स फ़ोल्डर में menu_main.xml नामक एक मेनू xml फ़ाइल जोड़ें (यदि यह मौजूद नहीं है तो एक फ़ोल्डर बनाएं)।

 <?xml version="1.0" encoding="utf-8"?> <menu xmlns:android="http://schemas.android.com/apk/res/android"> <item android:id="@+id/menu_credentials" android:title="Credentials"/> </menu> 

चूंकि हम टूलबार विजेट का उपयोग करते हैं, इसलिए आपको कार्रवाई बार को डिफ़ॉल्ट रूप से अक्षम करना होगा। ऐसा करने के लिए, नीचे दिखाए गए अनुसार xml शैली फ़ाइल को संशोधित करें।

 <resources> <style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar"> <item name="colorPrimary">@color/colorPrimary</item> <item name="colorPrimaryDark">@color/colorPrimaryDark</item> <item name="colorAccent">@color/colorAccent</item> </style> </resources> 

अपनी गतिविधि कोड को निम्न में बदलें।

 package com.vogella.android.retrofitgithub; import android.os.Bundle; import android.support.v7.app.AppCompatActivity; import android.support.v7.widget.Toolbar; import android.view.Menu; import android.view.MenuItem; import android.view.View; import android.widget.AdapterView; import android.widget.ArrayAdapter; import android.widget.Button; import android.widget.EditText; import android.widget.Spinner; import android.widget.Toast; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import java.io.IOException; import java.util.List; import io.reactivex.android.schedulers.AndroidSchedulers; import io.reactivex.disposables.CompositeDisposable; import io.reactivex.observers.DisposableSingleObserver; import io.reactivex.schedulers.Schedulers; import okhttp3.Credentials; import okhttp3.Interceptor; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.ResponseBody; import retrofit2.Call; import retrofit2.Retrofit; import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory; import retrofit2.converter.gson.GsonConverterFactory; public class MainActivity extends AppCompatActivity implements CredentialsDialog.ICredentialsDialogListener { GithubAPI githubAPI; String username; String password; Spinner repositoriesSpinner; Spinner issuesSpinner; EditText commentEditText; Button sendButton; Button loadReposButtons; private CompositeDisposable compositeDisposable = new CompositeDisposable(); @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); Toolbar toolbar = (Toolbar) findViewById(R.id.my_toolbar); setSupportActionBar(toolbar); sendButton = (Button) findViewById(R.id.send_comment_button); repositoriesSpinner = (Spinner) findViewById(R.id.repositories_spinner); repositoriesSpinner.setEnabled(false); repositoriesSpinner.setAdapter(new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, new String[]{"No repositories available"})); repositoriesSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() { @Override public void onItemSelected(AdapterView<?> parent, View view, int position, long id) { if (parent.getSelectedItem() instanceof GithubRepo) { GithubRepo githubRepo = (GithubRepo) parent.getSelectedItem(); compositeDisposable.add(githubAPI.getIssues(githubRepo.owner, githubRepo.name) .subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribeWith(getIssuesObserver())); } } @Override public void onNothingSelected(AdapterView<?> parent) { } }); issuesSpinner = (Spinner) findViewById(R.id.issues_spinner); issuesSpinner.setEnabled(false); issuesSpinner.setAdapter(new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, new String[]{"Please select repository"})); commentEditText = (EditText) findViewById(R.id.comment_edittext); loadReposButtons = (Button) findViewById(R.id.loadRepos_button); createGithubAPI(); } @Override protected void onStop() { super.onStop(); if (compositeDisposable != null && !compositeDisposable.isDisposed()) { compositeDisposable.dispose(); } } @Override public boolean onCreateOptionsMenu(Menu menu) { getMenuInflater().inflate(R.menu.menu_main, menu); return true; } @Override public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case R.id.menu_credentials: showCredentialsDialog(); return true; } return super.onOptionsItemSelected(item); } private void showCredentialsDialog() { CredentialsDialog dialog = new CredentialsDialog(); Bundle arguments = new Bundle(); arguments.putString("username", username); arguments.putString("password", password); dialog.setArguments(arguments); dialog.show(getSupportFragmentManager(), "credentialsDialog"); } private void createGithubAPI() { Gson gson = new GsonBuilder() .setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ") .registerTypeAdapter(GithubRepo.class, new GithubRepoDeserializer()) .create(); OkHttpClient okHttpClient = new OkHttpClient.Builder() .addInterceptor(new Interceptor() { @Override public okhttp3.Response intercept(Chain chain) throws IOException { Request originalRequest = chain.request(); Request.Builder builder = originalRequest.newBuilder().header("Authorization", Credentials.basic(username, password)); Request newRequest = builder.build(); return chain.proceed(newRequest); } }).build(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(GithubAPI.ENDPOINT) .client(okHttpClient) .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) .addConverterFactory(GsonConverterFactory.create(gson)) .build(); githubAPI = retrofit.create(GithubAPI.class); } public void onClick(View view) { switch (view.getId()) { case R.id.loadRepos_button: compositeDisposable.add(githubAPI.getRepos() .subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribeWith(getRepositoriesObserver())); break; case R.id.send_comment_button: String newComment = commentEditText.getText().toString(); if (!newComment.isEmpty()) { GithubIssue selectedItem = (GithubIssue) issuesSpinner.getSelectedItem(); selectedItem.comment = newComment; compositeDisposable.add(githubAPI.postComment(selectedItem.comments_url, selectedItem) .subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribeWith(getCommentObserver())); } else { Toast.makeText(MainActivity.this, "Please enter a comment", Toast.LENGTH_LONG).show(); } break; } } private DisposableSingleObserver<List<GithubRepo>> getRepositoriesObserver() { return new DisposableSingleObserver<List<GithubRepo>>() { @Override public void onSuccess(List<GithubRepo> value) { if (!value.isEmpty()) { ArrayAdapter<GithubRepo> spinnerAdapter = new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, value); repositoriesSpinner.setAdapter(spinnerAdapter); repositoriesSpinner.setEnabled(true); } else { ArrayAdapter<String> spinnerAdapter = new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, new String[]{"User has no repositories"}); repositoriesSpinner.setAdapter(spinnerAdapter); repositoriesSpinner.setEnabled(false); } } @Override public void onError(Throwable e) { e.printStackTrace(); Toast.makeText(MainActivity.this, "Can not load repositories", Toast.LENGTH_SHORT).show(); } }; } private DisposableSingleObserver<List<GithubIssue>> getIssuesObserver() { return new DisposableSingleObserver<List<GithubIssue>>() { @Override public void onSuccess(List<GithubIssue> value) { if (!value.isEmpty()) { ArrayAdapter<GithubIssue> spinnerAdapter = new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, value); issuesSpinner.setEnabled(true); commentEditText.setEnabled(true); sendButton.setEnabled(true); issuesSpinner.setAdapter(spinnerAdapter); } else { ArrayAdapter<String> spinnerAdapter = new ArrayAdapter<>(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, new String[]{"Repository has no issues"}); issuesSpinner.setEnabled(false); commentEditText.setEnabled(false); sendButton.setEnabled(false); issuesSpinner.setAdapter(spinnerAdapter); } } @Override public void onError(Throwable e) { e.printStackTrace(); Toast.makeText(MainActivity.this, "Can not load issues", Toast.LENGTH_SHORT).show(); } }; } private DisposableSingleObserver<ResponseBody> getCommentObserver() { return new DisposableSingleObserver<ResponseBody>() { @Override public void onSuccess(ResponseBody value) { commentEditText.setText(""); Toast.makeText(MainActivity.this, "Comment created", Toast.LENGTH_LONG).show(); } @Override public void onError(Throwable e) { e.printStackTrace(); Toast.makeText(MainActivity.this, "Can not create comment", Toast.LENGTH_SHORT).show(); } }; } @Override public void onDialogPositiveClick(String username, String password) { this.username = username; this.password = password; loadReposButtons.setEnabled(true); } } 

यहां हमने GsonBuilder में टाइप एडेप्टर के रूप में पहले से निर्मित GithubRepoDeserializer जोड़ा। प्रत्येक कॉल के लिए प्रमाणीकरण को संभालने के लिए, एक इंटरसेप्टर को OkHttpClient में जोड़ा गया था । RxJava2 प्रकारों को वापस करने के लिए API विधियों के लिए, हमने अपने क्लाइंट में RxJava2 CallAdapter को जोड़ा।

10. व्यायाम: एंड्रॉइड पर ट्विटर से उपयोगकर्ता जानकारी का अनुरोध करने के लिए OAuth के साथ रेट्रोफिट का उपयोग करना

यह अभ्यास बताता है कि एंड्रॉइड पर रेट्रोफिट का उपयोग करके ट्विटर तक कैसे पहुंचा जाए। हम एक एप्लिकेशन लिखेंगे जो प्रदान किए गए उपयोगकर्ता नाम के लिए उपयोगकर्ता डेटा का अनुरोध कर सकते हैं और प्रदर्शित कर सकते हैं। इस अभ्यास में, हम प्रमाणीकरण के लिए केवल OAuth 2 के साथ ट्विटर प्रमाणीकरण एप्लिकेशन का उपयोग करते हैं । इस अभ्यास को करने के लिए, आपके पास ट्विटर अकाउंट होना चाहिए। इसके अलावा, आपको अपने उपभोक्ता कुंजी और उपभोक्ता रहस्य प्राप्त करने के लिए ट्विटर ऐप पर जाने और एक नया ऐप बनाने की आवश्यकता है । हमें अपने OAuth टोकन का अनुरोध करने के लिए बाद में इसकी आवश्यकता होगी।

10.1। प्रोजेक्ट सेटअप

रिट्रोफिट ट्विटर नामक एक एंड्रॉइड ऐप बनाएं। एक शीर्ष-स्तरीय पैकेज के नाम के रूप में com.vogella.android.retrofittwitter का उपयोग करें।

Retrofit का उपयोग करने के लिए, बिल्ड.ग्रेड फ़ाइल में निम्न पंक्तियाँ जोड़ें

 implementation 'com.squareup.retrofit2:retrofit:2.1.0' implementation 'com.squareup.retrofit2:converter-gson:2.1.0' 

मेनिफेस्ट में इंटरनेट एक्सेस करने की अनुमति जोड़ें।

 <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.vogella.android.retrofittwitter"> <uses-permission android:name="android.permission.INTERNET"/> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest> 

10.2। एपीआई परिभाषा

OAuthToken और UserDetails नामक दो डेटा कक्षाएं बनाएं।

 package com.vogella.android.retrofittwitter; import com.google.gson.annotations.SerializedName; public class OAuthToken { @SerializedName("access_token") private String accessToken; @SerializedName("token_type") private String tokenType; public String getAccessToken() { return accessToken; } public String getTokenType() { return tokenType; } public String getAuthorization() { return getTokenType() + " " + getAccessToken(); } } 

 package com.vogella.android.retrofittwitter; public class UserDetails { private String name; private String location; private String description; private String url; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getLocation() { return location; } public void setLocation(String location) { this.location = location; } public String getDescription() { return description; } public void setDescription(String description) { this.description = description; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } } 

OAuthToken वर्ग का उपयोग बियर को स्टोर करने के लिए किया जाता है जिसे हम ट्विटर से अनुरोध करते हैं, अपनी कुंजी और गुप्त के साथ। हम Retrofit से (de) सीरियलाइज़ फ़ील्ड नाम सेट करने के लिए @ SerializedName एनोटेशन का उपयोग करते हैं।

उपयोगकर्ता जानकारी का अनुरोध करते समय UserDetails वर्ग केवल ट्विटर प्रतिक्रिया से कई क्षेत्रों को बचाता है। हम सभी उपयोगकर्ता डेटा नहीं दिखाते हैं जो केवल प्रतिक्रिया में निहित था, केवल नाम, स्थान, URL और विवरण।

निम्नलिखित इंटरफ़ेस के माध्यम से रेट्रोफिट के लिए REST API परिभाषित करें:

 package com.vogella.android.retrofittwitter; import retrofit2.Call; import retrofit2.http.Field; import retrofit2.http.FormUrlEncoded; import retrofit2.http.GET; import retrofit2.http.POST; import retrofit2.http.Query; public interface TwitterApi { String BASE_URL = "https://api.twitter.com/"; @FormUrlEncoded @POST("oauth2/token") Call<OAuthToken> postCredentials(@Field("grant_type") String grantType); @GET("/1.1/users/show.json") Call<UserDetails> getUserDetails(@Query("screen_name") String name); } 

10.3। गतिविधि बनाएँ

Activity_main.xml फ़ाइल और संबंधित MainActivity वर्ग को निम्नानुसार संशोधित करें:

 <?xml version="1.0" encoding="utf-8"?> <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/activity_main" android:layout_width="match_parent" android:layout_height="match_parent" tools:context="com.vogella.android.retrofittwitter.MainActivity"> <LinearLayout android:id="@+id/username_container" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_alignParentTop="true" android:orientation="horizontal"> <TextView android:id="@+id/username_textview" android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:enabled="false" android:gravity="center_vertical" android:text="Username:" /> <EditText android:id="@+id/username_edittext" android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="1" android:enabled="false" android:gravity="center" android:imeOptions="actionDone" android:inputType="text" android:maxLines="1" /> </LinearLayout> <Button android:id="@+id/request_token_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_alignParentBottom="true" android:onClick="onClick" android:text="Request token" /> <Button android:id="@+id/request_user_details_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_above="@id/request_token_button" android:enabled="false" android:onClick="onClick" android:text="Request user details" /> <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:layout_above="@id/request_user_details_button" android:layout_below="@id/username_container" android:gravity="center" android:orientation="vertical"> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:minHeight="50dp"> <TextView android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="Name:" /> <TextView android:id="@+id/name_textview" android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="---" /> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:minHeight="50dp"> <TextView android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="Location:" /> <TextView android:id="@+id/location_textview" android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="---" /> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:minHeight="50dp"> <TextView android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="Url:" /> <TextView android:id="@+id/url_textview" android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="---" /> </LinearLayout> <LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:minHeight="50dp"> <TextView android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="Description:" /> <TextView android:id="@+id/description_textview" android:layout_width="0dp" android:layout_height="match_parent" android:layout_weight="1" android:gravity="center_vertical" android:text="---" /> </LinearLayout> </LinearLayout> </RelativeLayout> 

 package com.vogella.android.retrofittwitter; import android.os.Bundle; import android.support.v7.app.AppCompatActivity; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; import android.widget.Toast; import java.io.IOException; import okhttp3.Credentials; import okhttp3.Interceptor; import okhttp3.OkHttpClient; import okhttp3.Request; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import retrofit2.Retrofit; import retrofit2.converter.gson.GsonConverterFactory; public class MainActivity extends AppCompatActivity { private String credentials = Credentials.basic("aConsumerKey", "aSecret"); Button requestTokenButton; Button requestUserDetailsButton; EditText usernameEditText; TextView usernameTextView; TextView nameTextView; TextView locationTextView; TextView urlTextView; TextView descriptionTextView; TwitterApi twitterApi; OAuthToken token; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); requestTokenButton = (Button) findViewById(R.id.request_token_button); requestUserDetailsButton = (Button) findViewById(R.id.request_user_details_button); usernameEditText = (EditText) findViewById(R.id.username_edittext); usernameTextView = (TextView) findViewById(R.id.username_textview); nameTextView = (TextView) findViewById(R.id.name_textview); locationTextView = (TextView) findViewById(R.id.location_textview); urlTextView = (TextView) findViewById(R.id.url_textview); descriptionTextView = (TextView) findViewById(R.id.description_textview); createTwitterApi(); } private void createTwitterApi() { OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(new Interceptor() { @Override public okhttp3.Response intercept(Chain chain) throws IOException { Request originalRequest = chain.request(); Request.Builder builder = originalRequest.newBuilder().header("Authorization", token != null ? token.getAuthorization() : credentials); Request newRequest = builder.build(); return chain.proceed(newRequest); } }).build(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(TwitterApi.BASE_URL) .client(okHttpClient) .addConverterFactory(GsonConverterFactory.create()) .build(); twitterApi = retrofit.create(TwitterApi.class); } public void onClick(View view) { switch (view.getId()) { case R.id.request_token_button: twitterApi.postCredentials("client_credentials").enqueue(tokenCallback); break; case R.id.request_user_details_button: String editTextInput = usernameEditText.getText().toString(); if (!editTextInput.isEmpty()) { twitterApi.getUserDetails(editTextInput).enqueue(userDetailsCallback); } else { Toast.makeText(this, "Please provide a username", Toast.LENGTH_LONG).show(); } break; } } Callback<OAuthToken> tokenCallback = new Callback<OAuthToken>() { @Override public void onResponse(Call<OAuthToken> call, Response<OAuthToken> response) { if (response.isSuccessful()) { requestTokenButton.setEnabled(false); requestUserDetailsButton.setEnabled(true); usernameTextView.setEnabled(true); usernameEditText.setEnabled(true); token = response.body(); } else { Toast.makeText(MainActivity.this, "Failure while requesting token", Toast.LENGTH_LONG).show(); Log.d("RequestTokenCallback", "Code: " + response.code() + "Message: " + response.message()); } } @Override public void onFailure(Call<OAuthToken> call, Throwable t) { t.printStackTrace(); } }; Callback<UserDetails> userDetailsCallback = new Callback<UserDetails>() { @Override public void onResponse(Call<UserDetails> call, Response<UserDetails> response) { if (response.isSuccessful()) { UserDetails userDetails = response.body(); nameTextView.setText(userDetails.getName() == null ? "no value" : userDetails.getName()); locationTextView.setText(userDetails.getLocation() == null ? "no value" : userDetails.getLocation()); urlTextView.setText(userDetails.getUrl() == null ? "no value" : userDetails.getUrl()); descriptionTextView.setText(userDetails.getDescription().isEmpty() ? "no value" : userDetails.getDescription()); } else { Toast.makeText(MainActivity.this, "Failure while requesting user details", Toast.LENGTH_LONG).show(); Log.d("UserDetailsCallback", "Code: " + response.code() + "Message: " + response.message()); } } @Override public void onFailure(Call<UserDetails> call, Throwable t) { t.printStackTrace(); } }; } 

बदलें anConsumerKey और उपभोक्ता कुंजी और गुप्त ट्विटर से प्राप्त के साथ।

इंटरसेप्टर पर भी एक नज़र डालें, जिसे हम अपने रेट्रोफिट क्लाइंट में जोड़ते हैं। क्योंकि हम OAuth का उपयोग करते हैं, हमारे क्रेडेंशियल्स प्रत्येक कॉल के लिए अलग हैं। पोस्टग्रैडिएंट्स विधि को मूल ट्विटर स्कीमा में क्रेडेंशियल्स (उपभोक्ता कुंजी और गुप्त) पोस्ट करना होगा। नतीजतन, यह कॉल एक वाहक टोकन लौटाता है, जो रेट्रोफिट हमारे OAuthToken वर्ग में deserializes, जो तब टोकन फ़ील्ड में संग्रहीत होता है। अन्य कोई भी अनुरोध (और अब) इस टोकन को प्राधिकरण के लिए क्रेडेंशियल के रूप में उपयोग कर सकता है। उपयोगकर्ता जानकारी भी अनुरोध की है।

11. रेट्रोफिट रिसोर्स

ट्यूटोरियल उपभोक्ता के साथ एपीआई का पुराना वापस

के साथ विभाग पुराना वापस के बारे में ब्लॉग श्रृंखला में

पुराना वापस के साथ एपीआई का सेवन