컴포넌트 스캔 & 의존 관계 주입

이정원·2024년 10월 22일

스프링은 설정 정보(Appconfig.class)가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

@ComponenScan:

특정 패키지 내의 클래스를 자동으로 스캔해서 빈으로 등록한다. 스프링이 해당 패키지를 검색하고, 그 안에 있는 클래스들 중에서 @Component, @Service, @Repository, @Controller와 같은 애너테이션이 붙어 있는 클래스들을 스프링 컨테이너에 빈으로 등록하는 과정이다.

  • 보통 설정 파일(@Configuration 클래스)에 @ComponentScan을 지정한다.
  • 지정된 패키지를 스캔하여 컨테이너에 빈으로 자동 등록한다.

@Component:

클래스에 이 애너테이션을 붙이면, 스프링이 이 클래스를 빈으로 자동 등록한다.

  • @Component는 일반적인 클래스에 사용되고, @Service, @Repository, @Controller는 역할에 따라 더 구체적인 빈 등록을 위해 사용된다.

@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
@Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

예시:

@Configuration
@ComponentScan(basePackages = "com.example.myapp")
public class AppConfig {
    // 이 설정 파일에서 com.example.myapp 패키지를 스캔해서 
    // @Component가 붙은 클래스를 스프링 컨테이너에 빈으로 등록한다.
}

이렇게 설정하면, com.example.myapp 패키지 내에 @Component, @Service, @Repository, @Controller가 붙어 있는 모든 클래스가 자동으로 스프링 컨테이너에 빈으로 등록된다.(excludeFilters를 사용하여 컴포넌트 스캔 대상 제외가 가능하다.)

  • 보통 @ComponentScan의 설정 객체를 프로젝트 최상단에 둔다.

@Autowired:

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 파라미터로 지정된 객체와 동일한 스프링 빈을 찾아서 주입한다.

중복 등록

자동 빈 등록 vs 자동 빈 등록: 이름이 같은 경우 스프링은 오류를 발생 시킨다.
수동 빈 등록 vs 자동 빈 등록:수동 빈 등록이 우선권을 가진다.

다양한 의존 관계 주입 방법

  • 생성자 주입
    해당 클래스에 생성자가 1개만 존재한다면 스프링 빈에 한에 @Autowired를 생략해도 자동 주입 된다.

  • 수정자 주입(setter 주입)
    선택, 변경 가능성이 있는 의존관계에 사용하며 setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.

  • 필드 주입
    사용x

@Component
public class OrderServiceImpl implements OrderService {
	@Autowired
	private MemberRepository memberRepository;
	@Autowired
	private DiscountPolicy discountPolicy;
}
  • 일반 메서드 주입

옵션 처리

@Autowired(required=false):빈이 존재하지 않아도 에러 없이 동작

@Nullable:해당 파라미터가 null일 수 있다는 가능성을 나타내며 추가적인 예외 처리 필요

@Autowired
public void setNoBean2(@Nullable Member member) {
	System.out.println("setNoBean2 = " + member);
}

Optional<>:객체가 존재할 수 있고 존재하지 않을 수도 있다.

@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
	System.out.println("setNoBean3 = " + member);
}

생성자 주입을 택해야 하는 이유

  • 클라이언트 코드로 인한 변경으로 오류 방지
  • 동시성 문제 예방
  • 객체의 생명주기 관리 용이성

롬복과 최신 트랜드

final 키워드, 생성자 코드 없이 롬복 라이브러리가 제공하는 @RequiredArgsConstructor를 적용함으로써 코드가 간결해진다.
(final 필드를 가지고 있는 모든 필드를 매개변수로 받는 생성자를 자동으로 만들어준다.)

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
	private final MemberRepository memberRepository;
	private final DiscountPolicy discountPolicy;
}

== 위 코드는 아래와 같다.==

@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;
    }

}

인터페이스 or 부모 클래스 의존관계 주입시 하위 클래스가 여러가지인 경우(조회 빈 2개 이상 ,NoUniqueBeanDefinitionException)

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다. 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

1.@Autowired 필드 명 매칭
타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
private DiscountPolicy discountPolicy ->
private DiscountPolicy rateDiscountPolicy 필드 명,파라미터 명을 빈 이름으로 변경

2.@Qualifier 사용
@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를 붙여주고 등록한 이름을 적어준다.

3.@Primary 사용
여러 빈이 매칭되면 @Primary가 붙은 자식 클래스가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}

실무 적용 사례:코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고,서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다면 메인 커넥션에 @Primary,서브 커넥션에 @Qualifier를 적용하면 깔끔하다. 다만, 우선순위는 @Qualifier > @Primary이다.

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체(업무 로직x)는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.

0개의 댓글