Section7(3편) 의존관계 자동 주입 시 문제 상황 및 대처 방법

인프런 강의 中 
김영한 강사님의 '스프링 핵심 원리' 내용을 정리했습니다.

지난 시간에 lombok을 사용해 의존관계 자동 주입을 더 간단하게 해보았다. 이번 시간에는 의존관계 자동 주입 시 발생할 수 있는 에러사항 및 대처 방안에 대해서 김영한 강사님의 강의를 토대로 학습해보겠다!! let's get it!!!!

 

목차

• 조회 빈이 2개 이상 - 문제 
• 문제 해결 방법 @Autowired 필드 명, @Qualifier, @Primary
• 어노테이션 직접 만들기

 

1. 조회 빈이 2개 이상 - 문제

 

해당 내용을 들어가기 전에 잠깐 시간 여행을 해서 과거로 돌아가보자. 우리는 좋은 객체지향 설계를 하기 위해 역할과 구현으로 나눠서 개발을 진행했고, 할인 정책(DiscountPolicy)라는 역할과 정액 할인(FixDiscountPolicy),  정률 할인(RateDiscountPolicy)이라는 구현체로 나누어서 개발을 진행했다. 그리고 우리가 사용할 정책의 구현체를 스프링 빈에 등록하고 의존관계 자동 주입에 사용했다. 자, 이제 시간 여행을 끝내고 본론을 시작한다.

 

 지금까지는 필요한 구현체만 @Component를 사용해 스프링 빈에 등록했기 때문에 딱히 충돌이 발생할 일이 없었다. 하지만 같은 타입의 구현체가 스프링 빈에 2개 등록되어 있다면? 의존관계 자동 주입 시 충돌이 발생할 것이다. 왜냐하면 @Autowired는 의존관계 주입할 빈을 타입(Type)으로 조회하기 때문이다. 즉, 우리가 예전에 만들었던 정액 할인과 정률 할인 구현체를 모두 스프링 빈에 등록하면 둘은 같은 타입(DiscountPolicy 타입을 가진다.)이기 때문에 충돌이 발생한다. 진짜 충돌이 발생하는지 위 상황을 코드로 확인해보자!

 

빈에 등록된 FixDiscountPolicy

 

빈에 등록된 RateDiscountPolicy

 

의존관계 자동 주입 코드

 

이미지T1. 테스트 코드

테스트 에러

 

후.. 테스트를 위해 사용된 모든 코드와 에러를 보여주고 싶어서 전부 들고왔는데 지저분해 보여도 양해를 부탁한다.. 

위 코드들을 천천히 살펴보면 앞서 글로 표현했던 에러 사항과 에러 사항에 맞는 에러 내용이 발생하는 것을 확인할 수 있다. 자, 그럼 에러 사항은 잘 확인했고 다음으로 해당 에러를 어떻게 잡을 수 있을까?

 

2. 문제 해결 방법 @Autowired 필드 명, @Qualifier, @Primary

위 처럼 같은 타입의 빈이 2개 이상일 때 해결하는 방법은 다음과 같다.

• @Autowired 필드 명 매칭
• @Qualifier 
• @Primary 사용

@Autowired 필드 명 매칭

보통 @Autowired를 사용하면 타입 매칭을 시도한다. 그런데 같은 타입의 빈이 두 개가 등록되어 있다면? @Autowired는 그 중 필드 이름, 파라미터 이름을 확인하고 매칭한다.

위와 같은 흐름을 가진다면, 논리 상 타입은 DiscountPolicy로 유지하고 필드 명을 fixDiscountPolicy로 수정하면 이름이 fixDiscountPolicy인 빈과 매칭될 것이다. 테스트 해보자.

필드명 fixDiscountPolicy로 수정

T1 테스트 코드 결과

 

위에서 업로드 했던 이미지T1 테스트 코드를 Run한 결과 성공이다. 의존관계 자동 주입이 잘 된 것이다.

 

@Autowired 매칭 정리

