TIL

섹션 8 외부 설정을 이용한 자동 구성

Environment 추상화와 프로퍼티

• 지금까지 스프링부트의 자동구성을 알아 보았다.

1. 자동 구성 후보 로딩
   1. MyAotoConfiguration.Imports
2. @Conditional Class 조건 체크
   1. 특정 Class가 존재하는가로 체크
   2. Starter, Dependency Classpath Class
3. @Conditional @Bean 조건 체크
   1. Configuration 클래스가 적용이 되면 하위 @Bean 메서드의 조건 체크
   2. MissingBean = false
      1. 커스텀 @Bean 구성정보가 있다면 사용
      2. 자동 구성 정보에 있는 빈은 무시
   3. MissingBean = true
      1. @MyAutoConfiguration + @Bean 구성 정보

• 자동 구성 정보에 들어 있는 빈 설정에는 대부분 디폴트 값이 들어 있다.
  • ex) 톰캣은 기본적으로 8080 포트를 사용
• 자동 구성 빈 설정은 Environment Properties에서 프로퍼티를 적용하여 설정을 세팅한다.

Environment Abstraction - Properties

• 애플리케이션이 동작하는 환경은 애플리케이션의 용도에 따라 달라질 수 있다.
  • 스프링은 거기에 맞춰 코드를 매번 수정하지 않도록 외부 설정을 변경할 수 있는 추상화를 제공한다.
• 스프링이 제공하는 추상화 종류
  • StandardEnvironment
    • System Properties
    • System Environment Variables
  • StandardServletEnvironment
    • ServletConfig Parameters
    • Servletcontext Parameters
    • JDNI
• SpringBoot가 제공하는 프로퍼티 추상화
  • @PropertySource - 커스텀하게 프로퍼티를 추가할 수 있는 애너테이션
  • application.perperties, xml, yml - 이 파일들을 통해 프로퍼티를 추가할 수 있다.
• 스프링이 제공하는 프로퍼티 추상화들에겐 우선순위가 존재한다.

자동 구성에 Environment 프로퍼티 적용

• 스프링 애플리케이션이 로딩 되었을 때 특정 동작을 수행하도록 할 수 있다.
• ApplicationRunner 인터페이스를 이용하면 된다.

@FunctionalInterface
public interface ApplicationRunner {
  void run(ApplicationArguments args) throws Exception;
}

• 함수형 인터페이스로 구현체를 빈으로 등록하면 스프링부트의 초기화 작업이 끝나면 run 메서드를 호출한다.
  • 아래 코드는 application.properties 파일에서 읽은 프로퍼티를 출력하는 간단한 역할을 수행한다.

@MySpringBootApplication
public class HellobootApplication {
  @Bean
  ApplicationRunner applicationRunner(Environment env) {
    return args -> {
      String name = env.getProperty("my.name");
      System.out.println("my.name: " + name);
    };
  }

  public static void main(String[] args) {
    SpringApplication.run(HellobootApplication.class, args);
  }
}

• 이러한 프로퍼티를 읽어들이는 데는 우선순위가 존재한다.
  • 프로퍼티 파일 < 환경 변수 (environment variable)
  • 환경 변수 < 시스템 프로퍼티
    • 시스템 프로퍼티: Java를 명령어로 실행할 때 -D 옵션으로 주는 값

자동 구성의 설정 값 변경하기

• 톰캣 설정과 같은 자동 구성 설정을 변경하려면 어떻게 해야할까?
• 아래 코드처럼 팩토리 메서드의 다양한 setter 메서드를 통해 변경할 수 있다.

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

• 하드 코딩이 아닌 프로퍼티 값을 읽어서 지정하려면 아래처럼 작성할 수 있다.

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {
  @Bean("tomcatWebServerFactory")
  @ConditionalOnMissingBean
  public ServletWebServerFactory servrWebServerFactory(Environment env) {
    TomcatServletServerFactory factory = new TomcatServletWebServerFactory();
    factory.setContextPath(env.getProperty("contextPath");
    return factory;
  }
}

@Value와 PropertySourcesPlaceholderConfigurer

• @Value 어노테이션으로 프로퍼티 파일의 env 값을 주입받을 수 있다.

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {
  @Value("${contextPath}")
  String contextPath;

  @Bean("tomcatWebServerFactory")
  @ConditionalOnMissingBean
  public ServletWebServerFactory servrWebServerFactory(Environment env) {
    TomcatServletServerFactory factory = new TomcatServletWebServerFactory();
    factory.setContextPath(this.contextPath);
    return factory;
  }
}

• 하지만 위 코드대로는 프로퍼티의 값이 제대로 주입되지 않는다.
  • 어노테이션의 치환자를 교체해 주는 작업은 스프링 컨테이너의 기본 동작 방식은 아니다.
  • 스프링 컨테이너를 확장해서 후처리 기능을 추가해야 한다.

@MyAutoConfiguration
public class PropertyPlaceholderConfig {
  @Bean
  PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
    return new PropertySourcesPlaceholderConfigurer();
  }
}

