이번 섹션은 의존관계 자동 주입에 대해서 알아보자.
목차는 다음과 같다.
1) 다양한 의존관계 주입 방법
2) 옵션 처리
3) 생성자 주입을 선택해라!
4) 롬복과 최신 트랜드
5) 조회 빈이 2개 이상 - 문제
6) @Autowired 필드 명, @Qualifier, @Primary
7) 애노테이션 직접 만들기
8) 조회한 빈이 모두 필요할 때, List, Map
9) 자동, 수동의 올바른 실무 운영 기준
먼저 다양한 의존관계 주입 방법에 대해 알아보자.
① 생성자 주입
② 수정자 주입 (setter 주입)
③ 필드 주입
④ 일반 메서드 주입
@Autowired
의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)
로 지정하면 된다.Member
같은 클래스에서 @Autowired
코드를 적용해도 아무 기능도 동작하지 않는다.이번에는 옵션 처리에 대해서 알아보자.
예를 들어, 주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired
만 사용하면 required
옵션의 기본값이 true
로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
@Autowired(required=false)
: 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨.org.springframework.lang.@Nullable
: 자동 주입할 대상이 없으면 null이 입력된다.Optional<>
: 자동 주입할 대상이 없으면Optional.empty
가 입력된다.
👉 예제로 확인해보자.
setNoBean1()
은 @Autowired(required=false)
이므로 호출 자체가 안된다. (의존관계가 없으면 메서드 자체 호출이 아예 안됨.)이번에는 생성자 주입을 선택해라!에 대해서 알아보자.
👉 과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유는 다음과 같다.
불변
대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다. (불변해야 한다.)
수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다. (누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.)
생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.
누락을 막을 수 있다.
@Autowired
가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다.컴파일 오류
가 발생한다.final 키워드
java: variable discountPolicy might not have been initialized
)✔️ 참고
✔️ 정리
생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는게 좋다.
이번에는 롬복과 최신 트랜드에 대해 알아보자.
막상 개발을 해보면, 대부분이 다 불변이어서 필드에 final 키워드를 사용하게 된다.
그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고…
필드 주입처럼 좀 편리하게 사용하는 방법은 없을까?
역시 개발자는 귀찮은 것은 못 참는다!
다음 기본 코드를 최적화해보자.
@RequiredArgsConstructor
기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다. (코드에는 보이지 않지만 실제 호출 가능하다.) 최종 결과는 다음과 같다! 정말 간결하지 않은가!✔️ 정리
@Autowired
를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브 러리의 @RequiredArgsConstructor
함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.@Autowired
는 타입(Type)으로 조회한다.
@Autowired private DiscountPolicy discountPolicy
ac.getBean(DiscountPolicy.class)
DiscountPolicy
의 하위 타입인 FixDiscountPolicy
, RateDiscountPolicy
둘다 스프링 빈으로 선언해보자.NoUniqueBeanDefinitionException
오류가 발생한다.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
)해결 방법을 하나씩 알아보자.
조회 대상 빈이 2개 이상일 때 해결 방법
① @Autowired 필드 명 매칭
② @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
③ @Primary 사용
① @Autowired 필드 명 매칭
: @Autowired
는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
👉 필드명을 예로 들어보자.
👉 파라미터 명을 예로 들어보자.
✔️ 정리
② @Qualifier 매칭
: @Qualifier
는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
🤔 @Qualifier
로 주입할 때 @Qualifier("mainDiscountPolicy")
를 못찾으면 어떻게 될까?
: 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier
는 @Qualifier
를 찾는 용도로만 사용하는게 명확하고 좋다.
✔️ 참고
✔️ 정리
NoSuchBeanDefinitionException
예외 발생
③ @Primary 사용
: @Primary
는 우선순위를 정하는 방법이다. @Autowired시에 여러번 매칭되면 @Primary
가 우선권을 가진다.
@Primary
가 잘 동작하는 것을 확인할 수 있다.🤔 여기까지 보면 @Primary
와 @Qualifier
중에 어떤 것을 사용하면 좋을지 고민이 될 것이다. @Qualifier
의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier
를 붙여주어야 한다는 점이다. (반면에 @Primary 를 사용하면 @Qualifier를 붙일 필요가 없다.)
☝️ @Primary, @Qualifier 활용
@Primary
를 적용해서, 조회하는 곳에서 @Qualifier
지정없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier
를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier
를 지정해주는 것은 상관없다.☝️ 우선순위
@Primary
는 기본값 처럼 동작하는 것이고, @Qualifier
는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier
가 우선권이 높다.@Qualifier("mainDiscountPolicy")
이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있다.
✔️ 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. @Qualifier
뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired
도 재정의 할 수 있다. 물론 스프링이 제공하는 기능을 뚜렷한 목적없이 무분별하게 재정의하는 것은 유지보수에 더 혼란만 가중할 수 있다.
: 의도적으로 특정 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자. 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.
코드로 바로 확인해보자.
로직 분석
DiscountService는 Map으로 모든 DiscountPolicy
를 주입받는다. 이때 fixDiscountPolicy
, rateDiscountPolicy
가 주입된다.
discount()
메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy
스프링 빈을 찾아서 실행한다. 물론 “rateDiscountPolicy”가 넘어오면 rateDiscountPolicy
스프링 빈을 찾아서 실행한다.
주입 분석
Map<String, DiscountPolicy>
: map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy
타입으로 조회한 모든 스프링 빈을 담아준다.
List<DiscountPolicy>
: DiscountPolicy
타입으로 조회한 모든 스프링 빈을 담아준다.
만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.
참고 - 스프링 컨테이너를 생성하면서 스프링 빈 등록하기
new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);
new AnnotationConfigApplicationContext()
를 통해 스프링 컨테이너를 생성한다.AutoAppConfig.class
, DiscountService.class
를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.AutoAppConfig
, DiscountService
를 스프링 빈으로 자동 등록한다.편리한 자동 기능을 기본으로 사용하자
그러면 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?
결론부터 이야기하면, 스프링이 나오고 시간이 갈수록 점점 자동을 선호하는 추세다. 스프링은 @Component
뿐만 아니라 @Controller
, @Service
, @Repository
처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component
만 넣어주면 끝나는 일을 @Configuration
설정 정보에 가서 @Bean
을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다. 또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다. 그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
그러면 수동 빈 등록은 언제 사용하면 좋을까?
애플리케이션은 크게 비즈니스 업무 로직과 기술 지원 로직으로 나눌 수 있다.
업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다. (애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.)
(참고) 비즈니스 로직 중에서도 수동 등록을 하는게 더 유리한 경우가 있을 수 있다. -> 비즈니스 로직 중에서 다형성을 적극 활용할 때
DiscountService
가 의존관계 자동 주입으로 Map<String, DiscountPolicy>
에 주입을 받는 상황을 생각해보자. 여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 있을까? 내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면 어떨까?DiscountPolicy
의 구현 빈들만 따로 모아서 특정 패키지에 모아두자.
✔️ 참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다. 이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.
✔️ 정리
강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.