Jak dodać nagłówki do przechwytywacza żądań OkHttp?

95

Mam ten przechwytywacz, który dodaję do mojego klienta OkHttp:

public class RequestTokenInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
  Request request = chain.request();
  // Here where we'll try to refresh token.
  // with an retrofit call
  // After we succeed we'll proceed our request
  Response response = chain.proceed(request);
  return response;
}
}

Jak mogę dodać nagłówki do żądania w moim przechwytywaczu?

Próbowałem tego, ale popełniam błąd i tracę żądanie podczas tworzenia nowego żądania:

    public class RequestTokenInterceptor implements Interceptor {
    @Override
    public Response intercept(Interceptor.Chain chain) throws IOException {
        Request request = chain.request();
        Request newRequest;

        try {
            Log.d("addHeader", "Before");
            String token = TokenProvider.getInstance(mContext).getToken();
            newRequest = request.newBuilder()
                    .addHeader(HeadersContract.HEADER_AUTHONRIZATION, O_AUTH_AUTHENTICATION + token)
                    .addHeader(HeadersContract.HEADER_CLIENT_ID, CLIENT_ID)
                    .build();
        } catch (Exception e) {
            Log.d("addHeader", "Error");
            e.printStackTrace();
            return chain.proceed(request);
        }

        Log.d("addHeader", "after");
        return chain.proceed(newRequest);
    }
}

Zauważ, że wiem, że mogę dodać nagłówek podczas tworzenia takiego żądania:

Request request = new Request.Builder()
    .url("https://api.github.com/repos/square/okhttp/issues")
    .header("User-Agent", "OkHttp Headers.java")
    .addHeader("Accept", "application/json; q=0.5")
    .addHeader("Accept", "application/vnd.github.v3+json")
    .build();

Ale to nie pasuje do moich potrzeb. Potrzebuję tego w przechwytywaczu.

Morteza Rastgoo
źródło
1
Twój przechwytywacz wygląda dobrze. Co z tym nie działa?
Jesse Wilson,

Odpowiedzi:

153

Na koniec dodałem nagłówki w ten sposób:

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

        newRequest = request.newBuilder()
                .addHeader(HeadersContract.HEADER_AUTHONRIZATION, O_AUTH_AUTHENTICATION)
                .addHeader(HeadersContract.HEADER_X_CLIENT_ID, CLIENT_ID)
                .build();
        return chain.proceed(newRequest);
    }
Morteza Rastgoo
źródło
1
z jakiegoś powodu to nie dodaje nagłówków do mojego żądania ?! Używam okHttp.Builder i networkInterceptors (). Add (interceptor) z tym samym kodem jak w tej odpowiedzi, ale nagłówki nie są dodawane.
Informatic0re
jak dodać nagłówek do żądania youtube? Czy to nazwa_pakietu i klucz API, a następnie przejść.addheader(params1, params2);
RoCk RoCk
@RoCk Możesz mieć oddzielnych RestClients, które mają inną konfigurację nagłówka.
Morteza Rastgoo
27

możesz to zrobić w ten sposób

private String GET(String url, Map<String, String> header) throws IOException {
        Headers headerbuild = Headers.of(header);
        Request request = new Request.Builder().url(url).headers(headerbuild).
                        build();

        Response response = client.newCall(request).execute();
        return response.body().string();
    }
gaurang
źródło
7
To nie jest przechwytywacz.
bekce
16

tutaj jest przydatna istota z lfmingo

OkHttpClient.Builder httpClient = new OkHttpClient.Builder();

httpClient.addInterceptor(new Interceptor() {

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

        Request request = original.newBuilder()
            .header("User-Agent", "Your-App-Name")
            .header("Accept", "application/vnd.yourapi.v1.full+json")
            .method(original.method(), original.body())
            .build();

        return chain.proceed(request);
    }
}

OkHttpClient client = httpClient.build();

Retrofit retrofit = new Retrofit.Builder()  
    .baseUrl(API_BASE_URL)
    .addConverterFactory(GsonConverterFactory.create())
    .client(client)
    .build();
chebaby
źródło
10

W obliczu podobnego problemu z innymi próbkami ta klasa Kotlin zadziałała dla mnie

