Skip to content
Server Plugin

Webjars

所需依赖项:io.ktor:ktor-server-webjars

代码示例: webjars

原生服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✖️

Webjars 插件支持提供由 WebJars 提供的客户端库。它允许你将诸如 JavaScript 和 CSS 库等资源打包为你 fat JAR 的一部分。

添加依赖项 ​

要启用 Webjars,你需要在构建脚本中包含以下工件:

  • 添加 ktor-server-webjars 依赖项:

    kotlin
    implementation(ktorLibs.server.webjars)
    上述代码片段使用 Ktor 版本型录 来指定 Ktor 依赖项。
    groovy
    implementation ktorLibs.server.webjars
    上述代码片段使用 Ktor 版本型录 来指定 Ktor 依赖项。
    xml
    <dependency>
        <groupId>io.ktor</groupId>
        <artifactId>ktor-server-webjars-jvm</artifactId>
        <version>${ktor_version}</version>
    </dependency>
  • 为所需的客户端库添加依赖项。以下示例展示了如何添加 Bootstrap 工件:

    kotlin
    implementation("org.webjars:bootstrap:$bootstrap_version")
    groovy
    implementation "org.webjars:bootstrap:$bootstrap_version"
    xml
    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>bootstrap</artifactId>
        <version>${bootstrap_version}</version>
    </dependency>

    你可以将 $bootstrap_version 替换为所需 bootstrap 工件的版本,例如 5.2.3。

安装 Webjars ​

要在你的应用程序中安装 Webjars 插件,请将其传递给指定模块模块允许您通过对路由进行分组来构建应用程序结构。中的 install 函数。以下示例展示了如何安装 Webjars:

  • 在 embeddedServer() 函数调用中。
  • 在 Application 类上显式定义的 module() 扩展函数中。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.webjars.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(Webjars)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.webjars.*
// ...
fun Application.module() {
    install(Webjars)
    // ...
}

配置 Webjars ​

默认情况下,Webjars 会在 /webjars 路径上提供 WebJars 资源。以下示例展示了如何更改此设置并在 /assets 路径上提供任意 WebJars 资源:

kotlin
import io.ktor.server.application.*
import io.ktor.server.webjars.*

fun Application.module() {
    install(Webjars) {
        path = "assets"
    }
}

例如,如果你已安装 org.webjars:bootstrap 依赖项,可以按如下方式添加 bootstrap.css:

html
<head>
    <link rel="stylesheet" href="/assets/bootstrap/bootstrap.css">
</head>

请注意,Webjars 允许你在不更改用于加载它们的路径的情况下更改依赖项的版本。

你可以在此处找到完整示例:webjars。