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
인터셉터가 옳아 보입니다. 그것으로 작동하지 않는 것은 무엇입니까?
Jesse Wilson

답변:


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 요청에 헤더를 추가하는 방법은 무엇입니까? packageName과 API 키를 통과 한 다음 통과.addheader(params1, params2);
RoCk RoCk

@RoCk 헤더 구성이 다른 별도의 RestClient를 가질 수 있습니다.
Morteza Rastgoo

28

당신은 이렇게 할 수 있습니다

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

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 라이브러리를 @Header사용하는 경우 Interceptor를 사용하지 않고 주석을 사용 하여 헤더를 API 요청에 직접 전달할 수 있습니다 . 다음은 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 인터셉터에서 호출하면 개장 스레드에서 실행되며 스레드 문제에 대해 걱정할 필요가 없습니다.
모르테 Rastgoo

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

1

Kotlin 버전 :

fun okHttpClientFactory(): OkHttpClient {
    return OkHttpClient().newBuilder()
        .addInterceptor { chain ->
            chain.request().newBuilder()
                .addHeader(HEADER_AUTHONRIZATION, O_AUTH_AUTHENTICATION)
                .build()
                .let(chain::proceed)
        }
        .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();
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.