Retrofit 2ですべてのリクエストにヘッダーを追加する

128

Retrofit 2のドキュメントには次のように書かれています：

すべてのリクエストに追加する必要があるヘッダーは、OkHttpインターセプターを使用して指定できます。

これは、以前のバージョンを使用して簡単に行うことができ、ここだ、関連するQAは。

しかし、レトロフィット2を使用して、オブジェクトに適用できるようなメソッドsetRequestInterceptorやsetInterceptorメソッドを見つけることができませんでしたRetrofit.Builder。

またRequestInterceptor、OkHttpにはもうないようです。Retrofitのドキュメントでは、Interceptorを紹介していますが、この目的での使用方法がよくわかりませんでした。

これどうやってするの？

java  android  header  httprequest  retrofit 
— アシュカンサーラック
ソース

回答:

199 
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();
— dtx12
ソース
5
retrofit2-beta3バージョンでは少し異なります。ここを参照してください：stackoverflow.com/questions/34973432/...
— Ashkan Sarlak
これらのヘッダーが送信されたことをどのように確認できますか？コールでデバッグするとenqueue、デフォルトのヘッダーが表示されません。
— バイパー、
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'
— OWADVL
ソース
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);

メソッドを呼び出すie

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
それを複製せずにインターフェースのすべての要求に対して1つのヘッダーを作成するにはどうすればよいですか？
— Evgenii Vorobei
HTTPロギングインターセプターに追加する必要があります
— Avinash Verma
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());
    }
}

これとこの要点の例

— voghDev
ソース
5

HttpLoggingInterceptorの追加にaddInterceptorメソッドを使用する場合、HttpLoggingInterceptorより後に適用される他のインターセプターによって追加されたものはログに記録されません。

例：2つのインターセプター「HttpLoggingInterceptor」と「AuthInterceptor」があり、HttpLoggingInterceptorが最初に適用されている場合、AuthInterceptorによって設定されたhttp-paramsまたはヘッダーを表示できません。

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

addNetworkInterceptorメソッドを使用して解決しました。

— ガリヤモフ
ソース
1
HttpLoggingInterceptor最後のインターセプターとして追加して、最終的なリクエストを確認することもできます。
— マイサー2018
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())}
— ダミアンJK
ソース
0

RetrofitHelper kotlinで書かれたライブラリ、あなたは数行のコードを使用して、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.