[Spring Boot - 🐱PetClinic🐶] 2. application.properties 살펴보기🔍

쑤밍·2023년 4월 10일

[Spring Boot - 🐱PetClinic🐶]

목록 보기

2/11

📘 Pet Clinic의 application.properties

Spring Boot의 설정사항들은 application.properties에 기술돼있다. Pet Clinic의 application.properties에서는 다음과 같은 설정들이 존재한다. 주의할 점은 build.gradle이나 pom.xml에 관련 모듈에 대한 의존을 설정해야 사용할 수 있다는 점이다.

Database Init
Web
JPA
Internationalization
Acturator
Logging
Minimum time static resoureces should be cached

🗂 Database init

데이터베이스 관련 사항들을 설정한다. 이와 관련된 글을 따로 작성할 예정이다.

database=h2
spring.sql.init.schema-locations=classpath*:db/${database}/schema.sql
spring.sql.init.data-locations=classpath*:db/${database}/data.sql

기본적으로 H2 DB를 사용한다. 각각 schema.sql, data.sql의 경로를 지정해준다. 어플리케이션을 시작할 때 schema.sql, data.sql을 사용하여 데이터베이스를 초기화한다.

🌐 Web

템플릿 엔진을 설정한다. Pet Clinic에서는 Thymeleaf를 사용한다.

spring.thymeleaf.mode=HTML

📋 JPA

JPA 관련 설정이다.

spring.jpa.hibernate.ddl-auto=none
spring.jpa.open-in-view=true

spring.jpa.hibernate.ddl-auto 옵션

JPA를 사용할 때 데이터베이스를 초기화하는 전략에 관한 설정값이다. 옵션값으로 none, validate, update, create, create-drop 등이 있다.

none - 아무것도 하지 않음
validate - 엔티티와 테이블이 정상적으로 매핑이 됐는지만 확인
update - 변경한 부분만 반영
create - 스키마 삭제 후 생성
create-drop - 스키마 삭제 후 생성, 종료 시 삭제

실제 운영하는 데이터베이스는 create/create-drop/update를 사용하면 안 된다. create나 update는 개발 초기에, 테스트 서버에서는 update나 validate를 사용하고, 실제 배포 시엔 validate나 none을 사용한다고 한다.

spring.jpa.open-in-view 옵션

영속성 컨텍스트의 지속 범위를 설정하는 옵션이다. 관례상 OSIV라고 한다. 옵션값으로 true/false 두 가지가 존재한다. 영속성 컨텍스트의 지속 범위를 트랜잭션 범위로 한정할 것인지(false 옵션) 트랜잭션 범위 넘어서까지 지속할 것인지(true 옵션)를 결정한다. Pet Clinic에선 true 옵션을 주고 있다.

✉️ Internationalization

스프링의 메시지를 사용하기 위한 설정이다.

spring.messages.basename=messages/messages

메시지에 사용할 파일을 지정해준다. Pet Clinic의 경우 src/main/resources의 하위에 messages/messages.properties 파일을 이용한다.

Spring이라면 ResourceBundleMessageSource를 직접 빈에 등록해주어야 쓸 수 있지만, Spring Boot의 경우 이미 등록이 돼 있어 application.properties에서 메시지로 사용할 파일만 지정해주면 사용할 수 있다.

messages-kr.properties 등의 파일을 추가하면 클라이언트의 언어 설정에 따라 메시지를 변경할 수 있다.

📈 Acturator

Acturator는 어플리케이션 모니터링을 위해 Spring Boot에서 제공하는 자체 모니터링 툴이다. 어플리케이션 모니터링을 위한 endpoint를 설정할 수 있다. endpoint는 모니터링 요소 정도로 이해하면 될 것 같다. 다음과 같이 입력하면 모든 endpoint에 대한 모니터링을 제공한다는 뜻이다.

management.endpoints.web.exposure.include=*

하지만 이처럼 모든 정보를 모니터링할 수 있게 설정하면 민감한 정보에 접근할 수 있기 때문에 실제 배포환경에서는 필요한 정보만을 모니터링할 수 있도록 적절한 설정이 필요하다. 권한이 있는 사용자만 접근할 수 있도록 하는 조치도 고려할 수 있다. 또한, 실제 운영 상황에서 이를 활용하기 위해서는 DB나 파일에 저장하는 것이 좋다.

📃 Logging

콘솔에 보여질 로그를 설정하는 옵션이다.

logging.level.org.springframework=INFO
#logging.level.org.springframework.web=DEBUG
#logging.level.org.springframework.context.annotation=TRACE

이처럼 설정하면 기본적으로 INFO level의 로그만 출력하게 하고, 필요에 따라 주석을 해제해서 사용할 수 있도록 했다. 이는 Spring Boot에서 기본적으로 제공하는 Logback을 이용한 설정이다. 필요에 따라 다른 라이브러리를 사용할 수 있지만 Logback도 다른 라이브러리에 뒤지지 않을 만큼 괜찮은 성능을 가지고 있다고 한다.

로그 레벨은 ERROR - WARN - INFO - DEBUG - TRACE의 다섯 단계가 있다.

ERROR: 요청을 처리하는데 오류가 생긴 경우
WARN: 처리가 가능하지만 향후 시스템에 문제가 생길 여지가 있는 경우
INFO: 상태 변경과 같은 정보성 로그
DEBUG: 프로그램 디버깅을 위한 로그
TRACE: DEBUG보다 더 상세한 정보를 나타내는 로그

첫 번째 주석을 해제하면 springframework의 web 패키지의 항목들에 DEBUG level의 로그를 볼 수 있고, 두 번째 주석을 해제하면 springframework의 context 중 annotation 항목들에 TRACE level의 로그를 볼 수 있다.

필요에 따라 파일로 저장하는 것도 지원하지만, Pet Clinic에서는 따로 파일로 저장하도록 설정하지 않았다.

📄 Minimum time static resoureces should be cached

spring.web.resources.cache.cachecontrol.max-age=12h

정적 자원들의 캐시 유효기간을 설정하는 옵션이다. 기본 단위는 초 단위지만 위의 설정은 12h인 걸 보니 12시간인 것 같다. Http 응답에 포함되는 Cache-control 헤더에 따라 받은 리소스의 생명주기가 결정된다고 한다. 위의 설정은 기본 캐시 정책을 결정하는 옵션이다. 캐시의 유효기간이 너무 짧으면 서버에 리소스 요청을 너무 자주 하게 되어 서버에 부하가 올 수 있고, 유효기간이 너무 길면 만료될때까지 브라우저에 리소스가 남아있고 이를 지우는 게 어렵기 때문에 적절한 max-age의 설정이 중요하다.

🧩 마무리

Pet Clinic의 설정 파일을 살펴봤다. 이 파일 하나를 해석하는데도 수십번의 검색이 필요했다. 무지성으로 클론 코딩하면 모를 것들이겠지.. '하나하나 알아가다 보면 언젠간 도움이 되겠지'라고 생각하며 마치겠다. 어제보다 나은 오늘, 그리고 오늘보다 나은 내일이 되길 바라며...

** 자세한 내용은 참고 링크에 적혀있다. 참고 링크의 내용을 그대로 가져오거나 내가 또 정리하는 건 예의가 아닌 것 같아 필요한 부분들만 조금씩 내가 이해한 대로 필요한 만큼만 적었다. 참고 링크를 활용하여 더 깊게 학습하는 것도 좋을 것 같다.

** 오타, 잘못된 내용 지적 환영