API를 개발하다보면 처리에 따라서 응답에 특정한 헤더를 내려준다던지, 스테이터스 코드를 조작하여 응답하는 경우가 있다. 이럴때 전통적인 Spring MVC를 사용하면 문제가 되지 않지만 Spring WebFlux로 개발하게 되면 기본적으로 Mono 또는 Flux로 리턴하는것이 원칙이기 때문에 어떻게 처리해야할지 난감스러울 수 있다.
Spring WebFlux는 함수형 방식과 애노테이션 방식 이렇게 2가지 프로그래밍 모델을 지원한다. 함수형 방식은 ServerResponse를 사용해서 부가적인 응답을 처리할 수 있지만, 애노테이션 방식으로 개발을 하면서 ServerResponse를 사용하게 되면 Caused by: com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class org.springframework.web.reactive.function.server.DefaultServerResponseBuilder$WriterFunctionResponse and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)과 같은 에러를 볼수있다.
이에 대한 해결책으로 Spring MVC에서 사용하던 ResponseEntity를 그대로 사용하면된다. 아래 코드를 보고 확인해보자.
예제
아래 코드는 사용자가 성인인지 체크한 후 맞다면 "X-User-Adult" 헤더와 스테이터스 코드 200 Ok를 응답으로 내려주고, 성인이 아니라면 403 Fobidden을 응답하도록 만든 예제이다.
결론
예제처럼 Mono 또는 Flux로 ResponseEntity를 감싸면 쉽게 헤더 및 스테이터스 코드 조작이 가능하다.
최근 가장 성장하고 있는 언어인 코틀린에 대해 관심이 있으시다면 Ktor에 대해서도 들어보셨을 거라 생각합니다. 오늘 소개해드릴Ktor (Kay-tor로 발음)는 코틀린과 마찬가지로 JetBrains에서 개발된 프레임워크 로써 멀티 플랫폼에 대한 지원을 목적으로 개발되었습니다. Ktor를 사용하면 코루틴 기반의 비동기 서버와 HTTP 클라이언트 모두 개발이 가능합니다.
오늘은 Ktor를 이용하여 간단한 Todo 웹 서비스를 만들어보고 다른 프레임워크들과는 어떤 차이점이 있는지 알아보도록 하겠습니다.
프로젝트 구조 만들기
수동으로 프로젝트를 만드는 방법도 있지만, Ktor 퀵 스타트에선 더 쉽게 프로젝트를 구성하기 위한 제너레이터인 start.ktor.io와 IntelliJ 플러그인을 제공하고 있습니다. 스프링에 익숙하신 분이라면 start.ktor.io는 start.spring.io와 똑같다고 보시면 됩니다. 저는 IntelliJ 플러그인을 사용해 프로젝트 구조를 생성하겠습니다.
위 코드에서 중요한 부분은 io.ktor로 시작하는 설정들과 org.jetbrains.exposed로 시작하는 설정들 입니다. 이번 예제에선 Jetbrains에서 만든 경량 SQL 프레임워크인 Exposed도 함께 사용하겠습니다. Exposed는 데이터 엑세스를 위한 방식으로 SQL DSL과 DAO 방식을 지원합니다. 이번 예제에선 DAO 방식을 사용하여 CRUD를 구현해보겠습니다. 2가지 방식에 대한 차이점은여기를 눌러 확인해보시기 바랍니다.
application.conf는 Ktor 프로젝트에서 메인 설정 파일입니다. 스프링의 application.yml 또는 application.properties와 동일하다고 볼 수 있습니다. 주목할 점은 application.conf 파일은 HOCON (Human-Optimized Config Object Notation) 표기법을 기본으로 사용하고 있습니다. HOCON외에도 프로퍼티 표기법도 지원합니다.
port는 9999로 설정하였습니다. 키-밸류를 보면 서버 포트가 9999라는것을 쉽게 예측 가능합니다.
main.kotlin.MainKt.main은 엔트리 포인트(Application Entry Point)입니다. Ktor는 내부적으로 여기에 지정된 모듈을 사용해 서버를 동작시킵니다.
서버를 동작시키는 main 함수를 정의하였습니다. io.ktor.server.netty.EngineMain.main(args) 코드를 보시면 저희가 만든 서버가 Netty를 사용하고 있다는 사실을 알 수 있습니다. Ktor는 기본적으로 Netty를 사용하지만 선택적으로 Tomcat, Jetty 등과 같은 웹서버도 지원합니다.
Application.main : 애플리케이션에서 사용될 모듈들을 설정하였습니다. 설정된 모듈들은 이전에 프로젝트 구조 만들기에서 체크했었던 모듈들입니다.
install(Routing) : todo()라는 함수를 호출하였습니다. Routing 모듈은 서버의 API Endpoint에 대한 설정입니다. todo() 함수의 내부는 다음 코드에서 확인하실 수 있습니다.
마지막으로 DatabaseInitializer.init()은 직접 작성한 데이터베이스 설정 초기화 코드입니다. DatabaseInitializer의 내부 코드도 이어서 확인해보겠습니다.
init : 함수 내부에선 Database.connect(HikariDataSource(hikariConfig()))를 사용하여 데이터베이스에 연결 합니다. 커넥션풀은 HikariCP를 사용하였습니다. 데이터베이스에 연결된 이후엔 transaction 내부에서 create(Todos)를 사용하여 Todos라는 테이블을 생성하게 됩니다. create는 Exposed에 포함된 SchemaUtils에 포함되어있으며, 테이블이 존재하지 않으면 자동으로 생성해줍니다.
hikariConfig : 기본적인 HikariCP 설정입니다. 예제에선 in-memory H2DB를 사용하였습니다.
query : block이라는 이름의 함수를 인자로 받아서 트랜잭션 범위에서 동작하게 만들었습니다. 이후에 보실 TodoService.kt에서 query 함수를 사용하게됩니다. 주목할 점은 suspend 키워드인데 사전적 의미는 연기하다, 중단하다라는 의미를 가진 단어입니다. suspend는 그 뜻처럼 코루틴 컨텍스트내에서 해당 함수를 일시중지, 재개할 수 있게 하는 일종의 표식(mark)입니다. 그러므로 withContext에 감싸진 block은 기본적으로 코루틴 스코프내에서 동작하게됩니다.
코루틴에 대한 자세한 설명은 이번 예제의 범주를 벗어납니다. 코루틴에 대해 알고싶으다면 이곳에서 확인해 주세요.
main/kotlin/entity/Todo.kt
package main.kotlin.entity
import org.jetbrains.exposed.dao.IntEntity
import org.jetbrains.exposed.dao.IntEntityClass
import org.jetbrains.exposed.dao.id.EntityID
import org.jetbrains.exposed.dao.id.IntIdTable
import org.jetbrains.exposed.sql.`java-time`.datetime
import java.time.LocalDateTime
// Table scheme
object Todos : IntIdTable() { // 1
val content = text("content").default("")
val done = bool("done").default(false)
val createdAt = datetime("created_at").index().default(LocalDateTime.now())
val updatedAt = datetime("updated_at").default(LocalDateTime.now())
}
// Entity
class Todo(id: EntityID<Int>) : IntEntity(id) { // 2
companion object : IntEntityClass<Todo>(Todos)
var content by Todos.content
var done by Todos.done
var createdAt by Todos.createdAt
var updatedAt by Todos.updatedAt
}
DAO 패키지에는 RDB의 테이블 구조와 매핑되는 Table이라는 최상위 클래스가 존재합니다. 이번 예제의 경우 PK인 id가 Int 타입이므로 Todos는 Table의 하위 클래스인 IntIdTable을 상속받았습니다. 이제 Todos 테이블에는 자동으로 id라는 이름의 PK가 생성됩니다.
Todo 클래스는 Todos 테이블과 매핑되는 엔티티 객체입니다. 마찬가지로 IntEntity를 상속받아서 id를 부모 클래스인 IntEntity에 인자로 넣어줍니다. 그리고 by 키워드를 사용하여 컬럼과 프로퍼티를 매핑해줍니다.
by는 원래 위임(Delegation)이라고 하는게 맞지만 매핑이 더 쉽게 이해할 수 있다고 생각하였습니다.
main/kotlin/model/TodoRequest.kt, TodoResponse.kt
package main.kotlin.model
import java.time.LocalDateTime
data class TodoRequest(val content: String,
val done: Boolean?,
val createdAt: LocalDateTime?,
val updatedAt: LocalDateTime?)
package main.kotlin.model
import main.kotlin.entity.Todo
import java.time.LocalDateTime
data class TodoResponse(val id: Int,
val content: String,
val done: Boolean,
val createdAt: LocalDateTime,
val updatedAt: LocalDateTime) {
companion object {
fun of(todo: Todo) =
TodoResponse(
id = todo.id.value,
content = todo.content,
done = todo.done,
createdAt = todo.createdAt,
updatedAt = todo.updatedAt
)
}
}
request, response에 대응하는 DTO를 정의하였습니다.
main/kotlin/TodoRouter.kt
package main.kotlin
import io.ktor.application.call
import io.ktor.features.BadRequestException
import io.ktor.http.HttpStatusCode
import io.ktor.request.receive
import io.ktor.response.respond
import io.ktor.routing.Routing
import io.ktor.routing.delete
import io.ktor.routing.get
import io.ktor.routing.post
import io.ktor.routing.put
import io.ktor.routing.route
import io.ktor.util.KtorExperimentalAPI
import main.kotlin.model.TodoRequest
import main.kotlin.service.TodoService
@KtorExperimentalAPI
fun Routing.todo(service: TodoService) { // 1
route("todos") { // 2
get {
call.respond(service.getAll())
}
get("/{id}") {
val id = call.parameters["id"]?.toIntOrNull()
?: throw BadRequestException("Parameter id is null")
call.respond(service.getById(id))
}
post {
val body = call.receive<TodoRequest>()
service.new(body.content)
call.response.status(HttpStatusCode.Created)
}
put("/{id}") {
val id = call.parameters["id"]?.toIntOrNull()
?: throw BadRequestException("Parameter id is null")
val body = call.receive<TodoRequest>()
service.renew(id, body)
call.response.status(HttpStatusCode.NoContent)
}
delete("/{id}") {
val id = call.parameters["id"]?.toIntOrNull()
?: throw BadRequestException("Parameter id is null")
service.delete(id)
call.response.status(HttpStatusCode.NoContent)
}
}
}
Routing.todo는 Ktor의 Routing 모듈에 대한 사용자 정의 확장 함수입니다. 만약 새로운 라우터를 만들고 싶으시다면 이처럼 Routing에 확장 함수를 제공하고 Main.kt에 정의한 함수를 등록해 주시면 됩니다.
route("todos")의 "todos"는 URL 접두사입니다. 예를 들어 주소창에 localhost:9999/todos/1234 라는 경로로 호출하게 되면 route("todos") 내부의 get("/{id}") 라우터 함수가 동작합니다. 예제에선 기본 CRUD에 대응하는 get, post, put, delete를 만들어 두었습니다.
수고하셨습니다. Ktor를 사용하여 Todo 서비스를 간단히 만들어 봤는데요 어떠신가요? 저는 Ktor를 공부하면서 이렇게 쉽게 서버를 개발할 수 있다는 것이 축복이라고 느껴질 정도였습니다. 특히 설정이 간편하고, 경량 서버이기 때문에 정말 빠르게 구동할 수 있었습니다. 이러한 장점들은 빠르게 배포하고 유연하게 확장하는 현대적 MSA 구조에도 아주 잘 맞는다고 할 수 있습니다.
또한, 코틀린을 좀 더 깊이 있게 사용해 볼 수 있는 기회가 됩니다. 이번 예제에서도 여러 가지 코틀린의 특징들을 간단하게나마 사용해 볼 수 있었습니다. 이런 특징들은 개발자로 하여금 좀 더 나은 코틀린 개발자로 성장하게 합니다.
사실 Ktor 외에도 정말 많은 경량 서버 프레임워크들이 출시되어 널리 사용되고 있습니다. 하지만 언어, 프레임워크, IDEA를 같은 회사에서 만들고 있는 경우는 흔치 않기 때문에 많은 개발자들이 Ktor의 성장 가능성을 높게 보고 있는 이유 중 하나입니다.
마지막으로 이번 예제는 최대한 심플하게 만들기 위해 핵심적인 부분만 구성하여 개발해봤습니다. 실무에서 사용하게 된다면 좀 더 유지보수를 고려한 구조로 개선할 필요가 있을겁니다. 개선사항은 직접 고민해보시기 바랍니다. 감사합니다.
독자분들의 이해를 돕기 위해 역자의 설명을 많이 추가하여 원본 글의 의도와는 다소 다를 수가 있으니 원본글도 같이 참고해주세요. 본문의 예제 코드 대부분은 Java10+ 문법을 기반으로 작성되었으나, 몇 개 예제는 Kotlin으로 작성되었습니다.
Javalin은 자바와 코틀린을 위한 경량 웹 프레임워크입니다. Javalin은 기본적으로 웹소켓, HTTP2 그리고 비동기 요청을 지원하며 구조가 심플하고 블로킹 모델로 설계되었습니다. 처음에는 SparkJava 프레임워크를 기반으로 만들어졌지만, 자바스크립트 프레임워크인Koa.js로부터 영향을 받아 재작성되었습니다.
Javalin은 제티(Jetty)위에서 돌아가며, 제티로만 작성한 코드와 성능이 동일합니다. 개발자는 기존의 Servlet와 같은 프레임워크 상에서 정의한 클래스를 확장한다거나 이와 유사한 형태의 에노테이션을 사용할 필요가 없습니다. 또한, 자바와 코틀린 둘 중 어떤 언어를 쓰더라도 동일한 Javalin을 사용할 수 있습니다.
자바로 Javalin을 시작할때 개발자는 아래의 코드와 같이 오직public static void main만 필요합니다.
Javalin.create().start(7000);부분은 내장된 제티 서버를 기반으로 실행되는 코드입니다. 덕분에 아주 심플하게 웹 애플리케이션 서버를 기동할 수 있습니다. 그리고 특정 URL에 대한 처리 부분도 특별한 어노테이션 등 없이 Path와 이를 처리하는 함수를 등록함으로써 쉽게 구현할 수 있습니다.
예제로 환경 설정 코드의 일부를 보겠습니다.
config로 바인딩한 부분이 기본적인 HTTP 설정들 이고, routes 함수를 보시면 path라는 함수안에 다시 get, post에 대응하는 함수가 있는것을 확인하실 수 있습니다. ws는 웹소켓 프로토콜을 지원하는 함수입니다.
Javalin위에서 패스 파라미터(path params), 쿼리 파라미터(query params) 그리고 폼 파라미터(form params)의 유효성을 체크하는 방법은 매우 단순합니다.
위 코드에서 보다시피 요청으로 들어온 파라미터를 쉽게 검증하고, 원하는 타입에 맞게 바인딩 할 수 있습니다.
Java의 RequestFilter나 Golang의 Middleware와 같이 여러 프레임워크에서 지원하는 Request의 앞, 뒤단에서 공통적으로 처리해야 하는 기능은 Handler라는 이름으로 제공합니다. Javalin은 before-handlers, endpoint-handlers, after-handlers, exception-handlers, error-handlers등 총 5개의 Handler가 있습니다.
위 코드는 각각의 Handler들이 어떤 시점에 동작하는지 알 수 있습니다. 각각의 Handler들은 개발할 때 정말 유용하게 사용할 수 있을거라 생각합니다.
Javalin에선 함수형 인터페이스(functional interface)인 액세스 매니저(AccessManager)를 제공하여 인증/인가(authentication/authorization)를 처리 할수 있습니다. 개발자는 원한다면 자신만의 액세스 매니저를 구현할 수 있습니다.
액세스 매니저를 설정합니다. 이것은 Spring security의 UserDetailsService를 구현하는것과 비슷합니다. 권한이 없는 요청인 경우 HTTP 401 Unauthorized를 응답으로 내려줍니다.
app.routes의 get("/un-secured")와 get("/secured") 부분을 보면 roles에 따라 요청을 분기하는것을 알 수 있습니다.
Javalin 3.0 버전부터 OpenAPI(Swagger)도 플러그인으로 제공합니다. OpenAPI 3.0 스펙의 전체 구현은 DSL과 에노테이션 두 가지 방법으로 이용 가능합니다.
OpenAPI DSL
OpenAPI 에노테이션
Javalin 애플리케이션을 배포하는데 개발자는 그저 의존성을 포함하는(maven-assembly-plugin 같은 플러그인을 이용하여) jar 파일을 만든 다음,java -jar filename.jar를 실행하기만 하면 됩니다. Javalin은 임베디드 제티를 포함하고 있어서 별도의 애플리케이션 서버는 필요하지 않습니다. 또한, 교육자를 위한 공식 페이지가 제공되고 있으며, 임베디드 제티가 포함되어 있기 때문에 서버 코딩에 필요한 서블릿 컨테이너(Servlet Container)/애플리케이션 서버 설정(Application Server configuration) 등과 같은 어려운 설정과 배경지식이 필요하지 않으므로 학습자가 쉽게 익힐 수 있다고 강조합니다.
