[스프링 핵심 원리와 활용] 섹션6. 자동 구성 Auto Configuration(2)

[YONGHYNG]

@conditional

• 앞서 만든 메모리 조회 기능을 항상 사용하는 것이 아니라 특정 조건일 때만 해당 기능이 활성화 되도록 해보자.
• 예를 들어서 개발 서버에서 확인 용도로만 해당 기능을 사용하고, 운영 서버에서는 해당 기능을 사용하지 않는 것이다.
• 여기서 핵심은 소스코드를 고치지 않고 이런 것이 가능해야 한다는 점이다.
  • 프로젝트를 빌드해서 나온 빌드 파일을 개발 서버에도 배포하고, 같은 파일을 운영서버에도 배포해야 한다.
• 같은 소스 코드인데 특정 상황일 때만 특정 빈들을 등록해서 사용하도록 도와주는 기능이 바로 @Conditional이다.
• 참고로 이 기능을 스프링 부트 자동 구성에서 자주 사용한다.

@Condition 인터페이스를 살펴 보자

package org.springframework.context.annotation;

public interface Condition {
        boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

• matches() 메서드가 true 를 반환하면 조건에 만족해서 동작하고, false 를 반환하면 동작하지 않는다.
• ConditionContext : 스프링 컨테이너, 환경 정보등을 담고 있다.
• AnnotatedTypeMetadata : 애노테이션 메타 정보를 담고 있다.

Condition 인터페이스를 구현해서 다음과 같이 자바 시스템 속성이 memory=on 이라고 되어 있을 때만 메모리 기능이 동작하도록 만들어보자.

#VM Options
#java -Dmemory=on -jar project.jar

MemoryCondition

package memory;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

@Slf4j
public class MemoryCondition implements Condition {


    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metada) {
        String memory = context.getEnvironment().getProperty("memory");
        log.info("memory={}", memory);
        return "on".equals(memory);
    }
}

• 환경 정보에 memory=on 이라고 되어 있는 경우에만 true를 반환한다.

MemoryConfig - 수정

package hello.config;

import memory.MemoryCondition;
import memory.MemoryController;
import memory.MemoryFinder;

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

@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)
  • 이제 MemoryConfig의 적용 여부는 @conditional에 지정한 MemoryCondition의 조건에 따라 달라진다.
  • MemoryCondition의 matches()를 실행해보고 그 결과가 true 이면 MemoryConfig는 정상 동작한다. 따라서 memoryController, memoryFinder가 빈으로 등록된다.
  • MemoryCondition의 실행결과가 false이면 MemoryConfig는 무효화 된다. 그래서 memoryController, memoryFinder 빈은 등록되지 않는다.

참고

• 스프링은 외부 설정을 추상화해서 Environment로 통합했다. 그래서 다음과 같은 다양한 외부 환경 설정을 Environment 하나로 읽어들일 수 있다.

#VM Options
#java -Dmemory=on -jar project.jar
-Dmemory=on

#Program arguments
# -- 가 있으면 스프링이 환경 정보로 사용
#java -jar project.jar --memory=on
--memory=on

#application.properties
#application.properties에 있으면 환경 정보로 사용
memory=on

@conditional - 다양한 기능

• 지금까지 Condition 인터페이스를 직접 구현해서 MemoryCondition 이라는 구현체를 만들었다. 스프링은 이미 필요한 대부분의 구현체를 만들어두었다. 이번에는 스프링이 제공하는 편리한 기능을 사용해보자.

MemoryConfig - 수정

package hello.config;

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

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

• @conditional(MemoryCondition.class) 를 주석처리하자
• @ConditionalOnProperty(name = "memory", havingValue = "on")을 추가하자
  • 환경 정보가 memory=on 이라는 조건에 맞으면 동작하고, 그렇지 않으면 동작하지 않는다.

@ConditionalOnProperty

package org.springframework.boot.autoconfigure.condition;

@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {...}

• ConditionalOnProperty 도 우리가 만든 것과 동일하게 내부에는 @conditional을 사용한다. 그리고 그 안에 Condition 인터페이스를 구현한 OnPropertyCondition을 가지고 있다.

@ConditionalOnXxx

• 스프링은 @conditional 과 관련해서 개발자가 편리하게 사용할 수 있도록 수 많은 @ConditionalOnXxx 를 제공한다.

