spring boot reactive 프로젝트를 위한 템플릿 입니다.
업데이트 기준일 : 2022년 9월 18일
작성기준일 : 2022년 12월 7일
- java 17
- Spring boot 3.0.0 (release 2022.11.24)
- gradle 7.5.1 (release 2022.08.05)
- QueryDSL 5.0.0
- flyway 9.8.2
- PostgreSQL Driver 42.5.1
- PostgreSQL R2DBC Driver 1.0.0.RELEASE
- restdocs 2.0.6.RELEASE
- junit jupiter 5.9.1, assertj 3.23.1
- testcontainers 1.17.6
- Java 17 베이스라인
- 실험적인 Spring Native 프로젝트를 대체하는 GraalVM으로 네이티브 이미지 생성 지원
- Micrometer 및 Micrometer Tracing 으로 관찰 가능성 향상
- EE 9 기준으로 Jakarta EE 10 지원
세부내용은 https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Release-Notes 을 참조하십시오.
spring boot 3.0.0 공식 문서를 번역한 내용을 정리해두었으니 참고하십시오.
Spring Boot 3.0.0 이 릴리즈 되면서 Java 17을 베이스로 지원하게 되었습니다 (https://spring.io/blog/2022/11/24/spring-boot-3-0-goes-ga).
Java 17은 Spring Boot 3 에서의 기준 언어이며 Spring Boot 3.0 에서는 Java 19 를 지원합니다. Java 17은 Java 11 대비 LTS 지원 기간이 2026년 9월까지 더 긴 지원을 보장합니다.
Spring Data JPA + JDBC를 사용하여 ORM 형태의 repository 구현 방식을 사용합니다.
일반적으로 사용되는 RDBMS는 PostgreSQL 입니다.
Spring Reactive Stack 의 R2DBC 를 이용한 repository 구현방식을 사용합니다.
일반적으로 사용되는 RDBMS는 PostgreSQL 입니다.
Spring Reactive Stack 의 MongoDB 를 이용한 repository 구현방식을 사용합니다.
아래의 테스팅 프레임워크를 기본적으로 사용합니다.
- junit5 (with mockito)
- org.assertj
- com.squareup.okhttp3:mockwebserver
이 spring boot 프로젝트 표준에서는 사용하고자 하는 모든 기술 스택에 대한 프레임워크 의존성과 설정, 예제코드 등이 작성되어 있습니다. 그리고 적용된 기술 스택에 대하여 함께 사용 가능한 것을 전제로 구성되어 있습니다. 예를 들어 JPA-Datasource와 MongoDB-Reactive 를 사용하여 모두 사용하는 것을 의미합니다.
새로운 프로젝트로 개발을 시작하고자 할 때 프로젝트 구성을 이해하고 사용하고자 하는 부분을 제외한 다른 의존성과 설정, 코드를 제거하고 사용하십시오.
4가지 profile 로 구분하고 각각의 용도를 구분합니다. Spring boot 컨테이너를 실행하거나 단위 테스트를 실행할 때 profile 이 지정되지 않은 경우는 모든 profile 상태에서 수행 결과가 동일함을 의미합니다.
가장 심플한 테스트를 위한 profile 입니다. 아래의 테스트 케이스에 대한 이 profile 을 사용합니다.
단위 테스트를 위한 profile 입니다. 쉽고 간결한 단위 테스트를 위하여 아래와 같은 제약 사항을 전제로 합니다.
- 외부 서비스에 대한 의존성이 없는 클래스 함수의 단위 테스트
- mocking 을 이용한 테스트
- 그 외 테스트를 수행함에 있어 실행되는 코드 외에 필요한 것이 없는 경우
외부 서비스 또는 프레임워크에 대한 의존성이 있는 경우에는 testcontainers 를 활용한 테스트를 작성 합니다. 이 경우 tc profile 을 사용하며 필요한 설정들을 추가하여 관리합니다.
local profile 을 이용한 테스트도 의존되는 외부 서비스 또는 프레임워크를 준비하여 사용하는 것은 비슷합니다. 하지만 tc profile 에서는 테스트 suite 단위로 의존 서비스가 준비되고 테스트가 종료되면 삭제됩니다. 의존 서비스가 휘발성을 가지는 것을 의미합니다.
개발과정에서 테스트 또는 디버깅을 위한 profile 입니다. 연계되는 타 서비스들을 로컬환경에 구축하여 설정합니다. 모든 서비스가 로컬에 구성되지만 실제와 동일한 서비스입니다.
개발서버 환경을 의미합니다. Spring boot 는 개발환경에서 실행하지만 DB 서버, 메시징 서버 등 연계 시스템은 개발서버 환경에 연결합니다.
일반적으로 통합테스트를 위한 설정입니다.
운영환경을 의미합니다. 운영환경에 필요한 설정만을 정의하고 debug 을 위한 설정을 제거합니다.
이 profile 은 개발단계에서는 사용되지 않으며 운영환경에 배포를 위하여 사용되는 profile 입니다.
test profile 을 이용하여 in-memory DB에 대한 테스트를 합니다. 하지만 in-memory DB 의 h2, embeded DB 의 경우에는 특정 벤더의 DBMS에 대한 테스트 신뢰성을 보장하지 못합니다.
tc profile 에 testcontainers 를 사용에 필요한 사항을 설정하고 이를 사용하여 테스트 케이스 수행시 사용할 수 있습니다.
- Controller, Service, Repository, Component 등 각각의 요소들은 각자의 테스트만 수행하고 주입되는 의존 클래스에 대한 것은 mock 객체를 사용하여 작성합니다.
- Controller 테스트는 클라이언트로부터 전달되는 request 의 처리와 response 에 대한 검증 테스트를 작성합니다.
- Service, component 테스트는 처리 프로세스 로직에 대한 테스트를 작성합니다.
- Repository 테스트는 DB에 대한 CRUD 가 올바르게 처리 되는가에 대한 테스트를 작성합니다.
테스트의 멱등성과 실제 사용 DBMS 에 대한 테스트 신뢰성을 위하여 Testcontainers (https://www.testcontainers.org/) 를 적용하였습니다. Testcontainers 를 이용한 테스트 케이스에서는 데이터의 롤백이나 사전 준비작업 등에 대한 처리를 하지 않아도 됩니다.
Testcontainers 를 이용한 테스트 케이스 작성을 강제하지 않습니다. 하지만 반복하여 테스트 실행을 할 수 있도록 구현해야 합니다. 테스트를 위한 별도의 서비스가 준비되어야 한다면 install 가이드와 준비과정에 대한 문서를 제공해야 합니다.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent