스프링 컴포넌트 스캔 자동 빈 등록

컴포넌트 스캔이란?

스프링 컴포넌트 스캔은 스프링 컨테이너가 특정 패키지를 스캔하여, @Component 어노테이션이 붙은 클래스를 자동으로 빈(Bean)으로 등록하는 기능이다. 수동으로 빈을 등록하는 번거로움을 줄이고, 코드의 가독성과 유지보수성을 높일 수 있다.

 

컴포넌트 스캔의 장점

- 자동화 : @Component 어노테이션을 통해 자동으로 빈을 등록 할 수 있다.

- 간편함, 유연성 : 빈 등록을 위한 설정 코드가 줄어들어 간편하고, 특정 패키지를 스캔하여 필요한 빈을 자동으로 등록하므로, 변경에 유연하게 대응 가능

 

 

컴포넌트 스캔 설정 방법

XML 설정

<context:component-scan base-package="com.example"/>

 

com.example 패키지와 그 아래 패키지에서 @Component 가 붙은 클래스를 스캔하여 빈으로 등록한다.

 

 

Java Config설정

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
}

 

xml처럼 같은 방식으로 빈을 등록한다.

 

 

 

컴포넌트 스캔 어노테이션

@Component 어노테이션은 스프링 컴포넌트 스캔 과정에서 자동으로 빈으로 등록될 클래스를 나타낸다

 

@Component
public class MyService {
    public void doSomething() {
        System.out.println("Doing something...");
    }
}

 

 

@Controller, @Service, @Repository

스프링은 @Component 외에도 특정 역할을 가진 클래스를 명시적으로 나타내기 위해 @Controller, @Service, @Repository 어노테이션을 제공. 이 어노테이션들은 @Component의 특수한 형태로 간주

 

- @Controller: 웹 컨트롤러 역할을 하는 클래스에 사용됨

- @Service: 서비스 역할을 하는 클래스에 사용됨.
- @Repository: 데이터 접근 객체(DAO) 역할을 하는 클래스에 사용됨.

 

 

 

 

필터를 사용한 컴포넌트 스캔

포함 필터

@Configuration
@ComponentScan(basePackages = "com.example", includeFilters = @ComponentScan.Filter(Service.class))
public class AppConfig {
}

 

 

제외 필터

@Configuration
@ComponentScan(basePackages = "com.example", excludeFilters = @ComponentScan.Filter(Controller.class))
public class AppConfig {
}

 

 

 

 

@ComponentScan의 다양한 속성

 

basePackages

@ComponentScan(basePackages = {"com.example", "com.another"})

 

basePackageClasses

@ComponentScan(basePackageClasses = MyClass.class)

 

 

 

 

컴포넌트 스캔의 사용 예

 

서비스 클래스 정의

@Service
public class MyService {
    public void doSomething() {
        System.out.println("Doing something...");
    }
}

 

컨트롤러 클래스 정의

@Controller
public class MyController {
    private final MyService myService;

    @Autowired
    public MyController(MyService myService) {
        this.myService = myService;
    }

    @RequestMapping("/do")
    public String doSomething() {
        myService.doSomething();
        return "done";
    }
}

 

설정 클래스 정의

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
}

 

메인 클래스 정의

public class Main {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        MyController controller = context.getBean(MyController.class);
        controller.doSomething();
    }
}

 

 

 

 

 

 

 

정리

- 스프링 컴포넌트 스캔은  @Component, @Controller, @Service, @Repository 어노테이션을 사용하여 자동으로 빈을 등록할 수 있게 함

- XML 또는 Java Config 설정을 통해 컴포넌트 스캔을 설정할 수 있다.

- 필터를 사용하여 포함하거나 제외할 클래스를 설정할 수 있으며, 다양한 속성을 통해 스캔 범위를 조정할 수 있다.

이를 통해 개발자는 수동으로 빈을 등록하는 번거로움을 줄이고, 코드의 가독성과 유지보수성을 높일 수 있음.