メインコンテンツまでスキップ

Ktor

Ktorは、強力なKotlinプログラミング言語を使用して、接続されたシステムで非同期サーバーとクライアントを構築するためのフレームワークです。ここではKtorを使用して、簡単なWebアプリケーションを構築します。

さあ始めましょう🚀

注記

update - 2024-10-21

コードを入手する​

備考

ソースコードはGithubで入手できます

Gradle のセットアップ​

まず、以下のようにKoinの依存関係を追加します。

dependencies {
    // Koin for Kotlin apps
    implementation("io.insert-koin:koin-ktor:$koin_version")
    implementation("io.insert-koin:koin-logger-slf4j:$koin_version")
}

アプリケーションの概要​

このアプリケーションのアイデアは、ユーザーのリストを管理し、UserApplicationクラスに表示することです。

Users -> UserRepository -> UserService -> UserApplication

"User"データ​

Userのコレクションを管理します。データクラスは次のとおりです。

data class User(val name : String)

ユーザーのリストを管理する（ユーザーを追加したり、名前で検索したりする）ための「Repository（リポジトリ）」コンポーネントを作成します。以下は、UserRepositoryインターフェースとその実装です。

interface UserRepository {
    fun findUser(name : String): User?
    fun addUsers(users : List<User>)
}

class UserRepositoryImpl : UserRepository {

    private val _users = arrayListOf<User>()

    override fun findUser(name: String): User? {
        return _users.firstOrNull { it.name == name }
    }

    override fun addUsers(users : List<User>) {
        _users.addAll(users)
    }
}

Koinモジュール​

module関数を使用してKoinモジュールを宣言します。Koinモジュールは、注入されるすべてのコンポーネントを定義する場所です。

val appModule = module {
    
}

最初のコンポーネントを宣言しましょう。UserRepositoryImplのインスタンスを作成して、UserRepositoryのシングルトンが必要になります。

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
}

UserServiceコンポーネント​

デフォルトユーザーを要求するUserServiceコンポーネントを記述しましょう。

class UserService(private val userRepository: UserRepository) {

    fun getDefaultUser() : User = userRepository.findUser(DefaultData.DEFAULT_USER.name) ?: error("Can't find default user")
}

UserRepositoryはUserPresenterのコンストラクタで参照されます。

KoinモジュールでUserServiceを宣言します。singleOf定義として宣言します。

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    singleOf(::UserService)
}

HTTPコントローラー​

最後に、HTTPルートを作成するためのHTTPコントローラーが必要です。Ktorでは、Ktor拡張関数で表現されます。

fun Application.main() {

    // Lazy inject HelloService
    val service by inject<UserService>()

    // Routing section
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

application.confが以下のように構成されていることを確認して、Application.main関数の開始を支援してください。

ktor {
    deployment {
        port = 8080

        // For dev purpose
        //autoreload = true
        //watch = [org.koin.sample]
    }

    application {
        modules = [ org.koin.sample.UserApplicationKt.main ]
    }
}

依存関係を宣言する​

Koinモジュールでコンポーネントを組み立てましょう。

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    singleOf(::UserService)
}

開始と注入​

最後に、KtorからKoinを開始しましょう。

fun Application.main() {
    install(Koin) {
        slf4jLogger()
        modules(appModule)
    }

    // Lazy inject HelloService
    val service by inject<UserService>()
    service.saveDefaultUsers()

    // Routing section
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

Ktorを開始しましょう。

fun main(args: Array<String>) {
    // Start Ktor
    embeddedServer(Netty, commandLineEnvironment(args)).start(wait = true)
}

以上です！準備ができました。http://localhost:8080/helloのURLを確認してください！