[Spring] 다양한 의존관계 주입 방법

🤹‍♂️ 다양한 의존관계 주입 방법

의존관계 주입은 4가지 방법이 있다.

1. 생성자 주입
2. 수정자 주입 (setter 주입)
3. 필드 주입
4. 일반 메서드 주입

1. 생성자 주입

이름 그대로 생성자를 통해 의존관계 주입

생성자 호출시점에 한번만 호출되는 것이 보장된다.

불변, 필수 의존관계에 사용된다.

😮☝ 생성자가 딱 1개 있으면 @Autowired를 생략해도 자동 주입 된다. (스프링 빈에만 해당)

2. 수정자 주입(setter 주입)

필드 값을 변경하는 수정자 메서드를 통해 의존관계 주입

선택, 변경 가능성이 있는 의존관계에 사용된다.

자바빈 프로퍼티 규약의 수정자 메서드를 사용하는 방법이다.

 

📌 자바빈 JavaBean

JavaBeans Convention에 따라 작성된 자바 클래스🙆‍♀️ 컴포넌트 🙅‍♀️ 

 

📌 자바빈 프로퍼티 JavaBean Property

JavaBean에 저장되있는 값

 

📌 자바빈 프로퍼티 규약

필드의 값을 직접 변경하지 않고 getter, setter 메서드를 이용해서 값을 수정하거나 읽는 규칙

naming convention을 지키자! →  get/set+멤버변수(대문자로 시작)

 

다른 규약도 알아보자

📌JavaBean Convention

1) 자바빈 클래스에는 기본생성자가 있어야 한다.

2) 자바빈 클래스는 기본 패키지가 아닌 특정 지정한 패키지에 저장되어야 한다.

3) 멤버 변수에 직접 변경하는 것을 막자! 따라서 멤버 변수의 접근제어자는 private로 선언한다.

4) 멤버 변수에 접근하기 위해 getter, setter 메서드를 public으로 지정한다.

5) 직렬화(Serializable )가 가능해야 한다.(선택)→ 빈의 상태를 안정적으로 저장, 복원한다.

  🤔직렬화란? 객체를 입출력에 사용할 수 있도록 객체 멤버들을 바이트 형태로 변환시키는 것

3. 필드 주입

필드에 바~로 주입

코드가 간결해서 좋지만 테스트하기 힘들다. 외부에서 변경이 불가능하기 때문에 사용하지 말자

이런 상황에서만 사용하자!

1) 애플리케이션의 실제 코드와 관계없는 테스트 코드

2) 스프링 설정을 목적으로 하는 @Configuration 같은 곳 

4. 일반 메서드 주입

일반 메서드를 통해 주입

한번에 여러 필드를 주입받을 수 있지만 잘 사용 안한다 고한다 ~

 

 

👩‍🎤 옵션 처리

스프링 빈이 없어도 돌아가게 해야할 때가 있는데

@Autowired의 required 옵션의 기본값이 true라서 주입할 대상이 없어 오류가 날때가 있다.

자동 주입 대상을 옵션으로 처리하는방법을 알아보자

 

자동 주입할 대상이 없으면 ~~

1. @Autowired(required=false) : 수정자 메서드 자체가 오류가 나지 않는다.
2. org.springframework.lang.@Nullable : null이 입력된다.
3. Optional<> : Optional.empty가 입력된다.

 

 

👩‍🔬 생성자 주입 선택

과거에는 수정자 주입과 필드 주입을 많이 사용했다고 한다.

최근에는 DI 프레임워크 대부분이 생성자 주입을 권장한다고 하는데

이유는 불변, 누락, final 키워드 때문이다.

1. 불변

대부분의 의존관계 주입은 한번하면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 대부분 변하면 안된다.

수정자 주입을 사용하면 setXX 메서드를 public으로 열어두자.

생성자주입은 객체를 생성할때 한번만 호출되므로 불변하게 설계할 수 있다.

2. 누락

프레임워크 없이 순수한 자바 코드를 단위 테스트 할 때, 수정자 의존관계인 경우

@Autowired가 프레임워크 안에서 동작할 때 의존관계 없으면 오류발생한다. 

(지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트 수행한다.)

의존관계가 없으면 Null Point Exception이 발생하는데

 

생성자 주입을 사용하면 주입 데이터를 누락했을때 컴파일 오류가 발생한다.

제일 좋은 오류는 컴파일 오류~ 🧚‍♀️

 

3. final

생성자 주입 사용시 필드에 final 키워드를 사용할 수 있따.

그래서 컴파일 시점에 생성자에서 값이 설정되지 않는 오류를 막아준다.

java: variable discountPolicy might not have been initialized

😯 생성자 이후에 나머지 주입방식이 호출되기 때문에, 생성자 주입만 final 키워드를 사용할 수 있다고 한다!

 

 

🌶 롬복과 최신 트랜드

막상 개발하면 대부분 불변이라서 생성자에 final을 사용하게 된다고한다.

이걸 편하게 해주는게 롬복 라이브러리다.

롬복에서 제공하는 @RequiredArgsConstructor를 사용하면

final 필드를 모아서 생성자를 자동으로 만들어준다고 한다.👍

 

 

🤯 조회 빈이 2개 이상

@Autowired는 타입 Type으로 조회한다.

타입으로 조회하면 선택된 빈이 2개 이상일때 문제가 발생한다.

NoUniqueBeanDefinitionException 오류!