1. 타입 매칭
2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭

 

@Qualifier

@Qualifier는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다. 추가 구분자를 붙여주는 코드를 살펴보자.

 

구분자 명으로 fixDiscountPolicy 설정

구분자 명으로 mainDiscountPolicy 설정

 

위 이미지처럼 빈 등록시 @Qualifier를 붙여준다. 그리고 원하는 구분자 명을 적어준다.

다음으로 생성자로 자동 주입을 할 때 @Qualifier 사용 코드와 테스트 결과를 한 번 살펴보자.

생성자 자동 주입 예시

테스트 코드

테스트시 빈 이름은 바뀌지 않은 모습

 

의존관계 주입시 원하는 구문자 명을 빨간색 네모 상자와 같이 작성하고 테스트를 해보면 성공한다. 그리고 또한 위에서 구분자 명일 뿐 빈 이름은 바뀌지 않는다고 했는데, 결과를 보면 진짜로 빈 이름은 바뀌지 않은 걸 확인할 수 있다.

 

구분자 명을 통해서 의존관계를 주입하는 것은 굉장히 명확하고 가독성이 좋아 보인다. 하지만 @Qualifier의 단점이 한 가지 존재한다. 그것은 바로 컴파일 단계에서 오탈자 확인 불가능이다. 

@Qualifier("mainDiscountPolicy")이렇게 사용할 수 있긴 하지만 문자이기 때문에 컴파일 에러를 잡을 수 없다. 예를 들어 “mainDisssscountPolicy”)이렇게 오타를 냈을 때도 컴파일 에러를 잡을 수 없기 때문에 작동한다. 하지만 당연히! 실행하면 NoSuchBeanDefinitionException 오류가 발생할 것이다. (그래서 우리는 이렇게 사용하지 않고 직접 annotation을 만들어서 오타 발생시 컴파일 수준에서 에러를 잡을 수 있도록 만든다.)

 

@Qualifier

1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. 오탈자 기입시 NoSuchBeanDefinitionException 예외가 발생할 수 있음

@Primary 사용

우선순위를 정하는 방법이다. @Autowired시 여러 빈이 매칭되면 @Primary가 우선권을 가진다. 다른 코드를 건드리지 않고 오직 우선권을 가질 클래스에만 붙이면 끝이다. 

@Primary를 사용해 우선권 부여

위처럼 붙여주면 끝!

 

번외: 우선순위

@Primary는 기본값 처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier가 우선권이 높다.

 

3. 어노테이션 직접 만들기

@Qualifier를 설명할 때 언급했던 것처럼 @Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 어노테이션을 직접 만들어서 사용하면 문제를 해결할 수 있다.

MainDiscountPolicy라는 이름으로 어노테이션 생성

위와 같은 형식으로 어노테이션을 직접 만들 수 있다. 위에서 사용한 어노테이션들은 @Qualifier 파일에서 그대로 긁어온 것이다. 구분자 명으로 mainDiscountPolicy를 사용했다.

어노테이션 설정

 

위와 같이 직접 만든 어노테이션을 원하는 파일에 붙이면 @MainDiscountPolicy를 호출하면 해당 파일의 빈이 호출된다. 직접 만든 어노테이션을 사용해 원하는 빈을 호출 후 의존관계 자동 주입 시키는 코드는 다음과 같다.

직접 만든 어노테이션을 사용해 의존관계 자동 주입

 

위처럼 사용하면 직접 만든 어노테이션에 담긴 rateDiscountPolicy 빈이 자동 주입된다. 동작원리는 @Qualifier랑 비슷하지만 직접 만든 어노테이션을 사용했을 때는 어노테이션을 사용할 때 오탈자 기입시 해당 어노테이션이 존재하지 않으니까 바로 컴파일 에러로 오류를 잡을 수 있다는 장점이 있다.

 

번외: 자동, 수동의 올바른 실무 운영 기준

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.

 

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

 

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

 

!!김영한 강사님 강의

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8