[Spring Boot]Scheduled duplicate 스케줄러 중복실행

 

 

 

 

 

📔Scheduled 너란 녀석

Scheduled 기능을 사용했었다면, 한 번쯤은 겪어가는 코스라고 생각한다.

특히나 이번에 Logback 기능을 추가 하며, Spring 스케줄러에서 로그가 두 번씩 찍히는 것을 보고 아차 싶었다.

📄원인?

📝스케줄러가 중복으로 실행되는 원인은 다양하게 있지만, Spring에서는 대표적으로 Bean 생성이 될 때 발생한다.

Bean은 순차적으로 @Configuration 어노테이션이 설정된 config Class 를 읽으며 이와 관련된 설정 파일(properties)들을 함께 불러오며 Bean을 등록하게 되는데(Create가 아니라 Register의 개념이다.) Context에서 스케줄러 Bean 을 등록하게되고, @Component 등의 어노테이션으로 인해 scan을 진행하면서 Bean 을 등록하니 두 번 선언이 되는 것이 아닌가!

 

같은 맥락으로 logback 과 같이 Spring에서 공식 지원하는 추가적인 모듈을 등록하는 경우에도, Auto Scan 을 한다.

(편의성에는 늘 대가가 따르지..)

 

Tomcat 이나 WebLogic 과 같은 WAS에서는 뭐.. 말할 것도 없지 않겠는가 ㅠㅡㅠ

 

아참! 동일한 이름을 가진 클래스(빈 등록할 컴포넌트)를 중복으로 등록할 일은 없지만.. 무심코 복붙한 파일을 사용한다면? ConflictingBeanDefinitionException  가 발생하니 주의하도록!!

---

📄해결(Solution)

📝Logback-spring.xml

일단 이 글을 작성하게 된 원인인 부분은 명확하게 파악했다. (오류가 아닌 것이기에 명확한 원인은 구조를 이해해야한다.)

"logback-spring.xml" 에서는  "logger" 를 정의하게 되어있다.

 

logger는 org.springframework(logger)와 root(프로젝트) 가 같은 appender를 사용하기 때문에 중복으로 발생하는 것이다!!

아래 예제를 보면 logger에 프로젝트 패키지 자체를 주입하였으므로.. 사실 상 root와 같다.

"logback-spring.xml"

    <!-- 예제 -->
    <!-- 기본 로그 설정 -->
    <root level="${LOG_ROOT_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </root>
    <!-- 프로젝트 로그 설정-->
    <logger name="kr.co.ooweat.springBatchApi" level="${LOG_ROOT_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </logger>

 

다행히 logback 에서는 옵션처리로 간단하게 진행할 수 있다.  additivity="false"

    <!-- 예제 -->
    <!-- 기본 로그 설정 -->
    <root level="${LOG_ROOT_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </root>
    <!-- 프로젝트 로그 설정-->
    <logger name="kr.co.ooweat.springBatchApi" level="${LOG_ROOT_LEVEL}" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </logger>

📚추가할 내용

같은 중복되는 원인이 발견될 때마다 바로 여기에 추가 작성하도록 해야겠다.