控制Ktor 0.9.0 servlet中的cookie生命周期

Posted 2021-05-05

我在删除Ktor 0.9.0服务器端应用程序设置的cookie时遇到问题。也许我不知道如何以正确的方式去做，或者在Ktor框架中有遗漏。

Cookie的创建和删除本身并不是问题，但为了删除cookie，我必须使用与客户端浏览器上的cookie一起存储的相同路径。 Ktor让我通过cookie创建来控制路径。这是我的配置：

install(Sessions) {
    cookie<MySession>(sessionMarker) {
        cookie.duration = cookieDuration
        cookie.path = "/myWebapp"
        transform(SessionTransportTransformerMessageAuthentication(sessionKey))
    }
}

在登录页面/myWebapp/page/login上，我创建了cookie然后发送到客户端，它来回传输发送到Web应用程序的其余请求：

call.sessions.set(MySession([some data class arguments]))

cookie在客户端检查时显示路径/myWebapp。默认值为/myWebapp/page，因为这是登录页面的路径，但路径取自上面显示的cookie配置。到目前为止一直很好。

最终，用户希望通过POST请求注销登录页面：

call.sessions.clear<MySession>()

这里的问题是我没有找到控制cookie路径的方法。因为登录页面/myWebapp/page/login正在将过期的cookie发送回客户端以获取另一条路径（它自己的/myWebapp/page），所以原始cookie不会被删除（/myWebapp/page！= /myWebapp）。

在尝试删除cookie时，如何在Ktor 0.9.0中控制cookie的路径？

我知道如何解决它：通过从我将删除它的路径创建cookie。但这不是我想要的（像/myWebapp/others这样的网络应用程序中的其他路径应该使用cookie）。有能力在创建过程中控制cookie的路径是没有意义的。

答案

我想你可以尝试创建自己的自定义SessionTransportCookie。

如果你更深入地了解方法cookie<MySession>(sessionMarker)，你会发现这个代码：

inline fun <reified S : Any> Sessions.Configuration.cookie(name: String, block: CookieSessionBuilder<S>.() -> Unit): Unit = cookie(name, S::class, block)

inline fun <S : Any> Sessions.Configuration.cookie(name: String, sessionType: KClass<S>, block: CookieSessionBuilder<S>.() -> Unit) {
    val builder = CookieSessionBuilder(sessionType).apply(block)
    val transport = SessionTransportCookie(name, builder.cookie, builder.transformers)
    val tracker = SessionTrackerByValue(sessionType, builder.serializer)
    val provider = SessionProvider(name, sessionType, transport, tracker)
    register(provider)
}

这里重要的一行是按行创建会话传输cookie：SessionTransportCookie(name, builder.cookie, builder.transformers)

让我们更深入了解SessionTransportCookie：

class SessionTransportCookie(val name: String,
                             val configuration: CookieConfiguration,
                             val transformers: List<SessionTransportTransformer>
) : SessionTransport {

    override fun receive(call: ApplicationCall): String? {
        return transformers.transformRead(call.request.cookies[name])
    }

    override fun send(call: ApplicationCall, value: String) {
        val now = LocalDateTime.now()
        val expires = now.plus(configuration.duration)
        val maxAge = configuration.duration[ChronoUnit.SECONDS].toInt()
        val cookie = Cookie(name,
                transformers.transformWrite(value),
                configuration.encoding,
                maxAge,
                expires,
                configuration.domain,
                configuration.path,
                configuration.secure,
                configuration.httpOnly,
                configuration.extensions
        )

        call.response.cookies.append(cookie)
    }

    override fun clear(call: ApplicationCall) {
        call.response.cookies.appendExpired(name)
    }
}

class CookieConfiguration {
    var duration: TemporalAmount = Duration.ofDays(7)
    var encoding: CookieEncoding = CookieEncoding.URI_ENCODING
    var domain: String? = null
    var path: String? = null
    var secure: Boolean = false
    var httpOnly: Boolean = false
    val extensions: MutableMap<String, String?> = mutableMapOf()
}

所以，正如您所看到的，在本课程中，您可以自定义Cookie send/clear逻辑。