Retrofit 2.0 में हेडर जोड़ने के लिए इंटरसेप्टर का उपयोग कैसे करें?

Question

हमारी टीम ने रेट्रोफिट 2.0 को अपनाने का फैसला किया है और मैं इस पर कुछ प्रारंभिक शोध कर रहा हूं। मैं इस लाइब्रेरी के लिए नौसिखिया हूं।

मैं सोच रहा हूं कि अपने एंड्रॉइड ऐप में रेट्रोफिट्स 2.0 केinterceptor माध्यम से अनुकूलित हेडर कैसे जोड़ें । Retrofit 1.X में हेडर जोड़ने के लिए उपयोग करने के बारे में कई ट्यूटोरियल हैं , लेकिन चूंकि एपीआई ने नवीनतम संस्करण में बहुत कुछ बदल दिया है, मुझे यकीन नहीं है कि नए संस्करण में उन तरीकों को कैसे अनुकूलित किया जाए। इसके अलावा, रेट्रोफ़िट ने अपने नए दस्तावेज़ को अभी तक अपडेट नहीं किया है।interceptor

उदाहरण के लिए, निम्नलिखित कोड में, मुझे Interceptorअतिरिक्त हेडर जोड़ने के लिए कक्षा को कैसे लागू करना चाहिए ? इसके अलावा, वास्तव में अनिर्दिष्ट Chainवस्तु क्या है? कब intercept()बुलाया जाएगा?

    OkHttpClient client = new OkHttpClient();
    client.interceptors().add(new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Response response = chain.proceed(chain.request());

            // How to add extra headers?

            return response;
        }
    });

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(BASE_API_URL)
            .client(client)
            .addConverterFactory(GsonConverterFactory.create())
            .build();

Comments

सुनिश्चित करें कि आपका BASE_API_URL समाप्त हो गया है /और आपका API url नहीं है ( stuff/post/whatever)

— EpicPandaForce

Answer 1

इसकी जांच करें।

public class HeaderInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request()
                .newBuilder()
                .addHeader("appid", "hello")
                .addHeader("deviceplatform", "android")
                .removeHeader("User-Agent")
                .addHeader("User-Agent", "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:38.0) Gecko/20100101 Firefox/38.0")
                .build();
        Response response = chain.proceed(request);
        return response;
    }
}

Kotlin

class HeaderInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response = chain.run {
        proceed(
            request()
                .newBuilder()
                .addHeader("appid", "hello")
                .addHeader("deviceplatform", "android")
                .removeHeader("User-Agent")
                .addHeader("User-Agent", "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:38.0) Gecko/20100101 Firefox/38.0")
                .build()
        )        
    }
}

Comments

धन्यवाद!! इसलिए, intercept()हर बार आवेदन से अनुरोध भेजे जाने पर यह ट्रिगर हो जाता है? क्या हम पुनर्निर्देशन के लिए मध्यवर्ती प्रतिक्रिया को पकड़ सकते हैं, या हमें केवल अंतिम प्रतिक्रिया मिल सकती है?

— हैकजुत्सु

यह हर अनुरोध के लिए कहा जाता है, और अगर मुझे सही पता है, तो यह इसलिए है क्योंकि आप इसे इंटरसेप्टर के रूप में जोड़ते हैं, न कि नेटवर्क रिसेप्टर के रूप में। मुझे लगता है कि आप यहां केवल अंतिम प्रतिक्रिया प्राप्त कर सकते हैं, लेकिन रीडायरेक्ट को रीडायरेक्ट के रूप में देखने की अनुमति देने के लिए एक कॉन्फ़िगरेशन हो सकता है जो मुझे अपने सिर के ऊपर से पता नहीं है (http URL कनेक्शन के लिए भी एक है।)

— EpicPandaForce

बस इस लिंक का संदर्भ लें: github.com/square/okhttp/wiki/Interceptors , और मुझे जो जानकारी चाहिए वह प्राप्त करें :) धन्यवाद ~

— hackjutsu

फी, आपको इसके बजाय एक बिल्डर का उपयोग करने की आवश्यकता है client.interceptors()। यह दिखता हैnew OkHttpClient.Builder().addInterceptor(<Your Interceptor>).build()