NoUniqueBeanDefinitionException: No qualifying bean of type
'hello.core.discount.DiscountPolicy' available: expected single matching bean
but found 2: fixDiscountPolicy,rateDiscountPolicy

하위 타입으로 지정할 시 DIP를 위배하고 유연성이 떨어진다.

똑같은 타입의 스프링 빈이 2개 있을 때도 해결이 안된다. 

해결방법은 세가지가 있다.

1. @Autowired 필드 명 매칭
2. @Qualifier → @Qualifier끼리 매칭 빈 이름 매칭
3. @Primary 사용

1. @Autowired 필드명

1) 타입 매칭 

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

 

2. @Qualifier

빈이름을 변경하는 것이 아니라 추가 구분자를 붙여준다.

1) 빈 등록할 때 @Qualifier를 붙여준다.

2) 주입할 때 @Qualifier("등록한 이름")을 적어준다.

3) @Qualifier 끼리 매칭

4) 빈 이름 매칭

5) NoSuchBeanDefinitionException 발생

 

3. @Primary

@Autowired 시에 여러빈이 매칭되면 @Primary가 우선권을 가진다. 

@Primary는 기본값처럼 동작되므로 @Qualifier가 더 우선권이 높다.

 

👩‍🏭 애노테이션 직접 만들기

아무렇게나 쓰지말고 공통으로 동작하는 것이 뭔지 꼭 필요한지 잘 생각해보고 만들어서 사용하자.

@interface 애너테이션명 {
	타입 요소이름(); // 애너테이션의 요소 선언
    ...
}

 

1. 타입을 @interface로 정의
2. 파라미터 멤버들의 접근 제어자는 public이나 default로 지정
3. annotation 추가
4. 요소 추가

 

📌 Annotation 요소의 규칙

• 요소의 타입은 기본형, String, enum, annotation, Class만 허용된다.
• () 안에 매개변수를 선언할 수 없다.
• 예외를 선언할 수 없다.
• 요소를 타입 매개변수로 정의할 수 없다.

 

📌 Annotation

JDK1.5버전 이상에서 사용가능하다.

자바 소스 코드에 추가하여 추가적인 정보를 제공하는 메타데이터이다.

 

built-in annotation과 meta annotation으로 나뉜다.

 

built-in annotation

Java 코드에서 적용되는 Annotation

• @Overried : 컴파일러에게 오버라이딩하는 것이라고 알린다.
• @Deprecated : 앞으로 사용하지 않을 것을 권장하는 대상에게 붙인다.
• @SupperssWarnings : 컴파일러의 특정 경고메시지가 나타나지 않게 해준다.

 

meta annotation

다른 Annotation을 정의하기 위한 Annotation

• @Target : annotation이 적용가능한 대상을 지정
• @Retention : annotation이 유지되는 범위 지정
• @Documented : annotation 정보가 javadoc으로 작성된 문서에 포함되게 한다.
• @Inherited : annotation이 자손 클래스에 상속되도록 한다.
• @Repeatable : annotation을 반복해서 적용할 수 있게 한다.

 

 

 👩‍🍳 조회한 빈이 모두 필요할 때, List, Map

스프링 빈이 다 필요할 때가 있다.

그럴때는 Map으로 모두 주입받고. 메서드를 정의하여 map에서 스프링 빈을 찾아 실행한다.

public int discount(Member member, int price, String discountCode) {
     DiscountPolicy discountPolicy = policyMap.get(discountCode);
     
     System.out.println("discountCode = " + discountCode);
     System.out.println("discountPolicy = " + discountPolicy);
     
     return discountPolicy.discount(member, price);
 }

 

Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고 값에는 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링빈을 담아준다.

해당하는 타입의 스프링 빈이 없으면 빈 컬렉션이나 Map을 주입한다.

 

스프링 컨테이너를 생성하면서 스프링 빈 등록하기

ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);

스프링 컨테이너는 생성자에 클래스 정보를 받는다.

클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

 

1) new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너 생성!

2) AutoAppConfig.class, DiscountService.class 를 파라미터로 넘기면서 해당 클래스 자동으로 스프링 빈 등록

 

 

 🦹‍♀️ 자동, 수동의 올바른 실무 운영 기준

1. 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있으니 자동 기능을 기본으로 사용하자!
2. 직접 등록하는 기술 지원 객체는 수동으로 등록하자!
3. 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고려하자!
   → 자동으로 할거면 특정 패키지에 묶기

 

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

 

1) 업무 로직 빈

controller(웹 지원), service(핵심 비즈니스 로직), repository(데이터 계층의 로직을 처리)

보통 비즈니스 요구사항을 개발할 때 추가되거나 변경됨

유사한 패턴이 있으니 자동 기능을 적극 사용하자 → 문제 파악 쉬움

 

2) 기술 지원 빈

기술적인 문제, 공통 관심사(AOP) 처리 시에 주로 사용

데이터 베이스 연결, 공통 로그 처리 등 업무로직을 지원하기 위한 하부 기술이나 공통 기술

업무 로직에 비해 수가 적고 애플리케이션 전반에 걸쳐 광범위하게 영향을 끼친다.

→ 수동 빈으로 등록하여 설정 정보에 명확하게 나타나게 하자

 

 

 

참조

 

남궁성, 자바의 정석 기초편, 도우출판, 2019

김영한, 스프링 핵심 원리 - 기본편 https://inf.run/ryWP 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

자바빈 - https://en.wikipedia.org/wiki/JavaBeans

자바빈 규약 - https://dololak.tistory.com/133

Annotation - https://mangkyu.tistory.com/130