Skip to content
Server Plugin

HttpsRedirect

所需依赖项io.ktor:ktor-server-http-redirect

代码示例 ssl-engine-main-redirect

Native 服务器
Ktor 支持 Kotlin/Native,并允许您在没有额外运行时或虚拟机的情况下运行服务器。
支持:✅

HttpsRedirect 插件在处理调用之前,会将所有 HTTP 请求重定向到其 HTTPS 对应项。默认情况下,资源返回 301 Moved Permanently,但也可以配置为返回 302 Found

添加依赖项

要使用 HttpsRedirect,您需要在构建脚本中包含 ktor-server-http-redirect 构件:

Kotlin
Groovy
XML

安装 HttpsRedirect

要将 HttpsRedirect 插件安装到应用, 请在指定的

模块
模块允许您通过对路由进行分组来组织应用结构。
中将其传递给 install 函数。 以下代码段展示了如何安装 HttpsRedirect ...

  • ... 在 embeddedServer 函数调用中。
  • ... 在显式定义的 module(它是 Application 类的扩展函数)中。
kotlin
kotlin

上面的代码使用默认配置安装了 HttpsRedirect 插件。

当位于反向代理之后时,您需要安装 ForwardedHeaderXForwardedHeader 插件以正确检测 HTTPS 请求。如果在安装这些插件之一后遇到无限重定向,请查看 此常见问题解答条目 了解更多详情。

配置 HttpsRedirect

以下代码段展示了如何配置所需的 HTTPS 端口,并为请求的资源返回 301 Moved Permanently

kotlin
install(HttpsRedirect) {
    sslPort = 8443
    permanentRedirect = true
}

您可以在此处找到完整示例:ssl-engine-main-redirect