[Spring] application.yml 설정파일

Git에는 설정 파일인 yml파일을 올려야 하는 경우가 있는 데, 민감한 정보가 포함될 수 있다.

민감한 정보만 빼고 올리기 위해서 환경 변수로 설정해서 처리하면 가려진 채로 업로드가 가능하다. 

 

또, 여러 개의 Appllication으로 운영 상황에 맞는 yml을 추가로 작성하고 테스트 할 수 있다. 

아래에 deafult인 application.yml을 포함하여 local 환경, dev 환경, prod 환경에 맞는 yml 파일을 작성해주었다. 

 

운영 상황에 따라 맞게 테스트를 하기 위해서는 Run/Debug 의 Edit Configuration에 들어가서 알맞게 Application을 설정해주면 된다. 

 

--spring.profiles.active=local 은 application-local.yml의 설정 파일로 실행시킴을 의미한다. 

 

또, Environment variables로 환경 변수를 설정할 수 있다. (없으면 Modify options 들어가면 있음. 밑에 사진과 함께 더 설명되어 있음)

application-local.yml에 my.var에 환경 변수가 저장되는 데, 코드를 다음과 같이 올리면 민감한 정보여도 가려서 올릴 수 있게 된다. 

실제 코드는 아래에서 환경 변수로 등록한 local이 my.var에 저장되어 동작하게 된다. 

 

 

ApiController.java

package com.example.demo.controller;

import lombok.RequiredArgsConstructor;
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;



@RestController
@RequiredArgsConstructor
@RequestMapping("/api")
public class ApiController {
    private final Logger log = LoggerFactory.getLogger(ApiController.class);

    //Value 어노테이션을 통해 설정파일(application.yml)에서 값 불러올 수 있음
    @Value("${my.var}")
    private String var;

    @RequestMapping(method = RequestMethod.GET,value = "/app")
    public ResponseEntity req(){
        log.info("my var is {}", var);
        return ResponseEntity.ok().body("ok");
    }
}

 

 

application-local.yml 과 application-dev.yml을 적용시켜 실행한 결과이다. 

환경 변수에 각자 설정된 local과 dev가 저장되어 출력되는 것을 확인할 수 있다. 

---

 

이제 실제 프로젝트에다 적용해보자

application.yml

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

  datasource:
    url: jdbc:mysql://${DB_IP}/${DB_NAME}
    username: ${DB_USERNAME}
    password: ${DB_PW}
    driver-class-name: com.mysql.cj.jdbc.Driver

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

logging:
  level:
    org.springframework.security: DEBUG

database의 IP, DB이름과 DB username, password를 모두 환경 변수로 처리해주었다. 

환경 변수 설정은 다음처럼 할 수 있다.

 

환경 변수를 입력하는 칸이 뜨지 않는다면 Modify options > Environment variables 를 체크해준다. 

 

환경 변수는 ; (세미콜론)으로 구분하여 작성하면 된다. 

가장 오른쪽 버튼을 누르면 좀 더 쉽게 작성할 수 있다.