Comment ajouter des en-têtes à l'intercepteur de requêtes OkHttp?


95

J'ai cet intercepteur que j'ajoute à mon client 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;
}
}

Comment puis-je ajouter des en-têtes à demander dans mon intercepteur?

J'ai essayé ceci mais je fais une erreur et je perds ma demande lors de la création d'une nouvelle demande:

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

Notez que je sais que je peux ajouter un en-tête lors de la création d'une demande comme celle-ci:

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

Mais cela ne correspond pas à mes besoins. J'en ai besoin dans l'intercepteur.


1
Votre intercepteur a l'air bien. Qu'est-ce qui ne fonctionne pas avec ça?
Jesse Wilson

Réponses:


153

Enfin, j'ai ajouté les en-têtes de cette façon:

@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
pour une raison quelconque, cela n'ajoute pas les en-têtes à ma demande?! J'utilise okHttp.Builder et networkInterceptors (). Add (interceptor) avec le même code que dans cette réponse, mais les en-têtes ne sont pas ajoutés.
Informatic0re

comment ajouter un en-tête pour la demande youtube? Est-ce un packageName et votre clé API et ensuite passer.addheader(params1, params2);
RoCk RoCk

@RoCk Vous pouvez avoir des RestClients séparés qui ont une configuration d'en-tête différente.
Morteza Rastgoo

27

tu peux le faire de cette façon

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
Ce n'est pas un intercepteur.
bekce

15

voici un résumé utile de 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

Face à un problème similaire avec d'autres échantillons, cette classe Kotlin a fonctionné pour moi

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

Si vous utilisez la bibliothèque Retrofit, vous pouvez directement passer l'en-tête à la demande d'API en utilisant l' @Headerannotation sans utiliser Interceptor. Voici un exemple qui montre comment ajouter un en-tête à la demande d'API Retrofit.

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

J'espère que cela aide!


4
Je le sais, mais j'ai une méthode pour obtenir le jeton nommé: getToken () qui a attendu sur le fil. donc si j'appelle cela dans l'intercepteur OkHttp, il fonctionnera dans le fil de mise à niveau et je n'ai pas besoin de m'inquiéter des problèmes de thread.
Morteza Rastgoo

6

Il existe encore une autre façon d'ajouter des intercepteurs dans votre OkHttp3 (dernière version à partir de maintenant), c'est-à-dire que vous ajoutez les intercepteurs à votre constructeur Okhttp

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

  return chain.proceed(yourAuthorisedRequest);
});

et enfin construisez votre okHttpClient à partir de ce générateur

OkHttpClient client = builder.build();

oui, ne pas remarquer la partie au add*Network*Interceptorlieu de addInterceptorme tirer les cheveux pendant quelques heures :)
Antek

1

Cela a fonctionné pour moi:

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

}

Exemple d'utilisation:

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();
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.