스프링 부트의 @Conditional 어노테이션

스프링 부트는 다양한 조건에 따라 빈을 생성하거나 설정을 적용할 수 있는 강력한 조건부 설정 기능을 제공합니다. 이 기능을 활용하면, 환경에 따라 애플리케이션의 동작을 유연하게 제어할 수 있습니다. 이번 글에서는 @Conditional 어노테이션과 스프링 부트에서 제공하는 여러 @ConditionalOnXxx 어노테이션들을 자세히 살펴보겠습니다.

 

@Conditional 어노테이션

@Conditional 어노테이션은 특정 조건이 만족될 때만 빈을 등록하거나 설정을 적용하도록 도와줍니다. 이 어노테이션을 사용하기 위해서는 조건을 정의하는 Condition 인터페이스를 직접 구현해야 합니다. 예를 들어, 다음과 같이 특정 프로파일에 따라 빈을 등록하는 코드를 작성할 수 있습니다:

import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;

@Configuration
@Conditional(MyProfileCondition.class)
public class ProfileConfig {

    @Bean
    public MyService myService() {
        return new MyService();
    }
}

 

• 위의 코드는 MyProfileCondition 클래스의 조건을 만족할 때만 ProfileConfig 설정이 적용됩니다.

@ConditionalOnProperty

스프링 부트는 개발자가 자주 사용하는 조건을 더 쉽게 적용할 수 있도록 다양한 @ConditionalOnXxx 어노테이션을 제공합니다. 그 중 하나가 @ConditionalOnProperty입니다. 이 어노테이션은 특정 프로퍼티가 설정되어 있는지, 그리고 해당 프로퍼티의 값이 지정된 값과 일치하는지를 검사합니다.

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;

@Configuration
@ConditionalOnProperty(name = "featureX.enabled", havingValue = "true")
public class FeatureXConfig {

    @Bean
    public FeatureXService featureXService() {
        return new FeatureXService();
    }
}

 

• 위의 코드는 featureX.enabled 프로퍼티의 값이 true일 때만 FeatureXConfig 설정이 적용됩니다. 내부적으로 @Conditional과 Condition 인터페이스를 사용하여 구현됩니다.

package org.springframework.boot.autoconfigure.condition;

@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
    // 어노테이션 정의
}

 

다양한 ConditionalOnXxx 어노테이션

스프링 부트는 다양한 상황에서 조건부 설정을 적용할 수 있도록 여러 @ConditionalOnXxx 어노테이션을 제공합니다. 여기서는 대표적인 몇 가지를 소개합니다.

@ConditionalOnClass, @ConditionalOnMissingClass

• @ConditionalOnClass: 특정 클래스가 클래스패스에 존재할 때 설정을 적용합니다.
• @ConditionalOnMissingClass: 특정 클래스가 클래스패스에 존재하지 않을 때 설정을 적용합니다.

@ConditionalOnBean, @ConditionalOnMissingBean

• @ConditionalOnBean: 특정 빈이 스프링 컨텍스트에 존재할 때 설정을 적용합니다.
• @ConditionalOnMissingBean: 특정 빈이 스프링 컨텍스트에 존재하지 않을 때 설정을 적용합니다.

@ConditionalOnResource

• @ConditionalOnResource: 특정 리소스가 클래스패스에 존재할 때 설정을 적용합니다.

@ConditionalOnWebApplication, @ConditionalOnNotWebApplication

• @ConditionalOnWebApplication: 애플리케이션이 웹 애플리케이션일 때 설정을 적용합니다.
• @ConditionalOnNotWebApplication: 애플리케이션이 웹 애플리케이션이 아닐 때 설정을 적용합니다.

@ConditionalOnExpression

• @ConditionalOnExpression: SpEL 표현식에 만족할 때 설정을 적용합니다.

 

결론

 

스프링 부트의 @Conditional 및 다양한 @ConditionalOnXxx 어노테이션을 활용하면, 애플리케이션의 설정을 환경에 따라 유연하게 제어할 수 있습니다. 이를 통해 더 효율적이고 유지보수하기 쉬운 애플리케이션을 개발할 수 있습니다.

 

더 자세한 정보는 Spring Boot 공식 문서(https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.developing-auto-configuration.condition-annotations)
에서 확인할 수 있습니다. 다양한 조건부 설정을 잘 활용하여 더 나은 스프링 부트 애플리케이션을 개발하시길 바랍니다.

 

 

[참조]

스프링 부트 - 핵심 원리와 활용