🚀 Spring Boot with Ktorm Demo Project

Spring Boot 환경에서 Kotlin ORM 프레임워크인 Ktorm의 활용 방법을 보여주는 데모 프로젝트입니다. Kotlin 개발자를 위한 Spring Boot 애플리케이션에서의 Ktorm 실전 활용 예제 제공이 목적입니다.

🧑‍💻 작성자 소개

안녕하세요! 15년차 백엔드 개발자 문금환입니다. 현재 프리랜서로 활동하고 있으며, 코틀린과 스프링을 주력으로 사용하고 있습니다. 더 나은 코드를 위해 항상 고민하고 새로운 기술을 탐구하는 것을 즐깁니다.

궁금하신 점이나 협업 제안이 있으시다면 언제든 연락 주세요.

연락처

• 이메일: [email protected]
• GitHub: @keumhwanmoon

기술 블로그

• Tistory
• Medium
• GitHub Pages

⚙️ 기술 스택

• Kotlin 1.9.21
• Spring Boot 3.2.2
• Ktorm 3.6.0 (Kotlin ORM)
• Spring Data JDBC 3.2.2
• Spring MVC 6.1.3
• Java 17 (OpenJDK 17.0.9)

🌟 주요 기능

📋 사용자 관리 (User Management)

Ktorm DSL을 활용한 CRUD 작업 구현

• 사용자 목록 조회 (GET /api/users)
• 사용자 상세 조회 (GET /api/users/{id})
• 사용자 생성 (POST /api/users)
• 사용자 수정 (PUT /api/users/{id})
• 사용자 삭제 (DELETE /api/users/{id})

SQL과 유사한 문법의 Ktorm DSL을 통한 데이터베이스 작업 수행 (예시: database.from(Users).select() 형태의 쿼리 작성)

🔖 코드 관리 (Code Management)

객체지향적 접근의 Entity Sequence API 활용

• 코드 목록 조회 (GET /api/codes)
• 코드 상세 조회 (GET /api/codes/{id})
• 코드 생성 (POST /api/codes)
• 코드 수정 (PUT /api/codes/{id})
• 코드 삭제 (DELETE /api/codes/{id})

Entity Sequence API를 통한 객체지향적 데이터 접근 방식 구현 (예시: database.sequenceOf(Codes).find() 형태의 엔티티 조회)

🚀 프로젝트 시작

✅ 필수 요구사항

• JDK 17 이상
• Gradle 8.5 이상

📥 설치 및 실행 방법

1. 프로젝트 복제

git clone https://github.com/keumhwanmoon/springboot-kotlin-ktorm-demo.git
cd springboot-kotlin-ktorm-demo

2. 프로젝트 빌드

./gradlew clean build

3. 애플리케이션 실행

./gradlew bootRun

💾 데이터베이스 구성

H2 인메모리 데이터베이스 사용

• resources/schema.sql: 테이블 스키마 정의
• resources/data.sql: 초기 데이터 설정

💡 Ktorm 활용 예시

DSL 방식 (UserService)

database.from(Users)
    .select()
    .map { row -> row.toUserRes() }

Sequence API 방식 (CodeService)

database.sequenceOf(Codes)
    .sortedBy { it.sortNumber }
    .map { it.toCodeRes() }

🔍 API 테스트 가이드

프로젝트의 /http 디렉토리에서 제공되는 HTTP 요청 파일을 통해 모든 API를 쉽게 테스트할 수 있습니다.

📋 테스트 환경 설정

각 HTTP 파일에서 사용되는 공통 환경 변수:

@host = localhost    // 서버 호스트
@port = 8080        // 서버 포트

🤝 프로젝트 참여

프로젝트 개선을 위한 다양한 의견 환영

• 버그 발견 시 GitHub Issue 등록 요청
• 새로운 기능 제안은 Pull Request 검토 후 반영
• 기타 문의사항은 이메일로 연락 가능

🔗 관련 프로젝트 추천

Exposed를 활용한 유사 프로젝트

Springboot Kotlin Exposed Demo

• Spring Boot와 Exposed를 활용한 데모 프로젝트
• Ktorm 대신 Exposed를 사용하여 구현된 유사한 기능
• 주요 차이점:
  • Exposed의 SQL DSL 문법 활용
  • Entity API 대신 Sequence API 사용
  • 더 풍부한 생태계와 레퍼런스 제공

기능 비교

기능	현재 프로젝트 (Ktorm)	Exposed 프로젝트
ORM 문법	SQL DSL + Entity API	SQL DSL + Sequence API
타입 안전성	✅	✅
코틀린 친화성	✅	✅
학습 곡선	낮음	중간
커뮤니티 규모	성장중	큼

이 두 프로젝트를 비교하면서 Kotlin ORM의 다양한 접근 방식을 학습할 수 있습니다. JetBrains에서 개발한 Exposed의 강력한 기능과 Ktorm의 직관적인 API를 각각 경험해보세요. 프로젝트의 규모와 요구사항에 따라 적절한 ORM을 선택할 수 있습니다.

📝 라이선스

본 프로젝트는 MIT 라이선스 적용. 상세 내용은 LICENSE 파일 참조.