TIL

섹션 7. 조건부 자동 구성

스타터와 Jetty 서버 구성 추가

• 어떤 조건을 걸어서 Tomcat 서버를 쓸지, 다른 서블릿 컨테이너를 쓸지 선택해 보려고 한다.
  • Jetty 서버 구성을 사용
• 우리가 지금까지 Tomcat 서버를 사용할 수 있었던건 spring-starter 의존성에 Tomcat 의존성이 포함되어 있기 때문이다.
  • springboot 몇 버전을 쓰면 Tomcat은 몇 버전을 쓴다 등의 부트의 자기 주장이 강하게 반영되어 있다.

dependencies {
  implementation 'org.springframework.boot::spring-boot-starter-web'
}

• Jetty는 starter에 포함되어 있지 않기에 아래 의존성을 추가한다.

dependencies {
  implementation 'org.springframework.boot::spring-boot-starter-web'
  implementation 'org.springframework.boot::spring-boot-starter-jetty'
}

• Tomcat을 띄웠던 것처럼 Jetty도 서블릿 웹 서버 팩터리를 빈으로 등록시킬 수 있다.
  • 빈 이름은 기본적으로 빈 설정 메서드 이름을 따라가기에 TomcatServletWebServerFactory 빈 이름과 충돌을 피하기 위해 이름을 따로 지정

@MyAutoConfiguration
public class TomcatWebServerConfig {
  @Bean("tomcatWebServerFactory")
  public ServletWebServerFactory servrWebServerFactory() {
    return new TomcatServletWebServerFactory();
  }
}

@MyAutoConfiguration
public class JettyWebServerConfig {
  @Bean("jettyWebServerFactory")
  public ServletWebServerFactory servletWebServerFactory() {
    return new JettyServletWebServerFactory();
  }
}

• tobyspring.config.MyAutoConfiguration.imports 내부에도 jetty 설정을 추가

tobyspring.config.autoconfig.DispatcherServletConfig
tobyspring.config.autoconfig.TomcatWebServerConfig
tobyspring.config.autoconfig.JettyWebServerConfig

• 이 상태에서 서버를 실행하면 에러가 발생하여 애플리케이션이 뜨지 않는다.
  • 여러 ServletWebServerFactory가 존재하기 때문

@Conditional과 Condition

• 조건부로 빈을 띄울 때 @Conditional을 사용할 수 있다.
• @Conditional은 Condition 인터페이스 구현체 클래스를 엘리먼트로 가진다.

@MyAutoConfiguration
@Conditional(JettyWebserverConfig.JettyCondition.class)
public class JettyWebServerConfig {
  @Bean("jettyWebServerFactory")
  public ServletWebServerFactory servletWebServerFactory() {
    return new JettyServletWebServerFactory();
  }
  
  // boolean 반환 여부에 따라 빈을 띄우거나 띄우지 않음
  static class JettyCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
      return true
    }
  }
}

• TomcatWebServerConfig에는 반대로 false를 반환하는 Condition 구현체를 @Conditional로 등록하면 Jetty 서버가 뜨게 된다.
  • 둘 다 true르 반환하면 이전과 똑같은 이유로 애플리케이션이 뜨지 않는다.

커스텀 @Conditional

• 무엇을 기준으로 Tomcat, Jetty 중 하나를 선택할 수 있을까?
  • 스프링부트가 자동 구성에서 대표적으로 사용하는 방법은 어떤 라이브러리가 이 프로젝트에 포함되어 있는가
  • 어떤 클래스가 존재하는지를 확인하면 라이브러리를 포함하는지 여부를 알 수 있다.
  • 각 라이브러리가 있다는 가정 하에 Tomcat의 경우 Tomcat.java 클래스 자체가, Jetty의 경우 Server.java 클래스가 jetty.server 패키지 하위에 존재한다.
• Spring에는 ClassUtils 클래스가 존재하는데 이걸 사용해서 특정 클래스가 존재하는지를 알 수 있다.

@MyAutoConfiguration
@Conditional(TomcatWebServerConfig.TomcatCondition.class)
public class TomcatWebServerConfig {
  @Bean("tomcatWebServerFactory")
  public ServletWebServerFactory servrWebServerFactory() {
    return new TomcatServletWebServerFactory();
  }
  
  static class TomcatCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
      return ClassUtils.isPresent("org.apache.catalina.startup.Tomcat", 
        context.getClassLoader());
    }
  }
}

@MyAutoConfiguration
@Conditional(JettyWebserverConfig.JettyCondition.class)
public class JettyWebServerConfig {
  @Bean("jettyWebServerFactory")
  public ServletWebServerFactory servletWebServerFactory() {
    return new JettyServletWebServerFactory();
  }
  
  static class JettyCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
      return ClassUtils.isPresent("org.eclipse.jetty.server.Server", 
        context.getClassLoader());
    }
  }
}

• 현재 이 프로젝트에는 Tomcat과 Jetty 의존성이 모두 있기 때문에 오류가 날 것이다.
• 각 의존성을 없애면서 실행해보면 각 서버가 잘 뜨는 것을 확인할 수 있다.

dependencies {
  implementation 'org.springframework.boot::spring-boot-starter-web' {
    exclude group: 'org.springframework.boot', module: 'sppring-boot-starter-tomcat'
  }
  implementation 'org.springframework.boot::spring-boot-starter-jetty'
}

