application.yml 작업 환경 분리 방법

환경분리의 필요성

실제 배포할 서비스라면,
개발 서버와 운영 서버를 나눠서 관리할 필요가 있다.
추가적으로 테스트 환경도 분리해주면 좋고,
JPA를 사용한다면 ddl-auto: create 를 사용하는
초기 환경세팅도 분리해두면 운영 서버에서 create가 실행되는
대참사를 예방가능하다.

환경분리하는 방법

환경분리 방법을 찾아보니 크게 두 가지이다.

1. yml 파일 나누기
2. 하나의 yml 파일 안에서 나누기

기본 환경 세팅

JPA와 스프링부트2.7.1로 기본 환경을 구성

Entity는 간단하게 User 를 만들어두고,

실행해보니 포트 8080으로 잘 실행되고,
ddl-auto: create 설정에 맞게 테이블이 생성된다.

db에도 잘 생성이 된다.

이제 환경을 분리해보자.

yml 파일 나누기

application.yml

server:
  port: 8080

spring:
  profiles:
    default: dev # 기본 환경을 dev로

  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/profiledemo?serverTimezone=Asia/Seoul
    username: root
    password: abcd

  jpa:
    hibernate:
      ddl-auto: update
    properties:
      hibernate:
        format_sql: true
    show-sql: true

application-create.yml

server:
  port: 8081

spring:
  config:
    activate:
      on-profile: create # 환경이름설정

  jpa:
    hibernate:
      ddl-auto: create

application-dev.yml

server:
  port: 8082

spring:
  config:
    activate:
      on-profile: dev

  jpa:
    hibernate:
      ddl-auto: update

application-prod.yml

server:
  port: 8083

spring:
  config:
    activate:
      on-profile: prod

  jpa:
    hibernate:
      ddl-auto: none

세가지 파일을 만들었습니다.
기본 yml 설정에 작성한 내용들에게
추가로 profile에 작성한 내용들이 덮어쓰기 되는 방식이다.

여기서는 port 번호와 ddl-auto 설정만 바꿨는데,
datasource 세팅이나 다른 설정들도 작성하여 바꿀 수 있다.

인텔리제이에서 Edit Configurations로 들어가서
Active profiles 부분에 원하는 profile명을 입력하면
해당 세팅으로 실행된다.

아무 설정 없이 실행하면 default로 설정해둔 dev 세팅으로 실행된다.
포트8082로 잘 실행되었다!

이번엔 create 세팅으로 실행해보자.
포트 8081로 실행되며 ddl-auto: create가 적용된다.

prod 세팅도 잘 실행된다. (포트 8083)

yml 하나로 나누기

application.yml

server:
  port: 8080

spring:
  profiles:
    default: dev # 기본 환경을 dev로

  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/profiledemo?serverTimezone=Asia/Seoul
    username: root
    password: abcd

  jpa:
    hibernate:
      ddl-auto: update
    properties:
      hibernate:
        format_sql: true
    show-sql: true

---
server:
  port: 8081

spring:
  config:
    activate:
      on-profile: create # 환경이름설정

  jpa:
    hibernate:
      ddl-auto: create

---
server:
  port: 8082

spring:
  config:
    activate:
      on-profile: dev

  jpa:
    hibernate:
      ddl-auto: update

---
server:
  port: 8083

spring:
  config:
    activate:
      on-profile: prod

  jpa:
    hibernate:
      ddl-auto: none

하나의 yml 파일로 나눌때에는
--- 로 나눠서 작성하면 된다.

yml 파일 작성법만 다를뿐 실행하는 방법이나 실행 결과는 여러 yml일때와 똑같이 하면된다.

테스트 환경 나누기

테스트 환경 나누기는 test 폴더에 resources 폴더를 생성해 주시고
application.yml 파일을 만들어 주자.

파일을 만들어만 두면 테스트 실행시 테스트용 환경세팅으로 실행된다.

그리고 JPA의 경우 테스트 application.yml에서 datasource를 아에 입력하지 않으면,
자동으로 H2 db로 세팅된다.(H2 의존성 추가는 해줘야함)

마무리

스프링 부트 예전버전2.4이전에서는

spring:
  profiles: dev

방식으로 profile 이름설정을 했다고 한다.