본문으로 건너뛰기

Ktor & 어노테이션 (Annotations)

Ktor는 강력한 Kotlin 프로그래밍 언어를 사용하여 연결된 시스템에서 비동기 서버 및 클라이언트를 구축하기 위한 프레임워크입니다. 여기서는 간단한 웹 애플리케이션을 구축하기 위해 Ktor를 사용할 것입니다.

시작해 봅시다 🚀

노트

업데이트 - 2024-10-21

코드 가져오기​

정보

소스 코드는 Github에서 확인할 수 있습니다

Gradle 설정​

먼저 다음과 같이 Koin 종속성을 추가합니다.

plugins {

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

dependencies {
    // Kotlin 앱용 Koin
    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" 데이터​

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 모듈은 주입될 모든 컴포넌트를 정의하는 곳입니다.

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

@ComponentScan("org.koin.sample")은 대상 패키지에서 어노테이션이 달린 클래스를 스캔하는 데 도움이 됩니다.

첫 번째 컴포넌트를 선언해 보겠습니다. UserRepositoryImpl의 인스턴스를 생성하여 UserRepository의 싱글톤(singleton)을 원합니다. @Single로 태그합니다.

@Single
class UserRepositoryImpl : 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`s 생성자에서 참조됩니다.

Koin 모듈에서 UserService를 선언합니다. @Single 어노테이션으로 태그합니다.

@Single
class UserService(private val userRepository: UserRepository)

HTTP Controller​

마지막으로 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 ]
    }
}

시작 및 주입 (Inject)​

마지막으로 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을 확인하십시오!