Retrofit 2로 모든 요청에 ​​헤더 추가


129

Retrofit 2의 문서 내용 :

모든 요청에 ​​추가해야하는 헤더는 OkHttp 인터셉터를 사용하여 지정할 수 있습니다.

이전 버전을 사용하여 쉽게 할 수 있습니다 . 여기 관련 QA가 있습니다.

하지만 개조 2를 사용 하면 물체에 적용 할 수있는 방법 setRequestInterceptor이나 setInterceptor방법을 찾을 수 없었습니다 Retrofit.Builder.

또한 더있을 것으로 보인다 RequestInterceptor에서 OkHttp을 더 이상. Retrofit의 문서는 Interceptor 를이 목적으로 사용하는 방법을 잘 이해하지 못했습니다.

어떻게 할 수 있습니까?

답변:


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

httpClient.addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request().newBuilder().addHeader("parameter", "value").build();
        return chain.proceed(request);
    }
});
Retrofit retrofit = new Retrofit.Builder().addConverterFactory(GsonConverterFactory.create()).baseUrl(url).client(httpClient.build()).build();

5
retrofit2-beta3 버전에서는 약간 다릅니다. 여기를 참조하십시오 : stackoverflow.com/questions/34973432/...
Ashkan Sarlak

이러한 헤더가 전송되었는지 어떻게 확인할 수 있습니까? Call에서 디버그 할 때 enqueue기본 헤더를 볼 수 없습니다.
viper

new OkHttpClient.Builder()대신 해야합니다new OkHttpClient()
Wojtek

80

최신 개조 버전은 여기에서-> 2.1.0.

람다 버전 :

  builder.addInterceptor(chain -> {
    Request request = chain.request().newBuilder().addHeader("key", "value").build();
    return chain.proceed(request);
  });

못생긴 긴 버전 :

  builder.addInterceptor(new Interceptor() {
    @Override public Response intercept(Chain chain) throws IOException {
      Request request = chain.request().newBuilder().addHeader("key", "value").build();
      return chain.proceed(request);
    }
  });

풀 버전:

class Factory {

public static APIService create(Context context) {

  OkHttpClient.Builder builder = new OkHttpClient().newBuilder();
  builder.readTimeout(10, TimeUnit.SECONDS);
  builder.connectTimeout(5, TimeUnit.SECONDS);

  if (BuildConfig.DEBUG) {
    HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
    interceptor.setLevel(HttpLoggingInterceptor.Level.BASIC);
    builder.addInterceptor(interceptor);
  }

  builder.addInterceptor(chain -> {
    Request request = chain.request().newBuilder().addHeader("key", "value").build();
    return chain.proceed(request);
  });

  builder.addInterceptor(new UnauthorisedInterceptor(context));
  OkHttpClient client = builder.build();

  Retrofit retrofit =
      new Retrofit.Builder().baseUrl(APIService.ENDPOINT).client(client).addConverterFactory(GsonConverterFactory.create()).addCallAdapterFactory(RxJavaCallAdapterFactory.create()).build();

  return retrofit.create(APIService.class);
  }
}

gradle 파일 (사용하려는 경우 로깅 인터셉터를 추가해야 함) :

  //----- Retrofit
  compile 'com.squareup.retrofit2:retrofit:2.1.0'
  compile "com.squareup.retrofit2:converter-gson:2.1.0"
  compile "com.squareup.retrofit2:adapter-rxjava:2.1.0"
  compile 'com.squareup.okhttp3:logging-interceptor:3.4.0'

13