• @ConditionalOnClass , @ConditionalOnMissingClass

  • 클래스가 있는 경우 동작한다. 나머지는 그 반대

• @ConditionalOnBean , @ConditionalOnMissingBean

  • 빈이 등록되어 있는 경우 동작한다. 나머지는 그 반대

• @ConditionalOnProperty

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

• @ConditionalOnResource

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

• @ConditionalOnWebApplication , @ConditionalOnNotWebApplication

  • 웹 애플리케이션인 경우 동작한다.

• @ConditionalOnExpression

  • SpEL 표현식에 만족하는 경우 동작한다.

이름이 직관적이어서 바로 이해가 될 것이다. @ConditionalOnXxx 는 주로 스프링 부트 자동 구성에 사용된다.

다음 자동 구성 클래스들을 열어서 소스 코드를 확인해보면 @ConditionalOnXxx 가 아주 많이 사용되는 것을 확인 할 수 있다.
JdbcTemplateAutoConfiguration , DataSourceTransactionManagerAutoConfiguration ,DataSourceAutoConfiguration

참고
@conditional 자체는 스프링 부트가 아니라 스프링 프레임워크의 기능이다. 스프링 부트는 이 기능을 확장해서 @ConditionalOnXxx 를 제공한다.

정리
스프링 부트가 제공하는 자동 구성 기능을 이해하려면 다음 개념을 이해해야 한다.

• @conditional : 특정 조건에 맞을 때 설정이 동작하도록 한다.
• @autoConfiguration : 자동 구성이 어떻게 동작하는지 내부 원리 이해

순수 라이브러리 만들기

• @autoConfiguration 을 이해하기 위해서는 그 전에 먼저 라이브러리가 어떻게 사용되는지 이해하는 것이 필요하다. 든 실시간 자바 Memory 조회 기능이 좋다고 소문이 나서, 여러 프로젝트에서 사용하고 싶어한다. 이 기능을 여러곳에서 사용할 수 있도록 라이브러리로 만들어보자.

MemoryFinder

package memory;

import lombok.extern.slf4j.Slf4j;
import jakarta.annotation.PostConstruct;

@Slf4j
public class MemoryFinder {
    public Memory get() {
        long max = Runtime.getRuntime().maxMemory();
        long total = Runtime.getRuntime().totalMemory();
        long free = Runtime.getRuntime().freeMemory();
        long used = total - free;
        return new Memory(used, max);
    }
    
    @PostConstruct
    public void init() {
        log.info("init memoryFinder");
    }
}

MemoryController

package memory;

import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@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;
    }
}

MemoryFinderTest

package memory;

import org.junit.jupiter.api.Test;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;

public class MemoryFinderTest {
    
    @Test
    void get() {
        MemoryFinder memoryFinder = new MemoryFinder();
        Memory memory = memoryFinder.get();
        assertThat(memory).isNotNull();
    }
}

• memory-v1.jar 는 스스로 동작하지는 못하고 다른 곳에 포함되어서 동작하는 라이브러리이다. 이제 이 라이브러리를 다른 곳에서 사용해보자.

순수 라이브러리 사용하기1

HelloController

package hello;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "hello";
    }
}

결과 : hello

순수 라이브러리 사용하기2

주의

• 추가한 폴더 이름이 lib 가 아니라 libs 인 점을 주의하자!
• 파일로 추가한 라이브러리를 IntelliJ가 잘 인식하지 못하는 경우에는 다음과 같이 프로젝트를 다시 임포트
  하자

프로젝트 임포트

• File -> Open -> 해당 프로젝트의 build.gradle 을 선택하자. 그 다음에 선택창이 뜨는데, Open as Project를 선택하자.

라이브러리 설정

• 라이브러리를 스프링 빈으로 등록해서 동작하도록 만들어보자.

MemoryConfig

package hello.config;

import memory.MemoryController;
import memory.MemoryFinder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MemoryConfig {

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

}

• 스프링 부트 자동 구성을 사용하는 것이 아니기 때문에 빈을 직접 하나하나 등록해주어야 한다.

서버 실행 로그
MemoryFinder : init memoryFinder

결과
{"used": 38174528, "max": 8589934592}

정리

