Spring DI

Spring의 의존성 주입

Spring에서는 DI를 통해 IoC를 구현합니다.

DI 원칙을 준수한다면 간결한 코드 작성이 가능하며 객체 간 결합도를 낮춰 유연성과 유지보수성을 높입니다.
특히, 의존성이 인터페이스나 추상 클래스인 경우에는 비지니스 로직 변경 및 테스트 수행에 용이합니다.

의존성 주입이란 어떤 객체가 정상적인 기능을 하기 위해 필요한 의존성을 외부에서 제공해주는 것을 의미한다.
Link to original

주요 주입 방식

대표적인 의존성 주입 방식은 다음과 같다.

생성자 주입
setter 주입
필드 주입

생성자 주입

생성자를 통해 의존성을 주입받는 방식이다. Spring에서 가장 권장하는 방식

특징 : 빈 객체가 생성되는 시점에 의존성이 함께 주입
장점
- 불변성 보장
- 의존성 누락 방지
- 순환 참조 방지
- 단위 테스트 용이성
- 가독성 & 유지보수성

@Service
public class OrderService {
    private final PaymentRepository paymentRepository;
 
    @Autowired
    public OrderService(PaymentRepository paymentRepository) {
        this.paymentRepository = paymentRepository;
    }
}

추가로 Spring Framework 4.3 부터 해당 클래스에 하나의 생성자만 존재한다면 @Autowired를 생략 가능

@Service  
@RequiredArgsConstructor  
public class ExerciseService implements ExerciseServiceInterface {  
    private final ExerciseMapper exerciseMapper;  
    private final ExerciseRepository exerciseRepository;  
    private final BodyDetailPartRepository bodyDetailPartRepository;  
    private final ExerciseTargetRepository exerciseTargetRepository;
}

Lombok의 @RequiredArgsConstructor를 사용하면 더욱 깔끔한 코드로 DI 환경을 구축 가능

setter 주입

setter 메서드를 통해 의존성을 주입하는 방식이다.

특징 : 객체 생성 이후에 의존성을 설정
장점 : 의존성을 선택적으로 주입하거나, 런타임에 의존성을 변경해야 할 때 유용
단점 : 완료되지 않은 상태에서 객체가 사용될 위험이 존재, 불변성을 보장 X

public class SimpleMovieLister {
	private MovieFinder movieFinder;
 
	@Autowired
	public void setMovieFinder(MovieFinder movieFinder) {
		this.movieFinder = movieFinder;
	}
}

필드 주입

변수에 @Autowired 어노테이션을 직접 붙이는 방식

특징 : 코드가 간결
단점 : 외부에서 변경이 불가능하여 단위 테스트 작성에 어려움 존재, 프레임워크 의존도가 증가

public class MovieRecommender {
 
	private final CustomerPreferenceDao customerPreferenceDao;
 
	@Autowired
	private MovieCatalog movieCatalog;
 
	@Autowired
	public MovieRecommender(CustomerPreferenceDao customerPreferenceDao) {
		this.customerPreferenceDao = customerPreferenceDao;
	}
}

같은 타입의 빈이 여러개 일때

스프링(Spring)에서 같은 타입의 빈(Bean)이 2개 이상 존재할 때 @Autowired 등으로 의존성 주입을 시도하면, 어떤 빈을 주입해야 할지 알 수 없어 NoUniqueBeanDefinitionException 또는 NoSuchBeanDefinitionException 오류가 발생하기도 한다.

그렇기에 아래와 같은 방식으로 우선순위를 제어할 수 있다.

빈 이름과 필드명을 일치

빈 이름과 파라미터명을 일치시키면 특정 Bean을 주입한다.

@Autowired
private DiscountPolicy rateDiscountPolicy; // 파라미터명을 빈 이름과 일치시킴

@Primary

우선순위를 지닌 Bean에게 @Primary를 명시하면 해당 객체를 우선적으로 조립한다.

기본적으로 하나의 Type Bean에 여러 Bean이 존재한다면 bean name과 field name을 매핑하여 주입
그러나, 특정 Type Bean에 @Primary가 명시된 Bean이 있다면 name을 무시하고 해당 Bean을 주입

interface MyBean {  
    void doSomething();  
}  
  
@Component  
@Primary  
class MainBean implements MyBean {  
    @Override  
    public void doSomething() {  
        System.out.println("Main");  
    }  
}  
  
@Component  
class SubBean implements MyBean {  
    @Override  
    public void doSomething() {  
        System.out.println("Sub");  
    }  
}

@SpringBootTest  
public class PrimaryTest {  
  
    @Autowired  
    public MyBean myBean;  
  
    @Test  
    public void mainBeanLoad() {  
        assertThat(myBean).isInstanceOf(MainBean.class);  
    }  
}

@Qualifier

@Primary만으로는 기능이 부족한 경우에 주로 사용한다.

예를 들어 소셜 로그인과 일반 로그인이 동시에 존재하는 서비스를 개발한다고 할 때,
각 방식에 맞는 AuthenticationSuccessHandler가 필요하기에 아래와 같이 @Qualifier("이름")로 명시하여 각각 의도에 맞게 Bean을 등록할 수 있다.

@Component  
@Qualifier("LoginSuccessHandler")  
public class LoginSuccessHandler implements AuthenticationSuccessHandler { }
 
@Component  
@Qualifier("SocialSuccessHandler")  
public class SocialSuccessHandler implements AuthenticationSuccessHandler { }

// SecurityConfig.java
 
@Configuration  
@EnableWebSecurity  
public class SecurityConfig {  
  
    private final AuthenticationConfiguration authenticationConfiguration;  
    private final AuthenticationSuccessHandler loginSuccessHandler;  
    private final AuthenticationSuccessHandler socialSuccessHandler;  
    private final JwtService jwtService;  
  
    public SecurityConfig(  
            AuthenticationConfiguration authenticationConfiguration,  
            @Qualifier("LoginSuccessHandler") AuthenticationSuccessHandler loginSuccessHandler,  
            @Qualifier("SocialSuccessHandler") AuthenticationSuccessHandler socialSuccessHandler,  
            JwtService jwtService) {  
  
        this.authenticationConfiguration = authenticationConfiguration;  
        this.loginSuccessHandler = loginSuccessHandler;  
        this.socialSuccessHandler = socialSuccessHandler;  
        this.jwtService = jwtService;  
    }
}

주입 로직

@Bean 으로 bean을 생성하게 되면, method name이 bean name으로 생성된다.
같은 Type의 bean이 1개만 있다면, bean name과 관련없이 bean을 주입해준다.
같은 Type의 bean이 여러 개 있으면, @Qualifier가 없어도 bean name과 field name을 매칭해서 bean을 주입해준다.
@Primary가 있으면, bean name을 무시하고 Type 기반으로 Primary인 Bean을 주입한다.
@Qualifier가 있으면, 무조건 bean name 기준으로 주입해준다. (없으면 오류가 발생한다)
@Qualifier 어노테이션이 @Primary 어노테이션보다 우선하여 적용된다.