기존의 Spring MVC는 xml을 활용하여 bean을 등록했다.
하지만 프로젝트 규모가 커지면서 사용하는 요소들을 xml에 등록하는 것은 상당히 번거로워졌다.
따라서 어노테이션을 활용하여 Bean을 등록하는 방법이 생겨났다.
Spring Bean
Spring에서는 Spring의 DI Container에 의해 관리되는 POJO(Plain Old Java Object)를 Bean이라고 부르며, 이러한 Bean들은 Spring을 구성하는 핵심 요소이다.
- POJO(Plain Old Java Object)로써 Spring 애플리케이션을 구성하는 핵심 객체이다.
- Spring IoC 컨테이너(또는 DI 컨테이너)에 의해 생성 및 관리된다.
- class, id, scope, constructor-arg 등을 주요 속성으로 지닌다.
Spring Bean 구성 요소
- class: Bean으로 등록할 Java 클래스
- id: Bean의 고유 식별자
- scope: Bean을 생성하기 위한 방법(singleton, prototype 등)
- constructor-arg: Bean 생성 시 생성자에 전달할 파라미터
- property: Bean 생성 시 setter에 전달할 인수
Spring에서는 위와 같은 Bean의 구성 요소를 바탕으로 등록되어 있는 Bean을 싱글톤 객체로 생성하여 관리한다.
Spring Bean 등록 방법(@Bean, @Configuration, @Component)
@Bean과 @Configuration을 활용하여 수동으로 등록하기
public class BeanResource {
}
위와 같은 클래스가 있고, 이를 스프링 컨테이너에 등록해 보자.
빈으로 등록하기 위해서는 명시적으로 설정 클래스에서 @Bean을 사용하여 수동으로 스프링 컨테이너에 빈을 등록할 수 있다.
설정 클래스는 @Configuration을 클래스에 붙여주면 된다.
@Bean을 사용해 수동으로 빈을 등록해 줄 때는 메서드 이름으로 빈 이름이 결정된다.
중복된 빈 이름이 존재하지 않도록 주의해야 한다.
@Configuration
public class ResourceConfig {
@Bean
public BeanResource beanResource() {
return new BeanResource();
}
}
@Configuration안에서 @Bean이 빈으로 등록되는 과정
스프링 컨테이너는 @Configuration이 붙어있는 클래스를 자동으로 빈으로 등록해 주고, 해당 클래스를 파싱 해서 @Bean이 있는
메서드를 찾아서 빈을 생성해 준다.
@Bean을 사용하는 클래스에는 반드시 @Configuration 어노테이션을 활용하여 해당 클래스에서 Bean을 등록하고자 함을 명시해주어야 한다. 스프링 빈으로 등록된 다른 클래스 안에서 @Bean으로 직접 빈을 등록해 주는 것도 동작은 한다. 하지만 @Configuration 안에서 @Bean을 사용해야 싱글톤을 보장받을 수 있으므로 @Bean 어노테이션은 반드시 @Configuration과 함께 사용해주어야 한다.
@Bean 어노테이션의 경우는 수동으로 빈을 직접 등록해줘야만 하는 상황
- 개발자가 직접 제어가 불가능한 라이브러리를 활용할 때
- 애플리케이션 전범위적으로 사용되는 클래스를 등록할 때
- 다형성을 활용하여 여러 구현체를 등록해주어야 할 때
예를 들어 우리가 객체를 Json 메시지로 변경하기 위해 Gson과 같은 외부 라이브러리를 사용한다고 하자. 그러면 해당 클래스를 싱글톤 빈으로 등록해 주어야 1개의 객체만 생성하여 여러 클래스가 공유함으로써 메모리 상의 이점을 얻을 수 있을 것이다. 그런데 해당 클래스는 우리가 만든 게 아니라 가져다 쓰는 클래스일 뿐이므로 불가피하게 @Bean으로 등록해줘야만 한다.
애플리케이션 전범위적으로 사용되는 클래스와 다형성을 활용하여 여러 구현체를 등록할 때 @Bean을 사용하면 좋은 이유는 한눈에 파악하여 유지보수하기 좋기 때문이다. 예를 들어 여러 구현체를 빈으로 등록해 줄 때 어떠한 구현체들이 빈으로 등록되는지를 파악하려면 소스 코드를 찾아볼 필요 없이 해당 @Configuration 클래스만 보면 되기 때문이다.
@Component
하지만 이렇게 수동으로 직접 빈을 등록하는 작업은 빈으로 등록하는 클래스가 많아질수록 상당히 많은 시간을 들게 되고, 생산력 저하를 야기할 것이다. 그래서 스프링에서는 특정 어노테이션이 있는 클래스를 찾아서 빈으로 등록해 주는 컴포넌트 스캔 기능을 제공한다.
스프링은 컴포넌트 스캔(Component Scan)을 사용해 @Component 어노테이션이 있는 클래스들을 찾아서 자동으로 빈 등록을 해준다. 그래서 우리가 직접 개발한 클래스를 빈으로 편리하게 등록하고자 하는 경우에는 @Component 어노테이션을 활용하면 된다.
@Component를 갖는 어노테이션으로 @Controller, @Service, @Repository 등이 있으며 앞서 살펴봤던 @Configuration 역시 안에 @Component를 가지고 있다
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
@AliasFor(annotation = Component.class)
String value() default "";
boolean proxyBeanMethods() default true;
}
@Configuration 안에 있는 @Component에 의해 설정 클래스 역시 자동으로 빈으로 등록이 되고, 그래서 @Bean 이 있는 메서드를 통해 빈을 등록해 줄 수 있었던 것이다.
스프링은 기본적으로 컴포넌트 스캔을 이용한 자동 빈 등록 방식을 권장한다. 또한 직접 개발한 클래스는 @Component를 통해 해당 클래스를 빈으로 등록함을 노출하는 것이 좋다. 왜냐하면 해당 클래스에 있는 @Component만 보면 해당 빈이 등록되도록 잘 설정되었는지를 바로 파악할 수 있기 때문이다. @Bean을 이용하면 빈으로 등록하는 작업도 번거로우며 빈이 등록되었는지 파악하는 과정도 번거로워질 수 있다. 그러므로 위에서 @Bean으로 해야 하는 경우를 제외한 대부분의 경우에 자동 등록 방식을 사용하면 된다.
@Component를 이용한다면 Main 또는 App 클래스에서 @ComponentScan으로 컴포넌트를 찾는 탐색 범위를 지정해주어야 한다. 하지만 SpringBoot를 이용 중이라면 @SpringBootConfiguration 하위에 기본적으로 포함되어 있어 별도의 설정이 필요 없다.
요약
@Bean, @Configuration
- 수동으로 스프링 컨테이너에 빈을 등록하는 방법
- 개발자가 직접 제어가 불가능한 라이브러리를 빈으로 등록할 때 불가피하게 사용
- 유지보수성을 높이기 위해 애플리케이션 전범위적으로 사용되는 클래스나 다형성을 활용하여 여러 구현체를 빈으로 등록할 때 사용
- 1개 이상의 @Bean을 제공하는 클래스의 경우 반드시 @Configuration을 명시해 주어야 싱글톤이 보장됨
@Component
- 자동으로 스프링 컨테이너에 빈을 등록하는 방법
- 스프링의 컴포넌트 스캔 기능이 @Component 어노테이션이 있는 클래스를 자동으로 찾아서 빈으로 등록함
- 대부분의 경우 @Component를 이용한 자동 등록 방식을 사용하는 것이 좋음
- @Component 하위 어노테이션으로 @Configuration, @Controller, @Service, @Repository 등이 있음
'Spring' 카테고리의 다른 글
@Autowire 빈 탐색 전략 (0) | 2023.05.11 |
---|---|
@Configuration안에서 @Bean을 사용해야하는 이유 (0) | 2023.05.05 |
@RequestBody, @ModelAttribute, @RequestParam의 차이 (0) | 2023.05.04 |
@Controller와 @RestController 차이점 (0) | 2023.05.04 |
Servlet, Spring MVC 정리 (0) | 2023.01.30 |