Retrofit 2请求中动态Cookie配置的技术咨询

Hey there! I totally get where you're coming from—you've been using Retrofit smoothly for ages, and now this dynamic cookie requirement is throwing a wrench in things. Don't worry, this is a common scenario, and we can solve it using OkHttp's interceptors, which Retrofit plays nicely with (since Retrofit is built on top of OkHttp).

Step 1: Build a Custom OkHttp Interceptor #

Interceptors let you tweak requests right before they're sent, which is perfect for adding a dynamic cookie to every call. Here's a straightforward implementation:

Kotlin Example #

class DynamicCookieInterceptor(private val getLatestCookie: () -> String) : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        // Grab the original request
        val originalRequest = chain.request()
        
        // Fetch the current dynamic cookie (this could come from a local store, singleton, etc.)
        val currentCookie = getLatestCookie()
        
        // Modify the request to add the Cookie header
        val modifiedRequest = originalRequest.newBuilder()
            .addHeader("Cookie", currentCookie)
            .build()
        
        // Proceed with the modified request
        return chain.proceed(modifiedRequest)
    }
}

Java Example #

public class DynamicCookieInterceptor implements Interceptor {
    private final Supplier<String> getLatestCookie;

    public DynamicCookieInterceptor(Supplier<String> getLatestCookie) {
        this.getLatestCookie = getLatestCookie;
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request originalRequest = chain.request();
        String currentCookie = getLatestCookie.get();
        
        Request modifiedRequest = originalRequest.newBuilder()
                .addHeader("Cookie", currentCookie)
                .build();
        
        return chain.proceed(modifiedRequest);
    }
}

The getLatestCookie function/lambda is your way to pull the most up-to-date cookie value whenever a request is made—this could be from a shared preference, a singleton class that tracks the current entity ID, or wherever you store the cookie after receiving it from the API.

Step 2: Attach the Interceptor to Your OkHttp Client #

Next, you need to wire this interceptor into your OkHttp client, which Retrofit will use:

Kotlin #

// Example: Fetch the cookie from a singleton that holds your current entity ID
val cookieProvider = { "entityId=${YourCookieStore.currentEntityId}" }

val okHttpClient = OkHttpClient.Builder()
    .addInterceptor(DynamicCookieInterceptor(cookieProvider))
    .build()

Java #

// Example: Fetch the cookie from a singleton
Supplier<String> cookieProvider = () -> "entityId=" + YourCookieStore.getCurrentEntityId();

OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .addInterceptor(new DynamicCookieInterceptor(cookieProvider))
        .build();

Step 3: Use the Configured OkHttp Client with Retrofit #

Finally, pass this customized OkHttp client to your Retrofit builder:

Kotlin #

val retrofit = Retrofit.Builder()
    .baseUrl("https://your-third-party-api-endpoint.com/")
    .client(okHttpClient)
    .addConverterFactory(GsonConverterFactory.create()) // Use your preferred converter
    .build()

// Create your API service interface as usual
val yourApiService = retrofit.create(YourApiService::class.java)

Java #

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://your-third-party-api-endpoint.com/")
        .client(okHttpClient)
        .addConverterFactory(GsonConverterFactory.create())
        .build();

YourApiService yourApiService = retrofit.create(YourApiService.class);

Bonus: Handling Cookie Updates #

If the cookie changes during your app's runtime (e.g., you get a new entity ID from an API response), just make sure your cookieProvider returns the updated value. For example, you could update a mutable variable in your singleton whenever the cookie changes, and the interceptor will automatically pick up the new value on the next request.

As for that old rejected PR you mentioned—this is likely because Retrofit intentionally leans on OkHttp's existing interceptor system for request modifications like this, rather than building redundant native support. It's a flexible pattern that covers most dynamic header/cookie use cases.

If you run into specific edge cases (like handling multiple cookies, or cookie expiration) or need help adapting this to your existing code, feel free to share more details and I can help refine this solution further!

内容的提问来源于stack exchange，提问作者Agnibha