如何在Quarkus Rest Client中配置Cookie管理功能
方案1:官方原生配置(推荐,适用于Quarkus 2.15.Final及以上版本)
Quarkus从2.15版本开始已经内置了Cookie管理的配置项,无需修改代码,直接在application.properties/application.yml中添加配置即可:
# 全局开启所有Rest Client的Cookie自动管理能力 quarkus.rest-client.enable-cookie-management=true # 若只需为指定的Rest Client单独开启,使用如下配置,<client-name>替换为@RegisterRestClient注解中指定的configKey值,或客户端接口的全限定类名 quarkus.rest-client."<client-name>".enable-cookie-management=true
该配置原生兼容GraalVM原生镜像,是目前最优的解决方案。
方案2:自定义过滤器实现(兼容所有Quarkus版本)
如果使用的Quarkus版本低于2.15,可以通过自定义请求/响应过滤器手动维护Cookie存储,完全不需要反射操作,也兼容原生镜像:
- 首先定义Cookie存储组件:
import javax.enterprise.context.ApplicationScoped @ApplicationScoped class SharedCookieStore { private val storedCookies = mutableMapOf<String, String>() fun saveFromSetCookieHeaders(setCookieHeaders: List<String>) { setCookieHeaders.forEach { headerValue -> val keyValuePart = headerValue.split(";").firstOrNull() ?: return@forEach val (key, value) = keyValuePart.split("=", limit = 2).takeIf { it.size == 2 } ?: return@forEach storedCookies[key.trim()] = value.trim() } } fun buildCookieHeader(): String? { return if (storedCookies.isNotEmpty()) { storedCookies.entries.joinToString("; ") { "${it.key}=${it.value}" } } else null } fun clearCookies() { storedCookies.clear() } }
- 定义请求过滤器,自动在请求头中携带已存储的Cookie:
import javax.inject.Inject import javax.ws.rs.client.ClientRequestContext import javax.ws.rs.client.ClientRequestFilter import javax.ws.rs.ext.Provider @Provider class CookieAddRequestFilter : ClientRequestFilter { @Inject lateinit var cookieStore: SharedCookieStore override fun filter(requestContext: ClientRequestContext) { cookieStore.buildCookieHeader()?.let { requestContext.headers.add("Cookie", it) } } }
- 定义响应过滤器,自动保存接口返回的Cookie:
import javax.inject.Inject import javax.ws.rs.client.ClientRequestContext import javax.ws.rs.client.ClientResponseContext import javax.ws.rs.client.ClientResponseFilter import javax.ws.rs.ext.Provider @Provider class CookieSaveResponseFilter : ClientResponseFilter { @Inject lateinit var cookieStore: SharedCookieStore override fun filter(requestContext: ClientRequestContext, responseContext: ClientResponseContext) { responseContext.getHeaders()["Set-Cookie"]?.let { cookieStore.saveFromSetCookieHeaders(it) } } }
- 最后在你的有状态API客户端接口上注册这两个过滤器即可:
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider import org.eclipse.microprofile.rest.client.inject.RegisterRestClient @RegisterRestClient(configKey = "your-stateful-api") @RegisterProvider(CookieAddRequestFilter::class) @RegisterProvider(CookieSaveResponseFilter::class) interface YourStatefulApiClient { // 声明你的API调用方法 }
原有反射方案的补充说明
如果你仍要使用反射的RestClientBuilderListener方案,需要在src/main/resources/META-INF/native-image/reflect-config.json中添加如下配置,才能兼容GraalVM原生镜像:
[ { "name": "io.quarkus.rest.client.reactive.QuarkusRestClientBuilder", "fields": [ { "name": "builderDelegate", "allowWrite": true } ] } ]
该方案依赖Quarkus内部实现细节,版本升级可能出现兼容性问题,仅作为临时方案使用。
内容的提问来源于stack exchange,提问作者Boris the Spider
相关产品推荐
相关产品推荐

