인프런 김영한님의 스프링 강의를 듣고 정리한 내용입니다. 출처
컴포넌트 스캔
지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>을 통해 설정 정보에 직접 등록할 스프링 빈을 나열했다.
하지만 스프링 빈이 수백개가 되면 설정 정보가 커지고 누락되는 문제가 발생할 수 있다.
그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 그리고 의존관계도 자동으로 주입해주는 @Autowired라는 기능도 제공한다.
@Configuration
@ComponentScan(
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}
컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 앞에서 만들었던 AppConfig도 함께 등록되버리게 돼서 excludeFilters를 사용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.
- 컴포넌트 스캔을 사용하려면 먼저
@ComponentScan을 설정 정보에 붙여주면 된다. - 컴포넌트 스캔은 이름 그대로
@Component애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록해준다.
@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
@Autowired
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
}@Autowired는 의존관계를 자동으로 주입해준다.
탐색 위치와 기본 스캔 대상
모든 자바 클래스를 다 컴포넌트 스캔 하면 시간이 오래 걸리기 때문에 탐색 위치를 지정할 수 있다.
@ComponentScan(
basePakages = "hello.core",
}basePakages는 탐색할 패키지의 시작 위치를 지정해주고 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
탐색위치를 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
하지만 패키지 위치를 지정하지 않고 설정 정보 클래스의 위치를 프로젝트 최상단에 두는것을 권장한다.
컴포넌트 스캔은 @Component 뿐만 아니라 여러 대상을 추가로 포함한다.
@Component: 컴포넌트 스캔에서 사용@Controller: 스프링 MVC 컨트롤러로 인식@Service: 스프링 비지니스 로직에서 사용, 특별한 처리는 하지 않지만 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 하고 비즈니스 계층을 인식하는데 도움을 준다.@Repository: 스프링 데이터 접근 계층으로 인식하고 데이터 계층의 예외를 스프링 예외로 변환해준다.@Configuration: 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 추가 처리를 함.
중복 등록과 충돌
컴포넌트 스캔에서 같은 빈 이름이 등록될 때
-
자동 빈 등록 vs 자동 빈 등록
컴포넌트에 의해 자동으로 스프링 빈이 등록되는데 이름이 같은 경우 스프링은 오류를 발생시킨다.
ConflictingBeanDefinitionException예외 발생 -
수동 빈 등록 vs 자동 빈 등록
수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 수동 빈 등록이 우선권을 가진다. ( 수동 빈이 자동 빈을 오버라이딩 해버린다 )
하지만 이런 결과는 개발자가 의도적으로 설정해서 만들어지기보다는 여러 설정들이 꼬여서 발생한다. 그리고 정말 잡기 어려운 버그가 만들어진다.
그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본값을 바꾸었다.
의존관계 자동 주입
의존관계 주입은 크게 4가지 방법이 있다.
- 생성자 주입
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}이름 그대로 생성자를 통해서 의존관계를 주입 받는 방법이다. 생성자 호출 시점에 딱 1번만 호출되는 것이 보장되고
불변, 필수 의존 관계에 사용한다.
생성자가 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.
- 수정자 주입(setter 주입)
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void setMemberRepository(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
@Autowired
public void setDiscountPolicy(DiscountPolicy discountPolicy) {
this.discountPolicy = discountPolicy;
}
}setter라고 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법으로
선택, 변경 가능성이 있는 의존관계에 사용한다.
- 필드 주입
@Component
public class OrderServiceImpl implements OrderService {
@Autowired private MemberRepository memberRepository;
@Autowired private DiscountPolicy discountPolicy;
}이름 그대로 필드에 바로 주입하는 방법이다. 코드가 간결하지만 외부에서 변경이 불가능해서 테스트하기 힘들고 DI 프레임워크가 없으면 아무것도 할 수 없다.
애플리케이션의 실제 코드와 관계없는 테스트 코드나 스프링 설정을 목적으로 하는 @Configuration같은 곳에서만 사용하자.
- 일반 메서드 주입
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}일반 메서드를 통해 주입받는 방법으로 한번에 여러 필드를 주입 받을수 있지만 일반적으로 잘 사용하지 않는다.
옵션 처리
주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 하지만 @Autowired만 사용하면 자동 주입 대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
@Autowired(required = false): 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출이 되지 않음.@Nullable: 자동 주입할 대상이 없으면 null이 입력됨.Optional<>: 자동 주입할 대상이 없으면Optional.empty가 입력된다.
생성자 주입
최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.
- 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다.
- 수정자 주입을 사용하면 setXxx 메서드를 public으로 열어둬야하는데, 누군가 실수로 변경할수도 있고 변경하면 안되는 메서드를 열어두는 것은 좋은 설계방법이 아니다.
생성자 주입을 사용하면 필드에 final 키워드를 사용할 수있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.
기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하는것이 좋다.
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}롬복 라이브러리가 제공하는 @RequiredArgsConstructor기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.
조회되는 빈이 2개 이상인 경우
@Autowired는 타입으로 조회하기 때문에 선택된 빈이 2개 이상일 때 문제가 발생한다.(NoUniqueBeanDefinitionException)
이때 하위타입으로 지정할 수도 있지만 하위타입으로 지정하는것은 DIP을 위배하고 유연성이 떨어지기 때문에 다음 방법들로 문제를 해결한다.
@Autowired필드명 매칭
@Autowired는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
@Autowired
private DiscountPolicy rateDiscountPolicy먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을때 추가로 필드명인rateDiscountPolicy를 매칭하고 정상 주입된다.
@Qualifier사용
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}@Qualifier는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
하지만 @Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안되기 때문에 다음과 같은 애노테이션을 만들어서 문제를 해결 가능하다.
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 찾지 못하면 mainDiscountPolicy 이름을 가진 스프링 빈을 추가로 찾는다. 그래도 찾지 못하면 NoSuchBeanDefinitionException예외가 발생한다.
@Primary사용
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}@Primary는 우선순위를 정하는 방법이다. @Autowired시 여러 빈이 매칭되면 @Primary가 우선권을 가진다.
@Primary는 기본값처럼 동작하는 것이고, @Qualifier는 매우 상세하고 동작한다. 둘을 모두 사용한 경우에는 @Qualifier가 우선권이 높다.
스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.
조회한 빈이 모두 필요할 때
@Test
void findAllBean() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
DiscountService discountService = ac.getBean(DiscountService.class);
Member member = new Member(1L, "userA", Grade.VIP);
int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
assertThat(discountService).isInstanceOf(DiscountService.class);
assertThat(discountPrice).isEqualTo(1000);
}
static class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
}
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
자동, 수동의 올바른 실무 운영 기준
어떤경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고 의존관계도 수동으로 주입해야 할까?
스프링은 @Component뿐 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔 할 수있도록 지원한다. 그리고 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 되고, 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
그럼 수동 빈 등록은 언제 사용하면 좋을까?
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
-
업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
-
기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
업무 로직은 숫자도 매우 많고 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다.
기술 지원 로직은 업무 로직과 비교해서 수가 매우 적고, 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 떄 어디가 문제인지 명확하게 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 들어내는것이 좋다.
또한 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해 보거나 자동으로 등록하게 되면 특정 패키지에 같이 묶어두는 것이 좋다.
