Skip to content
Server Plugin

Webjars

必要な依存関係: io.ktor:ktor-server-webjars

コード例: webjars

Nativeサーバー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パスで配信します。以下の例は、これを変更してWebJarsのアセットを/assetsパスで配信する方法を示しています:

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。