스프링빈의 직무유기를 막아라, 같은 타입의 빈이 2가지 이상 존재

🍐 스프링빈의 직무유기

개발을 하다보면 여러가지 경우의 수가 있을것이다.

 

예를 들면 DB를 두개 이상을 쓴다던지, 할인 정책이 두가지(고정금액 할인, 비율%할인) 라던지..

 

즉 두가지 이상의 구현체가 있을때 두가지 구현체가 모두 스프링 빈에 등록이 된다면 어떻게 될까 ?

 

컴포넌트 스캔방식으로 코드를 구현했을때 위와 같은 상황이 일어난다고 가정하면.

 

스프링은 생성자 주입간에 해당 생성자의 타입명을 보고 타입명과 매칭이 되는 빈을 주입을 시켜준다.

@Autowired
public UserService(UserRepository userRepository) {
    this.userRepository = userRepository;
}

 

userRepository에 UserRepository의 타입을 가지는 빈을(예를 들면 JdbcUserRepository, JPAUserRepository 라던가) 주입을 해줄것이다.

. 

"근데 어라? UserRepository JPAUserRepository, UserRepository JdbcUserRepository 두개나 있네?? 나 일 안해 때려쳐"

 

위 처럼 스프링빈이 노동조합을 꾸려 파업하는 사태를 막기 위한 방법들이 있다. 스프링빈의 파업을 막기 위해 알아보자.

---

 

간략하게 요약하자면 구현체 두개에 모두 @Component를 붙혀줌으로써 두개의 구현체가 모두 UserRepository 타입으로 스프링빈에 등록이 될것이다. 여기에 대처하는 두가지 방법을 설명하겠다.

 

명시적으로 표현하자

public interface UserRepository {
    void save(User user);
}

//--------------------- 인터페이스 -----------------------------

@Component
@Primary
public class JdbcUserRepository implements UserRepository {
    // JdbcUserRepository의 구현 내용
}

@Componet
public class JPAUserRepository implements UserRepository{
    // JPAUserRepository의 구현 내용
}

//--------------------- 구현체 -----------------------------

@Component
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository JdbcUserRepository) {
        this.userRepository = JdbcUserRepository;
    }
}

 

@Autowired
    public UserService(UserRepository JdbcUserRepository) {
        this.userRepository = JdbcUserRepository;
    }

두가지 이상의 빈이 있을 시 명시를 해서 적어주면 스프링빈이 인식을 하고 해당 객체를 주입해준다.

---

@Primary

우선순위를 가지는 구현체에 @Primary를 붙혀라.

 

public interface UserRepository {
    void save(User user);
}

//--------------------- 인터페이스 -----------------------------

@Component
@Primary
public class JdbcUserRepository implements UserRepository {
    // JdbcUserRepository의 구현 내용
}

@Componet
public class JPAUserRepository implements UserRepository{
    // JPAUserRepository의 구현 내용
}

//--------------------- 구현체 -----------------------------

@Component
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}

 

실눈뜨고 열심히 보면 JdbcUserRepository 위에 @Primary 라는 어노테이션이 붙어있는것을 확인 할 수있다.

 

이렇게 되면 동일한 타입의 빈이 두개 이상 등록되더라도 @Primary 가 붙어있는 구현체를 사용한다.

---

@Qualifier

 

public interface UserRepository {
    void save(User user);
}

//--------------------- 인터페이스 -----------------------------

@Component
@Qualifier("Main")
public class JdbcUserRepository implements UserRepository {
    // JdbcUserRepository의 구현 내용
}

@Componet
public class JPAUserRepository implements UserRepository{
    // JPAUserRepository의 구현 내용
}

//--------------------- 구현체 -----------------------------

@Component
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(@Qualifier("Main") UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}

 

두눈 크게 뜨고 잘 보면, JdbcUserRepository에 @Qualifier("Main")이라고 붙은 부분이 보일 것 이다. 그리고

 

생성자 부분에도 @Qualifier("Main")이라고 어노테이션이 붙었다.

 

즉 @Qualifier("매칭 할 이름, 생성자 부분이랑 구현체랑 같아야함") 

 

---

 

@Qualifier 안에 매칭 할 이름이 문자열 이다. 컴파일러가 문자열은 검증을 못해주므로 내가 오타를 내어도 어디가 문제인지 찾기가 상당히 까다롭다.

 

그러한 문제를 방지하기 위해 어노테이션을 만들어서 사용 할 수가 있다.

 

package hello.core.annotation;


import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier
public @interface Main {



}

// cmd + O 누르면 내가 쓰는 라이브러리나, 어노테이션 본진으로 처들어 갈 수 있음.

 

위처럼 인터페이스를 만들어주고 위처럼 적어준다. @인터페이스임

 

public interface UserRepository {
    void save(User user);
}

//--------------------- 인터페이스 -----------------------------

@Component
@Main
public class JdbcUserRepository implements UserRepository {
    // JdbcUserRepository의 구현 내용
}

@Componet
public class JPAUserRepository implements UserRepository{
    // JPAUserRepository의 구현 내용
}

//--------------------- 구현체 -----------------------------

@Component
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(@Main UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}