如何在KTOR中移除特定API请求由插件设置的AUTHTOKEN头

核心思路 #

和Retrofit通过注解标记请求的逻辑类似，Ktor可以通过**请求属性（Attributes）**标记需要忽略特定头的请求，再在自定义Headers插件中检查标记并移除对应头。以下是两种常用实现方式：

方式一：直接在请求中标记（适用于Ktor HTTP客户端DSL） #

1. 定义全局属性键 #

先定义一个唯一的AttributeKey，用来标记是否需要忽略AUTHTOKEN：

import io.ktor.util.AttributeKey

val IgnoreAuthTokenKey = AttributeKey<Boolean>("IgnoreAuthToken")

2. 修改自定义Headers插件 #

在你已有的headersPlugin中，添加检查逻辑：如果请求带有忽略标记，就移除AUTHTOKEN头：

internal fun headersPlugin(defaultHeaders: DefaultHeaders) = createClientPlugin("headersPlugin") {
    onRequest { request, _ ->
        request.headers.apply {
            append("requestFrom", defaultHeaders.requestFrom)
            append("clientType", defaultHeaders.clientType)
            append("User-Agent", defaultHeaders.userAgent)
            append("AUTHTOKEN", defaultHeaders.authToken)
            append("SESSIONID", defaultHeaders.sessionId)
        }

        // 检查请求标记，移除AUTHTOKEN
        if (request.attributes.contains(IgnoreAuthTokenKey) && request.attributes[IgnoreAuthTokenKey]) {
            request.headers.remove("AUTHTOKEN")
        }
    }
}

3. 发起特定请求时添加标记 #

调用不需要AUTHTOKEN的API时，在请求DSL中设置属性：

// 示例：调用公开API，忽略AUTHTOKEN
client.get("https://your-domain.com/public/api") {
    attributes.put(IgnoreAuthTokenKey, true)
}

方式二：通过注解标记（适用于Ktor注解式API，类似Retrofit） #

如果习惯用Retrofit风格的注解式接口定义API，可以通过自定义注解实现：

1. 定义忽略注解 #

@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class IgnoreAuthToken

2. 在API接口中标记需要忽略的方法 #

import io.ktor.client.call.body
import io.ktor.client.request.get
import io.ktor.client.request.post
import io.ktor.http.ContentType
import io.ktor.http.contentType

interface ApiService {
    // 标记此请求忽略AUTHTOKEN
    @Get("/public/api")
    @IgnoreAuthToken
    suspend fun getPublicData(): HttpResponse

    // 普通请求，保留AUTHTOKEN
    @Post("/private/api")
    @contentType(ContentType.Application.Json)
    suspend fun postPrivateData(body: Any): HttpResponse
}

3. 生成API实例时自动标记请求 #

创建ApiService实例时，通过requestBuilder检查方法注解，自动添加忽略标记：

import io.ktor.client.plugins.api.create
import io.ktor.client.plugins.api.KtorRequestMetaDataKey

val apiService = client.create<ApiService> {
    requestBuilder { request ->
        // 获取当前请求对应的接口方法
        val method = request.attributes[KtorRequestMetaDataKey].method
        // 检查方法是否带有@IgnoreAuthToken注解，添加标记
        if (method.isAnnotationPresent(IgnoreAuthToken::class.java)) {
            request.attributes.put(IgnoreAuthTokenKey, true)
        }
    }
}

4. 复用Headers插件逻辑 #

和方式一的插件代码完全一致，插件会自动识别标记并移除AUTHTOKEN头。

注意事项 #

• 确保AttributeKey全局唯一，避免和其他插件的属性冲突
• 如果需要忽略多个头（如SESSIONID），可以扩展属性键为枚举或集合类型，实现批量处理
• 插件的onRequest执行顺序取决于安装顺序，确保Headers插件在其他修改头的插件之前安装

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