วิธีการเพิ่มส่วนหัวใน OkHttp request interceptor?


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

แต่มันไม่พอดีกับความต้องการของฉัน ฉันต้องการมันใน interceptor


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 () เพิ่ม (interceptor) ด้วยรหัสเดียวกันในคำตอบนี้ แต่ไม่ได้เพิ่มส่วนหัว
Informatic0re

จะเพิ่มส่วนหัวสำหรับคำขอ youtube ได้อย่างไร มันเป็น packageName และคีย์ API ของคุณหรือไม่แล้วส่งผ่าน.addheader(params1, params2);
RoCk RoCk

@RoCk คุณสามารถมี RestClients แยกกันซึ่งมีการกำหนดค่าส่วนหัวที่แตกต่างกัน
Morteza Rastgoo

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

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 library คุณสามารถส่งส่วนหัวไปยังคำขอ 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 interceptor มันจะทำงานในเธรดชุดติดตั้งเพิ่มเติมและฉันไม่จำเป็นต้องกังวลเกี่ยวกับปัญหาเธรด
Morteza Rastgoo

6

ยังมีอีกวิธีหนึ่งในการเพิ่ม interceptors ใน OkHttp3 ของคุณ (เวอร์ชันล่าสุด ณ ตอนนี้) นั่นคือคุณเพิ่ม interceptors ลงในตัวสร้าง 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();
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.