• 그런데 라이브러리를 사용하는 클라이언트 개발자 입장을 생각해보면, 라이브러리 내부에 있는 어떤 빈을 등록해야하는지 알아야 하고, 그것을 또 하나하나 빈으로 등록해야 한다. 지금처럼 간단한 라이브러리가 아니라 초기 설정이 복잡하다면 사용자 입장에서는 상당히 귀찮은 작업이 될 수 있다.
• 이런 부분을 자동으로 처리해주는 것이 바로 스프링 부트 자동 구성(Auto Configuration)이다.

자동 구성 라이브러리 만들기

• 프로젝트에 라이브러리를 추가만 하면 모든 구성이 자동으로 처리되도록 해보자. 쉽게 이야기해서 스프링 빈들이 자동으로 등록되는 것이다. 여기에 추가로 memory=on 옵션도 적용할 수 있게 해보자.

자동 구성 추가

MemoryAutoConfig

package memoryv2.memory;

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

@AutoConfiguration
@ConditionalOnProperty(name = "memory", havingValue = "on")
public class MemoryAutoConfig {

    @Bean
    public MemoryController memoryController() {
        return new MemoryController(memoryFinder());
    }

    @Bean
    public MemoryFinder memoryFinder() {
        return new MemoryFinder();
    }
}

• @AutoCinfiguration
  • 스프링 부트가 제공하는 자동 구성 기능을 적용할 때 사용하는 애노테이션
• @ConditionalOnProperty
  • memory=on 이라는 환경 정보가 있을 때 라이브러리를 적용한다.(스프링 빈을 등록한다.)
  • 라이브러리를 가지고 있더라도 상황에 따라서 해당 기능을 켜고 끌 수 있게 유연한 기능을 제공한다.

자동 구성 대상 지정

• 이 부분이 중요하다. 스프링 부트 자동 구성을 적용하려면, 다음 파일에 자동 구성 대상을 꼭 지정해주어야한다.

파일 생성

• src/main/resources/META-INF/spring/
• org.springframework.boot.autoconfigure.AutoConfiguration.imports

자동 구성 라이브러리 사용하기1

dependencies {
           implementation 'org.springframework.boot:spring-boot-starter-web'
           compileOnly 'org.projectlombok:lombok'
           annotationProcessor 'org.projectlombok:lombok'
           testImplementation 'org.springframework.boot:spring-boot-starter-test'
 }

• 스프링 부트에 다음 라이브러리 추가 Lombok, Spring Web

HelloController

package hello.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
 
                  @GetMapping("/hello")
                   public String hello() {
                   return "hello";
         }
}

자동 구성 라이브러리 사용하기2

라이브러리 추가

• project-v2/libs 폴더를 생성하자.
• memory-v2 프로젝트에서 빌드한 memory-v2.jar 를 이곳에 복사하자.
• project-v2/build.gradle 에 memory-v2.jar 를 추가하자.

dependencies {
           implementation files('libs/memory-v2.jar') //추가
           implementation 'org.springframework.boot:spring-boot-starter-web'
           compileOnly 'org.projectlombok:lombok'
           annotationProcessor 'org.projectlombok:lombok'
           testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

주의

• 추가한 폴더 이름이 lib 가 아니라 libs 인 점을 주의하자!
• 지금처럼 로컬에 파일로 추가한 라이브러리를 IntelliJ가 잘 인식하지 못하는 경우에는 다음과 같이 프로젝트를 다시 임포트 하자.
  • File -> Open -> 해당 프로젝트의 build.gradle 을 선택하자. 그 다음에 선택창이 뜨는데, Open as Project를 선택하자

라이브러리 설정

• 앞서 project-v1 에서는 memory-v1 을 사용하기 위해 스프링 빈을 직접 등록했다.
• project-v2 에서 사용하는 memory-v2 라이브러리에는 스프링 부트 자동 구성이 적용되어 있다. 따라서 빈을 등록하는 별도의 설정을 하지 않아도 된다.

정리

• 스프링 부트가 제공하는 자동 구성 덕분에 복잡한 빈 등록이나 추가 설정 없이 단순하게 라이브러리의 추가만으로 프로젝트를 편리하게 구성할 수 있다.
• @Conditional10nXxx 덕분에 라이브러리 설정을 유연하게 제공할 수 있다.
• 스프링 부트는 수 많은 자동 구성을 제공한다. 그 덕분에 스프링 라이브러리를 포함해서 수 많은 라이브러리를 편리하게 사용할 수 있다.