• PropertySourcesPlaceholderConfigurer는 BeanFactoryPostProcessor의 구현체다.
  • 빈 후처리기 - 프로세스가 진행되던 도중 후킹을 해서 앞에서 진행된 작업에 대한 부가적인 작업을 수행할 수 있게 해준다.
• 스프링에 로드되도록 MyAutoConfiguration.Imports에 추가해준다.

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

프로퍼티 클래스 분리

• 프로퍼티 값이 많이 필요하다면 @Value 어노테이션을 너무 많이 정의해야 한다.
  • 재사용도 어려워진다.

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {
  @Value("${contextPath}")
  String contextPath;
  
  @Value("${port:8080}") // 디폴트값이 필요한 경우
  int port;
  
  // ... 더 많은 프로퍼티?

  @Bean("tomcatWebServerFactory")
  @ConditionalOnMissingBean
  public ServletWebServerFactory servrWebServerFactory(Environment env) {
    TomcatServletServerFactory factory = new TomcatServletWebServerFactory();

    factory.setContextPath(this.contextPath);
    factory.setContextPath(this.port);
    
    return factory;
  }
}

• 별도의 프로퍼티 클래스를 분리해서 사용할 수 있다.

@Getter @Setter
public class ServerProperties {
  private String contextPath;
  
  private int port;
}

@MyAutoConfiguration
@ConditionalMyOnClass("org.apache.catalina.startup.Tomcat")
public class TomcatWebServerConfig {

  @Bean("tomcatWebServerFactory")
  @ConditionalOnMissingBean
  public ServletWebServerFactory servrWebServerFactory(ServerProperties properties) {
    TomcatServletServerFactory factory = new TomcatServletWebServerFactory();

    factory.setContextPath(properties.getContextPath());
    factory.setContextPath(properties.getPort());
    
    return factory;
  }
}

• ServerProperties에 값을 채우고, 스프링 빈으로 만들 필요가 있다.
  • Binder를 통해 프로퍼티 이름과 클래스의 필드 이름을 매칭하여 바인딩할 수 있다.

import org.springframework.boot.context.properties.bind.Binder;

@MyAutoConfiguration
public class ServerPropertiesConfig {
  @Bean
  public ServerProperties serverProperteis(Environment environment) {
    return Binder.get(environment).bind("", ServerProperteis.class).get();
  }
}

프로퍼티 빈의 후처리기 도입

• 프로퍼티가 생길 때마다 Binder를 통한 Config 클래스를 같이 계속 만들어야 하는 건 번거롭다.
  • Config 클래스도 Conditional에 따라 조건을 다르게 구성하는 작업도 복잡해질 수 있다.
  • ServerPropertiesConfig 없이 처리할 수 없을까?
• @Component 어노테이션으로 ServerProperteis를 빈으로 만들고 TomcatWebServerConfig에서 ServerProperteis를 @Import하면 빈 주입은 가능하다.
  • 하지만 이렇게 해도 ServerProperties 내부에 프로퍼티 값을 바인딩 하지는 못한다.
  • 빈으로 등록된 ServerProperties에 Binder를 이용해 프로퍼티를 바인딩하는 로직은 빈 후처리기로 처리할 수 있다.

@MyAutoConfiguration
public class PropertyPostProcessorConfig {
  @Bean
  BeanPostProcessor propertyPostProcessor(Environmnet env) {
    return new BeanPostProcessor() {
      @Override
      public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
      // 특정 어노테이션이 붙은 빈을 찾아 후 처리 로직을 수행할 수 있다.
        MyConfigurationProperties annotation = findAnnotation(bean.getClass(), MyConfigurationProperties.class);
        if (annotation == null) return bean;
        
        return Binder.get(env).bindOrCreate("", bean.getClass());
      }
    }
  }
}

@Getter @Setter
@MyConfigurationProperties // 내부에 @Component도 존재
public class ServerProperties {
  private String contextPath;
  
  private int port;
}

• port 같은 프로퍼티 이름은 다른 곳에서도 많이 쓰는 이름이라 그냥 사용하면 겹칠 수도 있다.
• prefix를 붙여 구분하려면 아래와 같이 어노테이션의 attribute로 설정하는 방법이 있다.
  • application.properties에도 server.contextPath, server.port로 적어줘야 한다.

@Getter @Setter
@MyConfigurationProperties(prefix = "server")
public class ServerProperties {
  private String contextPath;
  
  private int port;
}

• 빈 후처리기에서도 prefix를 다룰 수 있도록 한다.

@MyAutoConfiguration
public class PropertyPostProcessorConfig {
  @Bean
  BeanPostProcessor propertyPostProcessor(Environmnet env) {
    return new BeanPostProcessor() {
      @Override
      public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        MyConfigurationProperties annotation = findAnnotation(bean.getClass(), MyConfigurationProperties.class);
        if (annotation == null) return bean;
        
        Map<String, Object> attrs = getAnnotationAttributes(annotation);
        String prefix = (String) attrs.get("prefix");
        
        return Binder.get(env).bindOrCreate(prefix, bean.getClass());
      }
    };
  }
}