스프링 @Conditional

 

 

0️⃣ 예제 프로젝트 만들기 

스프링 부트가 제공하는 자동 구성에 대해서 알아보기 전에 

간단한 예제 프로젝트를 만들 것인데 이 예제 프로젝트는 실시간으로 자바 메모리 사용량을 웹으로 확인하는 예제이다. 

 

Memory

public class Memory
{
   private long used;
   private long max;
   
   public Memory(long used, long max)
   {
      this.used = used;
      this.max = max;
   }
   
   public long getUsed()
   {
      return used;
   }
   
   public long getMax()
   {
      return max;
   }
   
   @Override
   public String toString()
   {
      return "Memory{" +
            "used=" + used +
            ", max=" + max +
            '}';
   }
}

uesd는 현재 사용중인 메모리이고, max는 최대 메모리로 used가 max를 넘어가면 메모리 부족 오류가 발생하는 것이다. 

 

 

MemoryFinder

@Slf4j
public class MemoryFinder
{
   
   public Memory get()
   {
      long max = Runtime.getRuntime().maxMemory(); // JVM이 사용할 수 있는 최대 메모리
      long total = Runtime.getRuntime().totalMemory();  // JVM이 확보한 전체 메모리
      long free = Runtime.getRuntime().freeMemory();  /// JVM이 확보한 전체 메모리 중 사용하지 않은 것
      
      long used = total - free;
      
      return new Memory(used, max);
   }
   
   @PostConstruct
   public void init()
   {
      log.info("init MemoryFinder");
   }
}

MemoryFinder에서 이제 메모리 정보를 실시간으로 조회하는 기능이다. 

max : JVM이 사용할 수 있는 최대 메모리

total : JVM이 확보한 전체 메모리 (JVM이 처음부터 max까지 다 확보하는 것이 아니고 필요할 때 마다 조금씩 확보한다.)

free : total 중에서 사용하지 않은 메모리 (JVM이 확보한 전체 메모리 중에서 사용하지 않은 것) 

used : total - free 로 JVM이 사용중인 메모리이다. 

 

 

MemoryController

@Slf4j
@RestController
@RequiredArgsConstructor
public class MemoryController
{
   
   private final MemoryFinder memoryFinder;
   
   @GetMapping("/memory")
   public Memory system()
   {
      Memory memory = memoryFinder.get();
      log.info("memory = {}" , memory);
      
      return memory;
   }
}

MemoryController에서는 이제 메모리 정보를 조회하는 컨트롤러로 memoryFinder를 주입받아서 사용한다. 

 

 

MemoryConfig

@Configuration
public class MemoryConfig
{
   
   @Bean
   public MemoryController memoryController()
   {
      return new MemoryController(memoryFinder());
   }
   
   @Bean
   public MemoryFinder memoryFinder()
   {
      return new MemoryFinder();
   }
}

그리고 이제 MemoryConfig에 MemoryController와 MemoryFinder를 빈으로 등록해줬다.

 

빈으로 등록후 localhost:8080/memory를 실행하면 간단하게 메모리 사용량을 실시간으로 확인할 수 있다. 

 

 

 

1️⃣ Conditional 

이제 위에서 만든 프로젝트를 사용하는데 항상 메모리 조회 기능을 사용하는 것이 아니라 특정 조건일 때만 해당 기능이 활성화되도록 하고 싶다면?? 

스프링이 제공하는 @Conditional 어노테이션이 있다. 

-> 이 어노테이션은 같은 소스 코드인데 특정 상황일 때만 특정 빈들을 등록해서 사용하도록 도와주는 기능이다. 

(if문을 넣는것과 비슷하다.) 

 

Condition

@FunctionalInterface
public interface Condition {

   /**
    * Determine if the condition matches.
    * @param context the condition context
    * @param metadata the metadata of the {@link org.springframework.core.type.AnnotationMetadata class}
    * or {@link org.springframework.core.type.MethodMetadata method} being checked
    * @return {@code true} if the condition matches and the component can be registered,
    * or {@code false} to veto the annotated component's registration
    */
   boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);

}

