[스프링 핵심 원리와 활용] #6. 자동 구성(Auto Configuration) #837
Develop-KIM
started this conversation in
동환
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
@Conditional예시) 개발 서버에서 확인 용도로만 해당 기능을 사용하고, 운영 서버에서는 해당 기능을 사용하지 않는 것이다.
@Conditional이다.Condition
matches()메서드가true를 반환하면 조건에 만족해서 동작하고,false를 반환하면 동작하지 않는다.ConditionContext: 스프링 컨테이너, 환경 정보등을 담고 있다.AnnotatedTypeMetadata: 애노테이션 메타 정보를 담고 있다.Condition인터페이스를 구현해서 다음과 같이 자바 시스템 속성이memory=on이라고 되어 있을 때만 메모리 기능이 동작하도록 만들어보자.MemoryCondition
memory=on이라고 되어 있는 경우에만true를 반환한다.MemoryConfig - 수정
@Conditional(MemoryCondition.class)MemoryConfig의 적용 여부는@Conditional에 지정한MemoryCondition의 조건에 따라 달라진다.MemoryCondition의matches()를 실행해보고 그 결과가true이면MemoryConfig는 정상 동작한다.따라서
memoryController,memoryFinder가 빈으로 등록된다.MemoryCondition의 실행결과가false이면MemoryConfig는 무효화 된다.그래서
memoryController,memoryFinder빈은 등록되지 않는다.실행 결과
Whitelabel Error Pagememory=on을 설정하지 않았기 때문에 동작하지 않는다.다음 로그를 통해서
MemoryCondition조건이 실행된 부분을 확인할 수 있다. 물론 결과는false를 반환한다.-Dmemory=on를 사용해야 한다.실행 결과
MemoryCondition조건이true를 반환해서 빈이 정상 등록된다.로그
@Conditional - 다양한 기능스프링에서 제공하는
@ConditionalMemoryConfig - 수정
@ConditionalOnProperty(name = "memory", havingValue = "on")memory=on이라는 조건에 맞으면 동작하고, 그렇지 않으면 동작하지 않는다.@ConditionalOnProperty@ConditionalOnProperty도 우리가 만든 것과 동일하게 내부에는@Conditional을 사용한다.그리고 그 안에
Condition인터페이스를 구현한OnPropertyCondition를 가지고 있다.정리
스프링 부트가 제공하는 자동 구성 기능을 이해하려면 다음 개념을 이해해야 한다.
@Conditional: 특정 조건에 맞을 때 설정이 동작하도록 한다.@AutoConfiguration: 자동 구성이 어떻게 동작하는지 내부 원리 이해순수 라이브러리 만들기
Memory
MemoryFinder
MemoryController
MemoryFinderTest
빌드하기
./gradlew clean buildbuild/libs/memory-v1.jarjar -xvf memory-v1.jarJAR를 푼 결과
META-INFMANIFEST.MFmemoryMemoryFinder.classMemoryController.classMemory.classmemory-v1.jar는 스스로 동작하지는 못하고 다른 곳에 포함되어서 동작하는 라이브러리이다.순수 라이브러리 사용하기
라이브러리 추가
project-v1/libs폴더를 생성memory-v1프로젝트에서 빌드한memory-v1.jar를 이곳에 복사project-v1/build.gradle에memory-v1.jar를 추가files로 지정하면 된다.라이브러리 설정
MemoryConfig
메모리 조회 기능이 잘 동작하는지 확인
로그
정리
그것을 또 하나하나 빈으로 등록해야 한다. 지금처럼 간단한 라이브러리가 아니라 초기 설정이 복잡하다면 사용자 입장에서는 귀찮은 작업이 될 수 있다.
자동 구성 라이브러리 만들기
settings.gradle - 수정
자동 구성 추가
MemoryAutoConfig
@AutoConfiguration@ConditionalOnPropertymemory=on이라는 환경 정보가 있을 때 라이브러리를 적용한다. (스프링 빈을 등록한다.)자동 구성 대상 지정
파일 생성
src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.importsorg.springframework.boot.autoconfigure.AutoConfiguration.imports
memory.MemoryAutoConfig를 패키지를 포함해서 지정해준다.org.springframework.boot.autoconfigure.AutoConfiguration.imports의 정보를 읽어서 자동 구성으로 사용한다. 따라서 내부에 있는MemoryAutoConfig가 자동으로 실행된다.빌드하기
./gradlew clean buildbuild/libs/memory-v2.jar자동 구성 라이브러리 사용하기
라이브러리 추가
project-v2/libs폴더를 생성memory-v2프로젝트에서 빌드한memory-v2.jar를 이곳에 복사project-v2/build.gradle에memory-v2.jar를 추가files로 지정하면 된다.라이브러리 설정
project-v1에서는memory-v1을 사용하기 위해 스프링 빈을 직접 등록했다.project-v2에서 사용하는memory-v2라이브러리에는 스프링 부트 자동 구성이 적용되어 있다.따라서 빈을 등록하는 별도의 설정을 하지 않아도 된다.
memory-v2의 자동 구성에는 다음과 같이 설정했기 때문에memory=on조건을 만족할 때만 실행된다.실행 결과
정리
@ConditionalOnXxx덕분에 라이브러리 설정을 유연하게 제공할 수 있다.자동 구성 이해 - 스프링 부트의 동작
스프링 부트는 다음 경로에 있는 파일을 읽어서 스프링 부트 자동 구성으로 사용한다.
resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports직접 만든
memory-v2라이브러리와 스프링 부트가 제공하는spring-boot-autoconfigure라이브러리의다음 파일을 확인해보면 스프링 부트 자동 구성을 확인할 수 있다.
memory-v2 - org.springframework.boot.autoconfigure.AutoConfiguration.imports
memory.MemoryAutoConfigspring-boot-autoconfigure - org.springframework.boot.autoconfigure.AutoConfiguration.imports
이번에는 스프링 부트가 어떤 방법으로 해당 파일들을 읽어서 동작하는지 알아보자.
이해를 돕기 위해 앞서 개발한
autoconfig프로젝트를 열어보자.스프링 부트 자동 구성이 동작하는 원리는 다음 순서로 확인할 수 있다.
@SpringBootApplication@EnableAutoConfiguration@Import(AutoConfigurationImportSelector.class)스프링 부트는 보통 다음과 같은 방법으로 실행한다.
AutoConfigApplication
run()에 보면AutoConfigApplication.class를 넘겨주는데, 이 클래스를 설정 정보로 사용한다는 뜻이다.AutoConfigApplication에는@SpringBootApplication애노테이션이 있는데, 여기에 중요한 설정 정보들이 들어있다.@SpringBootApplication
여기서 우리가 주목할 애노테이션은
@EnableAutoConfiguration이다. 이름 그대로 자동 구성을 활성화 하는 기능을 제공한다.@EnableAutoConfiguration
@Import는 주로 스프링 설정 정보(@Configuration)를 포함할 때 사용한다.그런데
AutoConfigurationImportSelector를 열어보면@Configuration이 아니다.이 기능을 이해하려면
ImportSelector에 대해 알아야 한다.자동 구성 이해 - ImportSelector
@Import에 설정 정보를 추가하는 방법은 2가지가 있다.- 정적인 방법:
@Import(클래스) 이것은 정적이다. 코드에 대상이 딱 박혀 있다. 설정으로 사용할 대상을 동적으로 변경할 수 없다.- 동적인 방법:
@Import(ImportSelector) 코드로 프로그래밍해서 설정으로 사용할 대상을 동적으로 선택할 수 있다.정적인 방법
스프링에서 다른 설정 정보를 추가하고 싶으면 다음과 같이
@Import를 사용하면 된다.그런데 예제처럼
AConfig,BConfig가 코드에 딱 정해진 것이 아니라, 특정 조건에 따라서 설정 정보를 선택해야 하는 경우에는 어떻게 해야할까?동적인 방법
ImportSelector인터페이스를 제공한다.ImportSelector
ImportSelector 예제
HelloBean
HelloConfig
HelloBean을 스프링 빈으로 등록한다.HelloImportSelector
ImportSelector인터페이스를 구현했다.hello.selector.HelloConfig설정 정보를 반환한다.ImportSelectorTest
staticConfig()
staticConfig()는 이해하는데 어려움이 없을 것이다. 스프링 컨테이너를 만들고,StaticConfig.class를 초기 설정 정보로 사용했다. 그 결과HelloBean이 스프링 컨테이너에 잘 등록된 것을 확인할 수 있다.selectorConfig()
selectorConfig()는SelectorConfig를 초기 설정 정보로 사용한다.SelectorConfig는@Import(HelloImportSelector.class)에서ImportSelector의 구현체인HelloImportSelector를 사용했다.HelloImportSelector를 실행하고,"hello.selector.HelloConfig"라는 문자를 반환 받는다.hello.selector.HelloConfig이 설정 정보로 사용된다.HelloBean이 스프링 컨테이너에 잘 등록된 것을 확인할 수 있다.@EnableAutoConfiguration 동작 방식
@EnableAutoConfiguration
AutoConfigurationImportSelector는ImportSelector의 구현체이다. 따라서 설정 정보를 동적으로 선택할 수 있다.META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.importsmemory-v2 - org.springframework.boot.autoconfigure.AutoConfiguration.imports
spring-boot-autoconfigure - org.springframework.boot.autoconfigure.AutoConfiguration.imports
그리고 파일의 내용을 읽어서 설정 정보로 선택한다.
스프링 부트 자동 구성이 동작하는 방식은 다음 순서로 확인할 수 있다.
@SpringBootApplication->@EnableAutoConfiguration->@Import(AutoConfigurationImportSelector.class)resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports파일을 열어서 설정 정보 선택정리
스프링 부트의 자동 구성을 직접 만들어서 사용할 때는 다음을 참고하자.
@AutoConfiguration에 자동 구성의 순서를 지정할 수 있다.@AutoConfiguration도 설정 파일이다. 내부에@Configuration이 있는 것을 확인할 수 있다.resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports@AutoConfiguration을 제외하는AutoConfigurationExcludeFilter필터가 포함되어 있다.@SpringBootApplication
자동 구성이 내부에서 컴포넌트 스캔을 사용하면 안된다. 대신에 자동 구성 내부에서
@Import는 사용할 수 있다.자동 구성을 언제 사용하는가?
AutoConfiguration은 라이브러리를 만들어서 제공할 때 사용하고, 그 외에는 사용하는 일이 거의 없다.왜냐하면 보통 필요한 빈들을 컴포넌트 스캔하거나 직접 등록하기 때문이다. 하지만 라이브러리를 만들어서 제공할 때는 자동 구성이 유용하다.
실제로 다양한 외부 라이브러리들이 자동 구성을 함께 제공한다.
이럴 때 스프링 부트의 자동 구성 코드를 읽을 수 있어야 한다. 그래야 문제가 발생했을 때 대처가 가능하다.
자동화는 매우 편리한 기능이지만 자동화만 믿고 있다가 실무에서 문제가 발생했을 때는 파고들어가서 문제를 확인하는 정도는 이해해야 한다.
남은 문제
빈이 자동으로 다 등록이 되어 버린다면 이런 정보를 어떻게 입력할 수 있을까?
Beta Was this translation helpful? Give feedback.
All reactions