• Conditional을 메타 어노테이션으로 만들어 사용할 수 있다.
  • 어노테이션 element로 클래스 이름을 받아 처리해보자

@Rentention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Conditional(MyOnClassCondition.class)
public @interface ConditionalMyOnClass {
  String value(); // 있는지 체크할 클래스 이름
}

public class MyOnClassCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
      Map<String, Object> attrs = metadata.getAnnotationAttribute(ConditionalMyOnClass.class());
      String value = (String) attrs.get("value");
      
      return ClassUtils.isPresent("value", context.getClassLoader());
    }
}

• 위 메타 어노테이션은 아래처럼 사용할 수 있다.

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {
  @Bean("tomcatWebServerFactory")
  public ServletWebServerFactory servrWebServerFactory() {
    return new TomcatServletWebServerFactory();
  }
}

@MyAutoConfiguration
@ConditionalMyOnClass("org.eclipse.jetty.server.Server")
public class JettyWebServerConfig {
  @Bean("jettyWebServerFactory")
  public ServletWebServerFactory servletWebServerFactory() {
    return new JettyServletWebServerFactory();
  }
}

• 스프링부트는 위 방식으로 ‘gradle 의존성 추가 → 클래스가 존재 → 빈 등록’의 논리 구조로 자동 구성을 수행한다.

자동 구성 정보 대체하기

• 우리가 만약 직접 만든 Custom한 서블릿 컨테이너를 사용하고 싶다면 어떻게 해야 할까?
  • 인프라 빈으로 만들어 스프링부트 내부 자동 구성정보에 끼워 넣어야 할까? → 그럴 필요는 없다.
  • 사용자 구성 정보에 빈으로 등록하여 자동 구성 정보에 있는 서블릿 빈을 대체하도록 할 수 있다.
• tobyspring.helloboot 패키지 하위에 WebServerConfiguration 클래스를 만든다.
  • 포트가 9090으로 뜨는 커스텀 서블릿 컨테이너를 띄우기 위해

@Configuration(proxyBeanMethods = false)
public class WebServerConfiguration {
  @Bean
  ServletWebServerFacotry customerWebServerFacotry() {
    TomcatServletWebServerFactory sf = new TomcatServletWebServerFactory();
    sf.setPort(9090);
    return sf;
  }
}

• 이대로 애플리케이션을 가동시키면 또 서블릿 컨테이너가 2개라서 에러가 발생한다.
• @ConditionalOnMissingBean로 이미 동일 타입 빈이 존재하면 뜨지 않도록 설정할 수 있다.
  • 우리가 자동 구성 정보를 설정할 때 DefaultImportSelecter를 사용했는데 이는 사용자 구성 정보가 로딩이 된 뒤 자동 구성 정보를 구성한다.
  • 때문에 아래처럼 설정하면 사용자쪽에서 등록한 인프라 빈이 먼저 적용되고, 자동 구성쪽에선 빈으로 등록되지 않는다.

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {
  @Bean("tomcatWebServerFactory")
  @ConditionalOnMissingBean
  public ServletWebServerFactory servrWebServerFactory() {
    return new TomcatServletWebServerFactory();
  }
}

스프링 부트의 @Conditional

• 스프링의 @Profile도 @Conditional 애노테이션이다.

@Conditional(ProfileCondition.class)
public @interface Profile {
// ...
}

Class Conditions

• 스프링부트는 아래의 @Conditional 애노테이션과 Condition을 제공한다.
  • @ConditionalOnClass
  • @ConditionalOnMissingClass
• 지정한 클래스의 프로젝트 내 존재를 확인하여 포함 여부를 결정한다.
• 주로 @Configuration 클래스 레벨에서 사용하지만 @Bean 메서드에도 적용 가능
  • 단 클래스 레벨 검증 없이 @Bean 메서드에만 적용하면 불필요하게 @Configuration 클래스가 빈으로 등록되기에 클래스 레벨 사용을 우선하면 좋다.

Bean Conditions

• 빈 존재 여부를 기준으로 포함 여부를 결정한다.
  • @ConditionalOnBean
  • @ConditionalOnMissingBean
• 컨테이너의 빈 정보를 기준으로 체크하기에 @Configuration 클래스 적용 순서가 중요
  • 개발자의 커스텀 빈 구성 정보가 자동 구성 정보보다 우선하기에 이 관계에 적용하는 것은 안전
  • @Configuration 클래스 레벨의 @ConditionalOnClass와 @Bean 메서드 레벨의 @ConditionalOnMissingBean 조합이 대표적

Property Conditions

• @ConditionalOnProperty
  • 스프링 환경 프로퍼티 정보를 이용
  • 지정된 프로퍼티가 존재하고 값이 false가 아니면 포함 대상이 된다.
  • 프로퍼티가 존재하지 않을 때 조건을 만족하게 할 수도 있다.

Resource Conditions

• @ConditionalOnResource
  • 지정된 리소스(파일)의 존재를 확인하는 조건

Web Application Conditions

• 웹 애플리케이션 여부를 확인한다.
  • @ConditionalOnWebApplication
  • @ConditionalOnNotWebApplication

SpEL Expression Conditions

• @ConditionalOnExpression
  • 스프링 SpEL(스프링 표현식)의 처리 결과를 기준으로 판단
  • 메우 상세 조건 설정이 가능