Как добавить заголовки в перехватчик запросов OkHttp?

95

У меня есть перехватчик, который я добавляю в свой клиент 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;
}
}

Как я могу добавить заголовки к запросу в моем перехватчике?

Я пробовал это, но делаю ошибку и теряю свой запрос при создании нового запроса:

    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);
    }
}

Обратите внимание, я знаю, что могу добавить заголовок при создании такого запроса:

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();

Но это не соответствует моим потребностям. Мне это нужно в перехватчике.

Мортеза Растгоо
источник
1
Ваш перехватчик выглядит правильно. Что с этим не работает?
Джесси Уилсон

Ответы:

153

Наконец, я добавил заголовки следующим образом:

@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);
    }
Мортеза Растгоо
источник
1
почему-то это не добавляет заголовки в мой запрос ?! Я использую okHttp.Builder и networkInterceptors (). Add (interceptor) с тем же кодом, что и в этом ответе, но заголовки не добавляются.
Informatic0re
как добавить заголовок для запроса youtube? Это имя пакета и ваш ключ API, а затем передать его.addheader(params1, params2);
RoCk RoCk
@RoCk У вас могут быть отдельные RestClients с разной конфигурацией заголовка.
Мортеза Растгу
27

ты можешь сделать это так

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();
    }
гауранг
источник
5
Это не перехватчик.
bekce
15

вот полезная суть от 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
источник
10

Столкнувшись с аналогичной проблемой с другими образцами, этот класс Kotlin работал у меня

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)
    }
}
Алекс Ноласко
источник
9

Если вы используете библиотеку Retrofit, вы можете напрямую передавать заголовок в запрос api с помощью @Headerаннотации без использования Interceptor. Вот пример, который показывает, как добавить заголовок в запрос 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);

Надеюсь, это поможет!

Раджеш
источник
4
Я знаю это, но у меня есть метод получения токена с именем: getToken (), который ожидает в потоке. поэтому, если я вызываю это в перехватчике OkHttp, он будет работать в потоке модернизации, и мне не нужно беспокоиться о проблемах потока.
Мортеза Растгу
6

Есть еще один способ добавить перехватчики в ваш OkHttp3 (последняя версия на данный момент), то есть вы добавляете перехватчики в свой строитель Okhttp.

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

  return chain.proceed(yourAuthorisedRequest);
});

и, наконец, создайте свой okHttpClient из этого построителя

OkHttpClient client = builder.build();
Кушагар Лалл
источник
да, не замечая этого, add*Network*Interceptorвместо того, addInterceptorчтобы пару часов тянуть за волосы :)
Antek
1

Это сработало для меня:

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()
}
Патрик-Фитцджеральд
источник
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());
    }

}

Пример использования:

httpClientBuilder.networkInterceptors().add(new RequestHeadersNetworkInterceptor(new HashMap<String, String>()
{
    {
        put("User-Agent", getUserAgent());
        put("Accept", "application/json");
    }
}));
МингалевМЕ
источник
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();
Панкадж Шарма
источник