spring-boot
패키지 스캐닝

소개

매개 변수

@SpringBootApplication

좋은 자동 패키지 검색을 위해 스프링 부팅을 사용하여 코드를 구조화하는 가장 기본적인 방법은 @SpringBootApplication 주석을 사용하는 @SpringBootApplication 입니다. 이 주석은 @SpringBootConfiguration , @EnableAutoConfiguration , @ComponentScan ( Parameters 섹션의 각 주석에 대한 자세한 정보)과 같이 자동 스캔에 도움이되는 다른 세 가지 주석을 제공합니다.

@SpringBootApplication 은 @SpringBootApplication 주 패키지에 배치되고 다른 모든 구성 요소는이 파일 아래의 패키지에 배치됩니다.

com
 +- example
     +- myproject
         +- Application.java (annotated with @SpringBootApplication)
         |
         +- domain
         |   +- Customer.java
         |   +- CustomerRepository.java
         |
         +- service
         |   +- CustomerService.java
         |
         +- web
             +- CustomerController.java

달리 언급하지 않는 한, 스프링 부트는 스캔 된 패키지 아래에서 @Configuration , @Component , @Repository , @Service , @Controller , @RestController 주석을 자동으로 @RestController 합니다 ( @Configuration 및 @RestController 는 @Component 및 @Controller 로 주석을 달았 기 때문에 선택됩니다). ).

기본 코드 예 :

@SpringBootApplication
public class Application {

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

명시 적으로 패키지 / 클래스 설정

버전 1.3 이후로 당신은 또한 설정하여 특정 패키지를 스캔 스프링 부팅을 알 수 scanBasePackages 또는 scanBasePackageClasses 에 @SpringBootApplication 대신의 지정 @ComponentScan .

1. @SpringBootApplication(scanBasePackages = "com.example.myproject") - com.example.myproject 를 스캔 할 기본 패키지로 설정합니다.
2. @SpringBootApplication(scanBasePackageClasses = CustomerController.class) - scanBasePackages 대신 type-safe를 사용하면 CustomerController.java 패키지 com.example.myproject.web 을 스캔 할 기본 패키지로 설정합니다.

자동 구성 제외

또 다른 중요한 기능은 exclude 또는 excludeName ( excludeName 은 버전 1.3 이후로 존재)을 사용하여 특정 자동 구성 클래스를 exclude 하는 기능입니다.

1. @SpringBootApplication(exclude = DemoConfiguration.class) - 자동 패키지 검색에서 DemoConfiguration 을 제외합니다.
2. @SpringBootApplication(excludeName = "DemoConfiguration") - 완전히 분류 된 클래스를 사용하여 동일하게 수행합니다.

@ComponentScan

보다 복잡한 패키지 검색을 구성하려면 @ComponentScan 을 사용할 수 있습니다. 여러 @ComponentScan 주석을 집계하는 컨테이너 주석으로 작동하는 @ComponentScans 도 있습니다.

기본 코드 예제

@ComponentScan
public class DemoAutoConfiguration {
}

@ComponentScans({@ComponentScan("com.example1"), @ComponentScan("com.example2")})
public class DemoAutoConfiguration {
}

구성없이 @ComponentScan 을 지정하면 @SpringBootApplication 처럼 작동 @SpringBootApplication 주석으로 주석 된 클래스 아래에있는 모든 패키지를 검색합니다.

이 예제에서는 @ComponentScan 의 유용한 속성 중 일부를 설명합니다.

1. basePackages - 스캔 할 특정 패키지의 상태를 나타내는 데 사용할 수 있습니다.
2. useDefaultFilters -이 속성을 false (기본값 true)로 설정하면 spring이 @Component , @Repository , @Service 또는 @Controller 자동으로 검사하지 않도록 할 수 있습니다.
3. includeFilters - 패키지 스캔에 포함 할 특정 스프링 주석 / 정규식 패턴을 포함하는 데 사용할 수 있습니다.
4. excludeFilters은 - 패키지 검색에 포함 할 특정 스프링 주석 / 정규식 패턴을 제외 할 수 있습니다.

더 많은 특성이 있지만 패키지 검색을 사용자 지정하는 데 가장 많이 사용됩니다.

나만의 자동 구성 만들기

스프링 부트는 미리 만들어진 많은 자동 구성 부모 프로젝트를 기반으로합니다. 스프링 부트 스타터 프로젝트에 이미 익숙해야합니다.

다음과 같은 간단한 단계를 수행하여 자신의 스타터 프로젝트를 쉽게 만들 수 있습니다.

1. 일부 @Configuration 클래스를 작성하여 기본 bean을 정의하십시오. 사용자 정의가 가능하도록 @AutoConfigureBefore , @AutoConfigureAfter , @ConditionalOnBean , @ConditionalOnMissingBean 등과 같은 자동 구성 도우미 주석을 사용하려면 가능한 한 외부 속성을 사용해야합니다. 공식 문서에서 각 주석에 대한 자세한 정보를 확인할 수 있습니다. 조건 주석
2. 모든 @Configuration 클래스를 모으는 자동 구성 파일 / 파일을 배치하십시오.
3. spring.factories 라는 이름의 파일을 만들어 src/main/resources/META-INF .
4. spring.factories 에서 @Configuration 클래스의 쉼표로 구분 된 값으로 org.springframework.boot.autoconfigure.EnableAutoConfiguration 속성을 설정합니다.

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

이 방법을 사용하면 spring-boot에 의해 선택된 자동 구성 클래스를 만들 수 있습니다. Spring-boot는 spring.factories 파일의 모든 maven / gradle 의존성을 자동으로 검사합니다. 발견되면 자동 구성 프로세스에 지정된 모든 @Configuration 클래스를 추가합니다.

auto-configuration 시작 프로젝트가 프로젝트를 실행 가능한 JAR로 패키징하고 클래스 경로에 의해 의도 한대로로드되지 않기 때문에 spring boot maven plugin 포함되어 있지 않은지 확인하십시오. 스프링 부트는 spring.factories 를 찾을 수 없으며 구성을로드하지 않습니다.