요청 및 응답을 로깅하려면 인터셉터가 필요하고 헤더를 설정하려면 인터셉터가 필요합니다. 다음은 개조 2.1을 사용하여 한 번에 두 인터셉터를 추가하는 솔루션입니다.

 public OkHttpClient getHeader(final String authorizationValue ) {
        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient okClient = new OkHttpClient.Builder()
                .addInterceptor(interceptor)
                .addNetworkInterceptor(
                        new Interceptor() {
                            @Override
                            public Response intercept(Interceptor.Chain chain) throws IOException {
                                Request request = null;
                                if (authorizationValue != null) {
                                    Log.d("--Authorization-- ", authorizationValue);

                                    Request original = chain.request();
                                    // Request customization: add request headers
                                    Request.Builder requestBuilder = original.newBuilder()
                                            .addHeader("Authorization", authorizationValue);

                                    request = requestBuilder.build();
                                }
                                return chain.proceed(request);
                            }
                        })
                .build();
        return okClient;

    }

이제 개조 개체에서이 헤더를 클라이언트에 추가하십시오.

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                .client(getHeader(authorizationValue))
                .addConverterFactory(GsonConverterFactory.create())
                .build();

12

Retrofit 1.9 및 2.0에 대해이 유형 헤더를 사용해보십시오. Json 콘텐츠 유형의 경우.

@Headers({"Accept: application/json"})
@POST("user/classes")
Call<playlist> addToPlaylist(@Body PlaylistParm parm);

더 많은 헤더를 추가 할 수 있습니다.

@Headers({
        "Accept: application/json",
        "User-Agent: Your-App-Name",
        "Cache-Control: max-age=640000"
    })

헤더에 동적으로 추가 :

@POST("user/classes")
Call<ResponseModel> addToPlaylist(@Header("Content-Type") String content_type, @Body RequestModel req);

당신에게 방법을 호출하십시오.

mAPI.addToPlayList("application/json", playListParam);

또는

매번 전달하고 http 인터셉터를 사용하여 HttpClient 개체를 만듭니다.

OkHttpClient httpClient = new OkHttpClient();
        httpClient.networkInterceptors().add(new Interceptor() {
            @Override
            public com.squareup.okhttp.Response intercept(Chain chain) throws IOException {
                Request.Builder requestBuilder = chain.request().newBuilder();
                requestBuilder.header("Content-Type", "application/json");
                return chain.proceed(requestBuilder.build());
            }
        });

그런 다음 개조 개체에 추가

Retrofit retrofit = new Retrofit.Builder().baseUrl(BASE_URL).client(httpClient).build();

Kotlin을 사용하는 경우 업데이트 하면 { }작동하지 않습니다.


2
복제하지 않고 인터페이스의 모든 요청에 ​​대해 하나의 헤더를 만드는 방법은 무엇입니까?
Evgenii Vorobei

당신은 HTTP 로깅 인터셉터에 추가해야
Avinash 베르

6

제 경우에는 addInterceptor()요청에 HTTP 헤더를 추가하는 데 작동하지 않았으므로 addNetworkInterceptor(). 코드는 다음과 같습니다.

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

그리고 인터셉터 코드 :

public class AddHeaderInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {

        Request.Builder builder = chain.request().newBuilder();
        builder.addHeader("Authorization", "MyauthHeaderContent");

        return chain.proceed(builder.build());
    }
}

요점 에 대한 이것과 더 많은 예


5

HttpLoggingInterceptor를 추가하기 위해 addInterceptor 메소드를 사용하는 경우 HttpLoggingInterceptor 이후에 적용된 다른 인터셉터에 의해 추가 된 항목은 로깅되지 않습니다.

예 : 두 개의 인터셉터 "HttpLoggingInterceptor"및 "AuthInterceptor"가 있고 HttpLoggingInterceptor가 먼저 적용된 경우 AuthInterceptor에서 설정 한 http-params 또는 헤더를 볼 수 없습니다.

OkHttpClient.Builder builder = new OkHttpClient.Builder()
.addNetworkInterceptor(logging)
.addInterceptor(new AuthInterceptor());

addNetworkInterceptor 메서드를 사용하여 해결했습니다.


1
HttpLoggingInterceptor최종 요청을보기 위해 마지막 인터셉터로 추가 할 수도 있습니다 .
Micer

2

이 개조 클라이언트 사용