matches 메서드가 true를 반환하면 조건이 만족하는 것으로 특정 기능을 동작하고, false를 반환하면 동작하지 않도록 한다. 

 

 

MemoryCondition 

@Slf4j
public class MemoryCondition implements Condition
{
   
   @Override
   public boolean matches(ConditionContext context,
         AnnotatedTypeMetadata metadata)
   {
      // -Dmemory=on
      String memory = context.getEnvironment().getProperty("memory");
      log.info("memory = {} ", memory);
      
      return "on".equals(memory);
   }
}

MemoryConditon은 Condition 인터페이스를 구현해서 자바 시스템 속성이 memory = on으로 설정된 경우에만 true를 반환해서 메모리 조회할 수있다. 

 

VM 옵션 설정에 -Dmemory=on 설정해주면 된다. 

 

그 다음 MemoryConfig 에서 @Conditional 어노테이션을 추가해준다. 

@Configuration
@Conditional(MemoryCondition.class)
public class MemoryConfig
{
   
   @Bean
   public MemoryController memoryController()
   {
      return new MemoryController(memoryFinder());
   }
   
   @Bean
   public MemoryFinder memoryFinder()
   {
      return new MemoryFinder();
   }
}

@Conditional(MemoryCondition.class) 

-> 이 어노테이션을 추가하고 나면 이제 메모리 조회 기능을 항상 실행할 수 있는 것이 아니라 특정 조건에 맞는 경우에만 실행할 수 있다.

즉, @Conditional에 지정한 MemoryConfig의 조건에 따라 true 인 경우에만 MemoryConfig가 적용 될 수 있다. 

 

MemoryCondition의 matches()를 실행해보고, 그 다음 결과가 true 이면 MemoryConfig가 정상 동작되고, MemoryController, MemoryFinder가 빈으로 등록된다. 

반대로 결과가 false 인 경우에는 MemoryConfig는 무효화 되어서 빈으로 등록되지 않는다. 

 

 

 

2️⃣ @Conditional의 다양한 기능 

위에서 보면 MemoryCondition이 Condition을 직접 구현해서 구현체를 만들었는데 사실 스프링은 이미 필요한 것을 제공하고 있다. 

 

MemoryConfig

@Configuration
//@Conditional(MemoryCondition.class)
@ConditionalOnProperty(name = "memory", havingValue = "on")
public class MemoryConfig
{
   
   @Bean
   public MemoryController memoryController()
   {
      return new MemoryController(memoryFinder());
   }
   
   @Bean
   public MemoryFinder memoryFinder()
   {
      return new MemoryFinder();
   }
}

@Conditional 어노테이션 대신 @ConditionalOnProperty(name = "memory", havingValue = "on") 어노테이션으로 바꿔주면 위에서 했던 것과 똑같이 동작한다! 

@ConditionalOnProperty 어노테이션을 보면 그 안에 @Conditional 어노테이션을 가지고 있는 것을 확인할 수 있다. 

그리고 OnPropertyCondition 클래스를 보면 Condition을 구현하고 있는 것도 확인할 수 있다. 

 

 

💌 스프링이 제공하는 @ConditionalOnXxx

- @ConditionalOnClass, @ConditionalOnMissingClass 

: 클래스가 있는 경우에 동작한다, 없는 경우에 동작한다. 

 

- @ConditionalOnBean, @ConditionalOnMissingBean

: 빈이 등록되어 있는 경우에 동작한다, 없는 경우에 동작한다. 

 

- @ConditionalOnProperty 

: 환경 정보가 있는 경우에 동작한다. 

 

- @ConditionalOnResource

: 리소스가 있는 경우에 동작한다. 

 

- @ConditionalOnWebApplication, @ConditionalOnNotWebApplication

: 웹 애플리케이션인 경우에 동작한다, 아닌 경우에 동작한다.