(1) 다양한 의존관계 주입 방법
1) 생성자 주입
<1> 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.
<2> 특징:
1> 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
2> 불변( setter를 만들지 않는다 ), 필수( final ) 의존관계에 사용
( 항상은 아니고 주로 이렇게 사용한다 )
3> 생성자가 딱 1개만 있으면 @Autowired 생략가능
2) 수정자 주입( setter 주입 )
<1> setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 외존관계를 주입하는 방법이다.
<2> 특징:
1> 선택, 변경 가능성이 있는 의존관계에 사용
2> 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
cf) @Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도
동작하게 하려면 @Autowired(required = false) 로 지정하면 된다.
3) 필드 주입
<1> 이름 그대로 필드에 바로 주입하는 방법이다.
<2> 특징:
1> 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트하기
힘들다는 치명적인 담점이 있다.
2> DI 프레임워크가 없으면 아무것도 할수없다.
3> 사용하지 말자!
1. 애플리케이션의 실제 코드와 관계 없는 테스트 코드에서는 사용해도 된다.
2. 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
4) 일반 메서드 주입
<1> 일반 메서드를 통해서 주입 받을 수 있다.
<2> 특징:
1> 한번에 여러 필드를 주입 받을 수 있다.
2> 일반적으로 잘 사용하지 않는다.
cf) 어쩌면 당연한 이야기지만 의존관계 자동주입은 스프링 컨테이너가 관리하는 스프링 빈이어야
동작한다. 스프링 빈이 아닌 클래스에서 @Autowired 코드를 적용해도 아무 기능도 동작하지
않는다.
(2) 옵션 처리
1) 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서 자동 주입 대상이
없으면 오류가 발생한다.
2) 자동 주입 대상을 옵션으로 처리하는 방법
<1> @Autowired(required = false) -> 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
<2> org.springframework.lang.@Nullable -> 자동 주입할 대상이 없으면 null 이 입력된다.
<3> Optional<> -> 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.
cf) @Nullable , Optional<> 은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서
특정 필드에만 사용해도 된다.
(3) 생성자 주입을 선택하는 이유 ( 과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는
스프링을 포함한 DI프레임워크 대부분이 생성자 주입을 권장한다. )
1) 불변
<1> 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이
없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다. ( 불변해야 한다 )
<2> 수정자 주입을 사용하면, setter 메서드를 public 으로 열어두어야 한다.
<3> 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이
아니다.
<4> 생성자 주입은 객체를 생성할 떄 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서
불변하게 설계할 수 있다. ( 변경할 방법이 없다. )
2) 누락
<1> 프레임워크 없이 순수한 자바 코드를 단위 태스트 하는 경우에 수정자 의존관계인 경우
<2> 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 '컴파일 오류'가 발생한다. 그리고 IDE에서
바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
3) final 키워드 사용가능
<1> 생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 같이
실행되지 않는 오류를 컴파일 시점에 막아준다.
<2> 필수 필드에 값을 설정해야 햐는데, 이 부분이 누락되면 자바는 컴파일 시점 에
java: variable discountPolicy might not have been initialized 라는 오류를 발생시킨다.
<3> 기억하자!!! 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다.
cf) 수장자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를
사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.
4) 정리
<1> 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한
자바 언어의 특징을 잘 살리는 방법이기도 하다.
<2> 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로
부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
<3> 항상 생성자 주입을 선택해라!! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라!! 필드
주입은 사용하지 않는게 좋다.
(4) 롬복과 최신 트랜드 ( 필드주입을 사용하지 않고, 필드주입처럼 편리하게 사용하는 방법이 없을까? )
1) @RequiredArgsConstructor
<1> 롬복 라이브러리가 제공하는 기능으로써 final 이 붙은 필드를 모아서 컴파일 시점에 생성자를
자동으로 생성해준다. ( 코드상으로는 보이지 않지만 호출이 가능하다. )
<2> 특히 의존관계 주입할 떄 매우매우 편리하다.
<3> 정리:
1> 최근에는 생성자를 딱 1개만 두고, @Autowired 를 생략하는 방법을 주로 사용한다. 여기에
Lombok 라이브러리의 @RequiredArgsConstructor 와 함꼐 사용하면 기능은 다 제공하면서,
코드는 깔끔하게 사용할 수 있다.
2) @Setter
<1> 클래스안에 모든 필드를 가지고 Setter 를 자동으로 만들어 준다. ( 코드상으론 보이지 않는다 )
3) @Getter
<1> 클래스안에 모든 필드를 가지고 Getter 를 자동으로 만들어 준다. ( 코드상으론 보이지 않는다 )
4) @AllArgsConstructor
<1> 모든 필드를 넣은 생성자를 자동으로 만들어 준다. ( 코드상으론 보이지 않는다 )
5) @NoArgsConstructor
<1> 기본 생성자를 자동으로 만들어 준다. ( 코드상으론 보이지 않는다 )
6) @Data
<1> 클래스안에 모든 필드를 가지고 Setter, Getter 를 만들어 준다. ( 코드상으론 보이지 않는다 )
(5) 조회 빈이 2개 이상일 떄의 문제점 과 해결방법
1) 문제점:
<1> @Autowired 는 타입으로 조회한다.
<2> 타입으로 조회하기 때문에, 마치 ac.getBean(DiscountPolicy.class); 와 유사하게 동작한다.
( 실제로는 더 많은 기능을 제공한다. )
<3> 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.
( NoUniqueBeanDefinitionException 발생 )
(그렇다고 해서 구체화에 의존하면 안된다. DIP를 위배하고 유연성이 떨어지고, 이름만 다르고
완전히 똑같은 타입의 스프링 빈이 2개 있을 떄 해결이 안된다. )
2) 해결법:
<1> 조회 대상 빈이 2개 이상일 때 해결방법
1> @Autowired 필드 명 매칭
1. 타입 매칭
ex) @Autowired 는 먼저 타입으로 매칭을 시도한다.
( 결과가 1개면 필드명은 신경쓰지 않는다. )
2. 타입 매칭의 결과가 2개 이상일 때 필드 명으로 빈 이름 매칭
ex) 필드명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을경우에 추가로
동작하는 기능이다. 여러 빈이 있으면 필드 이름( 파라미터 이름 ) 으로 빈 이름을
추가 매칭한다. ( 즉, 필드명을 다르게 준다. )
2> @Qualifier 끼리 매칭 ( 빈 이름 매칭 )
1. 추가 구분자를 붙여주는 방법이다.
2. 주입시 추가적인 옵션을 제공하는 것이지 '빈 이름을 변경하는 것은 아니다'.
3. 주입시에 @Qualifier 를 붙여주고 등록한 이름을 적어준다.
4. @Bean 을 사용한 직접 빈 등록시에도 동일하게 사용가능하다.
5. 타입도 못찾고, 추가적으로 스프링 빈에서 이름도 못찾으면 NoSuchBeanDefinitionException 이
발생한다.
※ @Qualifier 를 주입할때 등록한 이름을 못찾으면 어떻게 할까?
그럴때는 @Qualifier() 괄호 안에 적은 이름의 스프링 빈을 추가로 찾는다.
하지만 @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.
ex) 생성자 자동 주입시에 파라미터 앞에 붙여서 사용가능하고,
수장저 자동 주입시에도 파라미터 앞에 붙여서 사용가능하고,
필드 자동 주입시에도 사용가능하다.
3> @Primary 사용 ( 자주 사용한다 )
1. @Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면
@Primary 가 우선권을 가진다.
2. @Primary 가 붙으면 모든걸 다 무시하고 가장 우선적으로 선택되어서 주입된다.
3. 보통 메인 데이터베이스가 있고 서브 데이터베이스가 있을 때 메인 데이터베이스에
@Primary 를 붙여서 @Qualifier 없이 편리하게 조회하고, 서브 데이터베이스를
사용해야할 때 @Qualifier 를 사용해서 다른 이름으로 불러와서 사용하는 방법을
많이 사용한다. ( 이렇게하면 코드가 깔끔해진다 )
(6) 애노테이션 직접 만들기
1) Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.
2) 그럴때는 애노테이션을 만들어서 문제를 해결할 수 있다.
<1> 먼저 애노테이션을 만들고
ex)
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {}
<2> 사용하고 싶은곳에 붙여준다.
1. @Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{}
2. 생성자 자동주입
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
3) 이렇게 애노테이션을 만들어두면 컴파일타임에 요류체크가 가능해지게 된다.
4) 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이
지원해주는 기능이다.
5) @Qualifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired 도
재정의 할 수 있다. 물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은
유지보수에 더 혼란만 가증할 수 있다.
6) @Primary 로 해결이 가능한 상황이면 최대한 @Primary 로 해결하는 것이 좋다.
(7) 조회한 빈이 모두 필요할 때 ( List, Map )
1) 의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
2) 예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류( 정률할인, 정가할인 ) 를 선택할 수
있다고 가정했을 때, 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.
ex)
class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
}
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}
3) 이렇게 설계하면 DiscountService 는 Map으로 DiscountPolicy 타입의 모든 스프링 빈을 주입받는다.
( 있는 갯수만큼 )
4) discount 메서드는 discountCode 로 넘어온 이름으로 Map 에서 해당 스프링 빈을 찾아서 실행한다.
5) Map<String, DiscountPolicy> -> Map 의 키에 스프링 빈의 이름을 넣어주고, 그 값으로
DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. ( 자식객체도 모두 포함 )
6) List<DiscountPolicy> -> DiscountPolicy 로 조회한 모든 스프링 빈을 담아준다.
( 자식객체도 모두 포함 )
7) 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map 을 주입한다.
(8) 자동, 수동의 올바른 실무 운영 기준
1) 편리한 자동 기능을 기본으로 사용하자
<1> 스프링이 나오고 시간이 갈수록 점점 자동을 선호하는 추세다.
<2> 스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository 처럼 계층을 맞추어
일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 더해서 최근 스프링
부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면
자동으로 등록하도록 설계했다.
<3> 설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는
것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면
끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을
일일이 적어주는 과정은 상당히 번거롭다.
<4> 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
<5> 결정적으로 자동 빈 등록을 사용해도 OCP 와 DIP 를 지킬 수 있다.
2) 그러면 수동 빈 등록은 언제 사용하면 좋은가
<1> 애플리케이션은 크게 업무 로직과 기술지원 로직으로 나눌 수 있다.
1> 업무로직 빈: 웹을 지원하는 컨트롤러, 핵심 비지니스 로직이 있는 서비스, 데이터 계층의
로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비지니스 요구사항을 개발할 때
추가되거나 변경된다.
2> 기술지원 빈: 기술적인 문제나 공통 관심사( AOP ) 를 처리할 때 주로 사용된다. 데이터베이스
연결이나, 공통 로그 처리 처럼, 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
3> 업무로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도
유사한 패턴이 있다. 이런경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도
어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
4> 기술지원로직은 업무로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서
광범위하게 영향을 미친다. 그리고 업무로직은 문제가 발생했을 때 어디가 문제인지 명확하게
잘 드러나지만, 기술지원로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가
많다. 그래서 이런 기술지원로직들은 가급적 수동 빈 등록을 사용해서 명확하게
드러내는 것이 좋다.
3) 애플리케이션에 광범위하게 영향을 미치는 기술지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에
바로 나타나게 하는 것이 유지보수 하기 좋다.
<1> 참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다.
이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다.
스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술지원로직까지 내부에서
자동으로 등록하는데, 이런 부분은 메뉴얼을 참고해서 스프링 부트가 의도한 대로 편리하게
사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술지원 객체를 스프링 빈으로
등록한다면, 수동으로 등록해서 명확하게 드러내는 것이 좋다.
4) 비지니스 로직 중에서 다형성을 적극활용할 때
<1> 의존관계 자동 주입, 조회한 빈이 모두 필요할 때 Map 이나 List 를 사용하는 상황을 다시 보자.
만약 의존관계 자동주입으로 Map 에 주입을 받는 상황을 생각해보자.
여기에 어떤 빈들이 주입될지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악하기가
어렵다. 내가 개발했으니 크게 관계가 없겠지만, 만약 이 코드를 다른 개발자가 개발해서 나에게
준 것이라면 어떨까? 자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야하는
문제가 생긴다.
<2> 이런 경우 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 묶어두는게 좋다.
여기서 핵심은 '한눈에 딱 보고 이해가 되어야 한다'.
ex) 이 부분을 별도의 설정 정보로 만들고 수동으로 등록하면 다음과 같다.
@Configuration
public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
이 설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다.
그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy 의 구현 빈들만
모아서 특정 패키지에 모아두자.
5) 정리
<1> 편리한 자동 기능을 기본으로 사용하자.
<2> 직접 등록하는 기술지원 객체는 수동 등록하자.
<3> 다형성을 적극 활용하는 비지니스 로직은 수동 등록을 고민해보자.
참고자료:
인프런 -> 김영한 스프링 핵심 원리 - 기본편
'Java > Spring' 카테고리의 다른 글
| Spring Gradle 09. 빈 스코프 (0) | 2022.06.15 |
|---|---|
| Spring Gradle 08. 빈 생명주기 콜백 (0) | 2022.06.15 |
| [Spring] Maven 세팅하기 (0) | 2022.06.15 |