Spring Boot, @Value로 명령어 인자(커맨드 라인 아규먼트) 전달 및 사용하기

개요

• Spring Boot 기반 애플리케이션에서 명령어 인자(Command-Line Arguments)를 사용하는 방법을 설명하고자 한다.

Spring Boot와 명령어 인자 전달

• Spring Boot는 기본적으로 애플리케이션 실행시(java -jar {application}.jar) 전달된 —(마이너스 문자 2개) 문자로 시작하는 모든 명령어 인자(커맨드라인 아규먼트)를 인식하도록 되어 있다. 이 시점에 개발자가 추가로 해야할 작업은 없다.

전달된 명령어 인자의 사용

• 애플리케이션이 전달 받은 명령어 인자는 아래와 같이 스프링 빈으로 등록된 모든 클래스에서 정의하여 사용할 수 있다.

@Component
public class SomeSpringComponent {

    @Value("${some.option}")
    private String someOption;

    @Value("${some.option2:defaultValue}")
    private String someOption2;
    ...
}

• 전달된 명령어 인자는 @Value 어노테이션을 사용하여 스프링 빈의 변수로 주입하여 사용할 수 있다. 만약 애플리케이션 실행시 —some.option=someValue라는 명령어 인자를 전달했다면 ${some.option}을 명시하여 someValue 값을 주입할 수 있다.

• 만약 전달되지 않은 명령어 인자를 주입한다면? 주입 시점에 IllegalArgumentException 예외가 발생한다. 이 문제를 예방하기 위해 기본값을 주입할 수 있다. : 문자 뒤에 기본값을 명시하면 된다. 위 예제의 경우 defaultValue라는 값이 주입된다.

application.yml에서의 사용

• 전달된 명령어 인자는 application.yml에도 주입하여 사용할 수 있다.

foo:
  bar: ${some.option:defaultValue}

• 애플리케이션 실행시 —some.option=someValue 옵션을 주었다면 위 foo.bar=someValue가 주입 된다. 옵션을 주지 않았다면 foo.bar=defaultValue가 주입 된다. (IntelliJ IDEA 개발 환경에서는 Run > Edit Configurations > Program arguments 옵션에 해당 옵션을 명시하면 적용된다.)

참고 글

• Using Spring @Value with Defaults