스프링 외부 설정 방법 (OS 환경 변수, 자바 시스템 속성)

 

 

0️⃣ 외부 설정이란 ? 

보통 실무에서 개발을 하다보면 대부분 회사에서 운영 서버와 개발 서버를 나눠서 개발을 진행한다. 

먼저 개발 서버에서 개발하고, 테스트를 진행 후 정상적으로 동작한다는 것을 확인한 후에 실제 고객에게 서비스 하는 운영 환경에 배포를 하는 방식으로 진행한다. 

 

개발 환경 : 개발 서버, 개발 DB

운영 환경: 운영 서버, 운영 DB

 

이런식으로 DB도 다른 각각 다른 것을 사용해서 진행해주는데 그러면 각각 환경에 따라서 DB URL , username 등등의 설정이 조금씩 다르게 된다. 

환경에 따라 다른 설정 값을 사용하기 위해서 빌드 후 각 환경에 맞춰 실행 시점에 외부 설정값을 주입해주면 된다. 

 

배포 환경과는 상관없이 빌드는 한번만 진행하고, 그 다음 실행 시점에 환경에 따라 설정값을 외부에서 주입받으면 된다. 

 

 

 

1️⃣ 외부 설정 방법 

외부 설정하는 방법으로는 4가지 정도가 있다. 

- OS 환경 변수: OS 에서 지원하는 외부 설정, 해당 OS를 사용하는 모든 프로세스에서 사용 
- 자바 시스템 속성 : 자바에서 지원하는 외부 설정, 해당 JVM 안에서 사용 
- 자바 커맨드 라인 인수 : 커맨드 라인에서 전달하는 외부 설정, 실행 시 main(args) 메서드에서 사용
- 외부 파일(설정 데이터) : 프로그램에서 외부 파일을 직접 읽어서 사용 

 

 

 

2️⃣ 외부 설정 방법 :  OS 환경 변수 

OS 환경 변수 설정은 해당 OS를 사용하는 모든 프로그램에서 읽을 수 있는 설정값이어서 사용 범위가 제일 넓다. 

 

* 조회 방법 

윈도우 : set 

-> 현재 OS에 설정된 환경 변수 값들을 출력한다. 

 

* 설정 방법

(자바 설치해봤다면 JAVA_HOME 설정같은거 해봤을텐데 이와 동일하게 환경변수 설정해주면 된다.) 

 

 

*  자바에서 OS 환경 변수 설정 값 읽는 방법 

@Slf4j
public class OsEnv
{
   public static void main(String[] args)
   {
      Map<String, String> envMap = System.getenv();
      for (String key : envMap.keySet())
      {
         log.info("env {} = {}", key, System.getenv(key));
      }
   }
}

System.getenv() 하면 전체 OS 환경 변수를 Map으로 조회할 수 있다. 

System.getenv(key) 를 사용하면 특정 OS 환경 변수의 값을 조회할 수 있다. 

 

만약 OS 환경변수에 값을 설정해서 이용하고 싶다면 환경변수 설정한 다음 System.getenv("설정값") 넣어주면 설정 값을 읽어서 사용할 수 있다. 

 

 

❗ 근데 os 환경 변수는 자바 프로그램뿐만 아니라 다른 프로그램에서도 사용할 수 있게 되기 때문에 이 어플리케이션을 이용하는 자바 프로그램에서만 이 설정 값을 사용하고 싶다면 다른 방법으로 설정해야 한다. 

 

 

 

3️⃣ 외부 설정 방법 : 자바 시스템 속성 

자바 시스템 속성(Java System Properties) 은 실행한 JVM 내에서 접근 가능한 외부 설정이다. 

자바 시스템 속성은 자바 프로그램을 실행할 때 사용하는데 

java -Durl=aaa -jar XXX.jar 

이런식으로 -D 옵션을 통해서 key = value 형식으로 주면 된다. 

 

* 자바 시스템 속성 읽어오는 방법 

@Slf4j
public class JavaSystemProperties
{
   public static void main(String[] args)
   {
      Properties properties = System.getProperties();
      
      for (Object key : properties.keySet())
      {
         log.info("prop {} = {}", key, System.getProperty(key.toString()));
      }
      
      String url = System.getProperty("url");
      String username = System.getProperty("username");
      String password = System.getProperty("password");
      
      log.info("url = {} ", url);
      log.info("username = {} ", username);
      log.info("password = {} ", password);
   }
}

System.getProperties() 를 사용하면 Map 형식으로 key=vaule 형식의 properties 를 받고 자바 시스템 속성을 조회할 수 있다. 

System.getProperty(key) 를 사용하면 속성값을 조회할 수 있다. 

 

그리고 url, username, password 자바 시스템 속성을 읽어오는 코드도 함께 있다. 

url, username, password 속성을 읽어오기 위해서는 자바 시스템을 실행할 때 속성을 지정해줘야 한다. 

이렇게 지정해주고 apply 후 실행해보면 

-D 옵션을 통해 추가한 자바 시스템 속성을 확인할 수 있다. 

 

 

위에 방식은 인텔리제이에서 직접 속성을 추가한 것이고, jar 로 실행할 때는 

java -Durl=devdb -Dusername=hj -Dpassword=1231 -jar XXX.jar 

이런식으로 자바 시스템 속성을 추가할 수 있다. 

 

실행할 때 속성을 추가할 수 도 있고, System.setProperty(propertyKey, propertyValue) 로 지정해서 조회할 수 도 있다. (근데 이건 코드 안에 직접 설정하는거라 환경 분리해서 각각 다른 설정을 얻어올 수는 없다.)