스프링 부트 앱에 초기화 코드를 넣는 방법 3가지

💡이 포스팅은 토비 님의 유튜브 영상인 스프링 부트 앱에 초기화 코드를 넣는 방법 3가지을 시청하고 학습한 내용을 정리한 포스팅입니다.

 
토비 님의 영상을 시청하며 정리한 GitHub Repository입니다.

GitHub - kiekk/study-spring-boot-inject-initializer-code

 

바로 본론부터 들어가면 스프링 부트 앱에 초기화 코드를 넣는 방법은 아래와 같이 크게 3가지 방법이 있습니다.

• CommandLineRunner
• ApplicationRunner
• @EventListener

 

CommandLineRunner

먼저 CommandLineRunner interface를 통해 초기화 코드를 넣는 방법에 대해 알아보겠습니다.

CommandLineRunner를 확인해 보면 run() 메서드 하나를 가지고 있으며, String [] 형태로 파라미터가 전달됩니다.
설명을 조금 더 살펴보면 파라미터에는 main() 메서드의 인자들이 전달된다고 하며 이때 인자는 모두 String 형태로 전달됩니다.
 
보통 개발자들은 key=value 형태로 전달하는 것을 선호하는데 CommandLineRunner를 사용하게 되면 key=value 형태로 인자를 전달하여도 
"key=value" 형식의 문자열로 인자가 전달되기 때문에 이를 직접 key=value로 파싱 하는 작업을 개발자가 직접 해야 한다는 단점이 있습니다.
 
그래서 위에 설명을 보면 만약 raw String [] 형태가 아닌 ApplicationArguments 형식으로 접근하고 싶다면 ApplicationRunner를 사용하라고 권장하고 있습니다.
 

ApplicationRunner

ApplicationRunner를 사용하면 CommandLineRunner를 사용할 때의 단점을 해결할 수 있습니다.

ApplicationRunner를 확인해 보면 CommandLineRunner와 동일하게 run() 메서드 하나를 가지고 있지만, 파라미터 형태가 다릅니다.
String [] 형태가 아닌 ApplicationArguments 객체를 파라미터로 전달받고 있습니다.
 
ApplicationArguments를 확인해 보면 interface로 되어 있으며 DefaultApplicationArguments라고 한 개의 구현체가 있습니다.

앞서 CommandLineRunner를 사용하면 전달된 인자를 가지고 key=value 형태로 파싱 하는 작업을 개발자들이 직접 해야 한다고 했었는데,
DefaultApplicationArguments 객체가 바로 이 작업을 대신 수행해 줍니다.
대신 인자를 전달하는 방법을 다르게 해야 하는데, 이때 등장하는 개념이 CommandLine Arguments와 CommandLine Option Arguments입니다.
 
CommandLineRunner에서 전달했던 raw String 형태의 인자들을 CommandLine Arguments라고 하며 ApplicationArguments에 의해 key=value로 파싱 되는 인자들을 CommandLine Option Arguments라고 합니다.
 
CommandLine Option Arguments로 전달하기 위해서는 인자에 --와 같이 하이픈 2개를 사용한 후 key=value 형태로 작성해야 합니다.
SimpleCommandLinePropertySource 객체를 확인해 보면 이에 관해 자세하게 설명이 되어 있습니다.

CommandLine Option Arguments는 반드시 --optName[=optValue] 형태로 작성되어야 하며 =를 기준으로 양 옆에 띄어쓰기가 되어 있으면 안 된다고 합니다.
 
정리하면 --없이 전달되는 인자들은 CommandLine Arguments, --를 사용하여 전달되는 인자들은 CommandLine Option Arguments라고 할 수 있습니다.

testA: CommandLine Arguments
testA=testB: CommandLine Arguments

--testA: CommandLine Option Arguments
-- testA=testB: Command Line Option Arguments

그래서 ApplicationArguments의 구현체인 DefaultApplicationArguments 객체를 사용하면 인자들을 key=value 형태로 사용할 수 있는데 파싱 하지 않은 raw String [] 형태의 CommandLine Arguments도 사용할 수 있도록 하고 있습니다.

DefaultApplicationArguments

getSourceArgs()
CommandLine Arguments를 반환한다.

getOptionNames()
CommandLine Option Arguments의 name들을 반환합니다.
--foo=bar --debug의 경우 ["foo", "debug"]가 Set 형태로 반환됩니다.

getOptionValues(String name)
name에 해당하는 Arguments의 값들을 반환합니다.
--foo=bar의 경우 ["bar"]가, --foo=bar,baz의 경우 ["bar", "baz"]가 List 형태로 반환됩니다.

getNonOptionArgs()
CommandLine Option Arguments가 아닌 인자들을 반환합니다.
--foo=bar testA testB=B의 경우 ["testA", "testB=B"]가 List 형태로 반환됩니다.

 

@EventListener

마지막 방법으로는 @EventListener annotation을 사용하는 방법이 있습니다. @EventListener를 사용하게 되면 CommandLineRunner, ApplicationRunner를 구현한 구현체를 작성할 필요 없이 어떤 Event에 의해 실행될지 그리고 실행할 method만 작성하면 됩니다.

@EventListener(ApplicationReadyEvent.class)
public void init() {
    System.out.println("Hello ApplicationReadyEvent");
}

@EventListener annotation에는 ApplicationEvent 타입을 작성하면 되는데 Spring Boot에서 미리 구현해 놓은 Event 객체들이 존재합니다.

@EventListener
public void init(ApplicationReadyEvent event) {
    System.out.println("Hello ApplicationReadyEvent : " + event);
}

그리고 위와 같이 Event 객체를 파라미터로 전달받는 경우에는 @EventListener annotation에 Event 클래스를 생략할 수 있습니다.
또 아래와 같이 여러 Event가 발생할 때 해당 method가 실행될 수 있도록 설정할 수도 있으며, 하나의 Event에 의해 여러 method가 실행될 수 있도록 설정할 수도 있습니다.

// Multi Event Listener - 1. 여러 Event를 하나의 Method에서 수신하기
@EventListener({ ApplicationReadyEvent.class, MyEvent.class })
public void init() {
    System.out.println("Hello ApplicationReadyEvent || Hello My Event");
}

// Multi Event Listener - 2. 하나의 Event를 여러 Method에서 수신하기
// EventListener 는 기본적으로 Broadcasting 이다.
@EventListener(MyEvent.class)
public void onMyEvent(MyEvent event) {
    System.out.println("Hello My Event: " + event.getMessage());
}

@EventListener(MyEvent.class)
public void onMyEvent2(MyEvent event) {
    System.out.println("Hello My Event2: " + event.getMessage());
}