import okhttp3.Interceptor
import okhttp3.Response

class CustomInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain) : Response {               
        val request = chain.request().newBuilder()
            .header("x-custom-header", "my-value")
            .build()
        return chain.proceed(request)
    }
}
Alex Nolasco
źródło
9

Jeśli używasz biblioteki Retrofit, możesz bezpośrednio przekazać nagłówek do żądania API za pomocą @Headeradnotacji bez użycia Interceptora. Oto przykład, który pokazuje, jak dodać nagłówek do żądania Retrofit api.

@POST(apiURL)
void methodName(
        @Header(HeadersContract.HEADER_AUTHONRIZATION) String token,
        @Header(HeadersContract.HEADER_CLIENT_ID) String token,
        @Body TypedInput body,
        Callback<String> callback);

Mam nadzieję, że to pomoże!

Rajesh
źródło
4
Wiem o tym, ale mam metodę uzyskiwania tokenu o nazwie: getToken (), który oczekuje na wątek. więc jeśli zadzwonię do tego w przechwytywaczu OkHttp, będzie działać w wątku modernizacji i nie muszę się martwić o problemy z wątkami.
Morteza Rastgoo
6

Jest jeszcze inny sposób dodawania przechwytywaczy do twojego OkHttp3 (najnowsza wersja na teraz), to znaczy dodajesz przechwytywacze do swojego kreatora Okhttp

okhttpBuilder.networkInterceptors().add(chain -> {
 //todo add headers etc to your AuthorisedRequest

  return chain.proceed(yourAuthorisedRequest);
});

i wreszcie skompiluj swojego okHttpClient z tego kreatora

OkHttpClient client = builder.build();
Kushagar Lall
źródło
tak, nie zauważając części add*Network*Interceptorzamiast addInterceptorciągnąć mnie za włosy przez kilka godzin :)
Antek
1

To zadziałało dla mnie:

class JSONHeaderInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain) : Response {
        val request = chain.request().newBuilder()
            .header("Content-Type", "application/json")
            .build()
        return chain.proceed(request)
    }
}
fun provideHttpClient(): OkHttpClient {
    val okHttpClientBuilder = OkHttpClient.Builder()
    okHttpClientBuilder.addInterceptor(JSONHeaderInterceptor())
    return okHttpClientBuilder.build()
}
patrick-fitzgerald
źródło
1

Wersja Kotlin:

fun okHttpClientFactory(): OkHttpClient {
    return OkHttpClient().newBuilder()
        .addInterceptor { chain ->
            chain.request().newBuilder()
                .addHeader(HEADER_AUTHONRIZATION, O_AUTH_AUTHENTICATION)
                .build()
                .let(chain::proceed)
        }
        .build()
}

ruX
źródło
0
package com.example.network.interceptors;

import androidx.annotation.NonNull;

import java.io.IOException;
import java.util.Map;

import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;

public class RequestHeadersNetworkInterceptor implements Interceptor {

    private final Map<String, String> headers;

    public RequestHeadersNetworkInterceptor(@NonNull Map<String, String> headers) {
        this.headers = headers;
    }

    @NonNull
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request.Builder builder = chain.request().newBuilder();
        for (Map.Entry<String, String> header : headers.entrySet()) {
            if (header.getKey() == null || header.getKey().trim().isEmpty()) {
                continue;
            }
            if (header.getValue() == null || header.getValue().trim().isEmpty()) {
                builder.removeHeader(header.getKey());
            } else {
                builder.header(header.getKey(), header.getValue());
            }
        }
        return chain.proceed(builder.build());
    }

}

Przykład użycia:

httpClientBuilder.networkInterceptors().add(new RequestHeadersNetworkInterceptor(new HashMap<String, String>()
{
    {
        put("User-Agent", getUserAgent());
        put("Accept", "application/json");
    }
}));
MingalevME
źródło
0
client = new OkHttpClient();

        Request request = new Request.Builder().header("authorization", token).url(url).build();
        MyWebSocketListener wsListener = new MyWebSocketListener(LudoRoomActivity.this);
        client.newWebSocket(request, wsListener);
        client.dispatcher().executorService().shutdown();
Pankaj Sharma
źródło