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

Ktor とアノテーション (Annotations)

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

さあ、始めましょう🚀

注記

更新 - 2024-10-21

コードを入手する​

備考

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

Gradleの設定​

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

plugins {

    id("com.google.devtools.ksp") version kspVersion
}

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

    implementation("io.insert-koin:koin-annotations:$koinAnnotationsVersion")
    ksp("io.insert-koin:koin-ksp-compiler:$koinAnnotationsVersion")
}

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

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

Users -> UserRepository -> UserService -> UserApplication

"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 アノテーションを使用して、指定されたKotlinクラスからKoinモジュールを宣言します。 Koinモジュールは、インジェクション（injection）されるすべてのコンポーネントを定義する場所です。

@Module
@ComponentScan("org.koin.sample")
class AppModule

@ComponentScan("org.koin.sample") は、ターゲットパッケージからアノテーション付きクラスをスキャンするのに役立ちます。

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

@Single
class UserRepositoryImpl : UserRepository

UserServiceコンポーネント​

デフォルトユーザーをリクエスト（request）するUserServiceコンポーネントを作成しましょう。

class UserService(private val userRepository: UserRepository) {

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

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

KoinモジュールでUserServiceを宣言します。 @Single アノテーションでタグ付けします。

@Single
class UserService(private val userRepository: UserRepository)

HTTPコントローラ​

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

fun Application.main() {

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

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

Application.main関数の起動を支援するために、application.confが以下のように設定されていることを確認してください。

ktor {
    deployment {
        port = 8080

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

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

起動と注入​

最後に、KtorからKoinを起動しましょう。

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

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

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

AppModule().moduleを記述することにより、AppModuleクラスで生成された拡張機能を使用します。

Ktorを起動しましょう。

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

以上です！ 準備完了です。 http://localhost:8080/hello URLを確認してください！