class RetrofitClient2(context: Context) : OkHttpClient() {

    private var mContext:Context = context
    private var retrofit: Retrofit? = null

    val client: Retrofit?
        get() {
            val logging = HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY)

            val client = OkHttpClient.Builder()
                    .connectTimeout(Constants.TIME_OUT, TimeUnit.SECONDS)
                    .readTimeout(Constants.TIME_OUT, TimeUnit.SECONDS)
                    .writeTimeout(Constants.TIME_OUT, TimeUnit.SECONDS)
            client.addInterceptor(logging)
            client.interceptors().add(AddCookiesInterceptor(mContext))

            val gson = GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").create()
            if (retrofit == null) {

                retrofit = Retrofit.Builder()
                        .baseUrl(Constants.URL)
                        .addConverterFactory(GsonConverterFactory.create(gson))
                        .client(client.build())
                        .build()
            }
            return retrofit
        }
}

모든 요청과 함께 JWT를 전달하고 있습니다. 변수 이름에 신경 쓰지 마십시오. 약간 혼란 스럽습니다.

class AddCookiesInterceptor(context: Context) : Interceptor {
    val mContext: Context = context
    @Throws(IOException::class)
    override fun intercept(chain: Interceptor.Chain): Response {
        val builder = chain.request().newBuilder()
        val preferences = CookieStore().getCookies(mContext)
        if (preferences != null) {
            for (cookie in preferences!!) {
                builder.addHeader("Authorization", cookie)
            }
        }
        return chain.proceed(builder.build())
    }
}

1

kotlin에서 인터셉터를 추가하면 다음과 같이 보입니다.

.addInterceptor{ it.proceed(it.request().newBuilder().addHeader("Cache-Control", "no-store").build())}

0

kotlin으로 작성된 RetrofitHelper 라이브러리를 사용하면 몇 줄의 코드를 사용하여 API 호출을 할 수 있습니다.

다음과 같이 애플리케이션 클래스에 헤더를 추가하십시오.

class Application : Application() {

    override fun onCreate() {
    super.onCreate()

        retrofitClient = RetrofitClient.instance
                    //api url
                .setBaseUrl("https://reqres.in/")
                    //you can set multiple urls
        //                .setUrl("example","http://ngrok.io/api/")
                    //set timeouts
                .setConnectionTimeout(4)
                .setReadingTimeout(15)
                    //enable cache
                .enableCaching(this)
                    //add Headers
                .addHeader("Content-Type", "application/json")
                .addHeader("client", "android")
                .addHeader("language", Locale.getDefault().language)
                .addHeader("os", android.os.Build.VERSION.RELEASE)
            }

        companion object {
        lateinit var retrofitClient: RetrofitClient

        }
    }  

그런 다음 전화를 겁니다.

retrofitClient.Get<GetResponseModel>()
            //set path
            .setPath("api/users/2")
            //set url params Key-Value or HashMap
            .setUrlParams("KEY","Value")
            // you can add header here
            .addHeaders("key","value")
            .setResponseHandler(GetResponseModel::class.java,
                object : ResponseHandler<GetResponseModel>() {
                    override fun onSuccess(response: Response<GetResponseModel>) {
                        super.onSuccess(response)
                        //handle response
                    }
                }).run(this)

자세한 내용은 설명서를 참조하십시오.


0

Kotlin 버전은

fun getHeaderInterceptor():Interceptor{
    return object : Interceptor {
        @Throws(IOException::class)
        override fun intercept(chain: Interceptor.Chain): Response {
            val request =
            chain.request().newBuilder()
                    .header(Headers.KEY_AUTHORIZATION, "Bearer.....")
                    .build()
            return chain.proceed(request)
        }
    }
}


private fun createOkHttpClient(): OkHttpClient {
    return OkHttpClient.Builder()
            .apply {
                if(BuildConfig.DEBUG){
                    this.addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BASIC))
                }
            }
            .addInterceptor(getHeaderInterceptor())
            .build()
}
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.