— GL

Answer 2

स्वीकृत उत्तर से एक और विकल्प

public class HeaderInterceptor implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        request = request.newBuilder()
                .addHeader("headerKey0", "HeaderVal0")
                .addHeader("headerKey0", "HeaderVal0--NotReplaced/NorUpdated") //new header added
                .build();

        //alternative
        Headers moreHeaders = request.headers().newBuilder()
                .add("headerKey1", "HeaderVal1")
                .add("headerKey2", "HeaderVal2")
                .set("headerKey2", "HeaderVal2--UpdatedHere") // existing header UPDATED if available, else added.
                .add("headerKey3", "HeaderKey3")
                .add("headerLine4 : headerLine4Val") //line with `:`, spaces doesn't matter.
                .removeAll("headerKey3") //Oops, remove this.
                .build();

        request = request.newBuilder().headers(moreHeaders).build();

        /* ##### List of headers ##### */
        // headerKey0: HeaderVal0
        // headerKey0: HeaderVal0--NotReplaced/NorUpdated
        // headerKey1: HeaderVal1
        // headerKey2: HeaderVal2--UpdatedHere
        // headerLine4: headerLine4Val

        Response response = chain.proceed(request);
        return response;
    }
}

Comments

अच्छा! तो request.newBuilder().headers(moreHeaders).build()मूल हेडर रखेंगे?

— हैकजुट्सू

हाँ। जब तक निष्कासन (स्ट्रिंग नाम) नहीं कहा जाता है, तब तक कोई हेडर अनुरोध से नहीं हटाया जाता है।

— VenomVendor

@VenomVendor कृपया यहां एक ऐसे ही सवाल के साथ मेरी मदद करें stackoverflow.com/questions/45078720/… धन्यवाद

— user606669

क्या यह नई वस्तुएं नहीं बनाएगा?

— TheRealChx101

Answer 3

   public class ServiceFactory {  
    public static ApiClient createService(String authToken, String userName, String password) {
            OkHttpClient defaultHttpClient = new OkHttpClient.Builder()
                    .addInterceptor(
                            chain -> {
                                Request request = chain.request().newBuilder()
                                        .headers(getJsonHeader(authToken))
                                        .build();
                                return chain.proceed(request);
                            })
                    .authenticator(getBasicAuthenticator(userName, password))
                    .build();
            return getService(defaultHttpClient);
        }
        private static Headers getJsonHeader(String authToken) {
            Headers.Builder builder = new Headers.Builder();
            builder.add("Content-Type", "application/json");
            builder.add("Accept", "application/json");
            if (authToken != null && !authToken.isEmpty()) {
                builder.add("X-MY-Auth", authToken);
            }
            return builder.build();
        }
        private static Authenticator getBasicAuthenticator(final String userName, final String password) {
            return (route, response) -> {
                String credential = Credentials.basic(userName, password);
                return response.request().newBuilder().header("Authorization", credential).build();
            };
        }
          private static ApiClient getService(OkHttpClient defaultHttpClient) {
            return new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .addConverterFactory(GsonConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .client(defaultHttpClient)
                    .build()
                    .create(ApiClient.class);
        }
}

Answer 4

आप इंटरसेप्टर का उपयोग करके हेडर का उपयोग कर सकते हैं जैसे कि इसके बिल्ट-इन तरीकों से

   interceptors().add(new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request original = chain.request();

            Request.Builder builder = original.newBuilder();

            builder.header("Authorization","Bearer "+ LeafPreference.getInstance(context).getString(LeafPreference.TOKEN));

            Request request = builder.method(original.method(), original.body())
                    .build();
            Log.e("request",request.urlString());
            Log.e("header",request.header("Authorization"));
            return chain.proceed(request);
        }
    });
}

Comments

मैं जानना चाहता हूं कि इस स्थान पर आपको संदर्भ कैसे मिलते हैं ?

— रुपयाजिंदर

@rupinderjeet संभवतः final Context contextमापदंडों की सूची में है।

— TheRealChx101

@ TheRealChx101 सिर्फ यह बताना चाहता था कि हमें contextयहाँ नहीं होना चाहिए क्योंकि यह व्यावसायिक तर्क है।

— रुपयेजिंदर