본 글은 김영한님의 강의 내용을 바탕으로 정리한 글입니다.
스프링 핵심 원리 - 기본편 - 인프런 | 학습 페이지
지식을 나누면 반드시 나에게 돌아옵니다. 인프런을 통해 나의 지식에 가치를 부여하세요....
www.inflearn.com
목차
- 다양한 의존관계 주입 방법
- 옵션 처리
- 생성자 주입을 선택해라!
- 롬복과 최신 트랜드
- 조회 빈이 2개 이상일 때
- @Autowired 필드명, @Qualifier, @Primary
- 애노테이션 직접 만들기
- 조회한 빈이 모두 필요할 때
- 자동, 수동의 올바른 실무 운영 기준
1. 다양한 의존관계 주입 방법
의존관계 주입은 크게 4가지 방법이 있다.
- 생성자 주입
- 수정자 주입 / Setter 주입
- 필드 주입
- 일반 메서드 주입
1) 생성자 주입
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,DiscountPolicy discountPolicy){
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
...
}지금까지의 구현 방식이며 제일 범용적인 사용이다.
생성자 호출방식은 불변 객체 , 필수 의존 관계에서 자주 사용된다.
생성자를 private final 필드에 넣어주는 방식으로 구현되므로 1번 호출을 보장하고, 싱글톤을 보장한다.
+ 중요 : 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. 물론 스프링 빈에만 해당한다
2) 수정자 주입
빈에서 set메서드를 만들어서 @AutoWired를 명시하는 방법으로 의존관계를 주입하기도 한다.
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void setMemberRepository(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
@Autowired
public void setDiscountPolicy(DiscountPolicy discountPolicy) {
this.discountPolicy = discountPolicy;
}
}기존에 final을 제외하고, 자바빈 프로퍼티 규약에 따라, set빈이름으로 메소드를 만들어주면,
@AutoWired가 달린 Setter메소드를 자동으로 호출해준다.
수정자 주입방식은 선택, 변경 가능성이 있는 의존관계에 사용한다.
3) 필드 주입
이름 그대로 클래스 필드에 @AutoWired를 명시하므로써, 의존성을 주입하는 방법이다.
@Component
public class OrderServiceImpl implements OrderService {
@Autowired
private MemberRepository memberRepository;
@Autowired
private DiscountPolicy discountPolicy;
}@AutoWired가 강력하다는것을 느낄 수 있다. 깔끔하고 심플해서 사용하고 싶지만
필드 injection은 Anti-pattren중 하나이다.
외부에서 변경 불가하여, 테스트가 어려워고, 난해한 상황이 발생하니 사용을 지양하자.
+ 단 , 간단한 테스트나, 특수한 목적으로는 쓸수있다
@Configuration에서 필드를 만들어서 의존관계를 주입하는 경우 조심스럽게 사용해 볼 수는 있지만,
비즈니스에서는 사용을 금한다.
4) 일반 메소드 주입
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}수정자 주입과 비슷하며, 생성자 주입으로 해결되기 때문에, 거의 메소드에 @AutoWired를 사용할 일이 없다.
스프링빈이 아닌 Member같은 클래스에서는 @AutoWired는 아무기능도 동작하지 않는다.
2. 옵션 처리 (Bean Null 처리)
@AutoWired는 연결이 없는 경우나 연결할 Bean이 Null인 경우 아래와 같이 처리할 수 있다
Spring에서 @AutoWired에 옵션으로 required=false로 호출을 막을 수도 있고,
@Nullable을 통해서 익셉션을 막거나, 자바 8이상에서 Optional을 통해서도 처리할 수 있다.
package hello.core.autowired;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;
import java.util.Optional;
public class AutowiredTest {
@Test
void AutowiredOption(){
ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}
static class TestBean{
//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
System.out.println("setNoBean1 = " + member);
}
//null 호출
@Autowired
public void setNoBean2(@Nullable Member member) {
System.out.println("setNoBean2 = " + member);
}
//Optional.empty 호출
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
System.out.println("setNoBean3 = " + member);
}
}
}
3. 생성자 주입을 선택해라!
다양한 의존관계 주입방법중에서도 우리는 생성자 주입을 공격적으로 사용해야한다.
불변성 , 누락시 컴파일 에러, final 키워드를 통한 생성자 설정여부를 컴파일 시점에 확인 할 수 있다.
생성자 주입을 이용하면, 의존관계를 변경할 일이 없어지므로 좋다.
그러므로 위에 소개한 다양한 의존관계 주입법중 항상 생성자 주입을 적극 활용하자.
가끔 옵션이 필요한 경우에만 수정자 주입을 사용하고 그 외에 방법을 지양하자.
4. 롬복과 최신 트랜드
백엔드 개발을 하다보면 컴포넌트가 대부분이 불편성을 가지므로 생성자 주입을 사용해야 한다.
그런데, 생성자 주입방법은 private final 필드를 만들어 생성자를 통해 주입 받도록 설정하는데 귀찮은 작업이다.
롬복 라이브러리가 제공하는@RequiredArgsConstructor 기능을 사용하면
final 이 붙은 필드를 모아서 생성자를 자동으로 만들어 준다. (다음 코드에는 보이지 않지만 실제 호출 가능하다)
롬복 사용 전 (생성자가 하나이므로 @AutoWired가 생략된 상황임)
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}롬복 사용 후
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}
build.gradle 롬복 추가 (사용을 위해서는 아래와 같이 롬복 설정을 추가하여 다운받아야 한다)
...
// 롬복 설정추가 시작
configurations {
compileOnly{
extendsFrom annotationProcessor
}
}
// 롬복 설정추가 끝
...
dependencies {
...
//lombok 라이브러리 추가 시작
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
//lombok 라이브러리 추가 끝
...
}
...해당 내용 추가후 Reload로 설치
이후에 Setting > Annotation Processors > Enable annotation processing 체크 (재시작)
롬복 라이브러리를 통해서,
생성자 주입이 어노테이션으로 생략가능하고, Setter, Getter 까지도 어노테이션 하나로
코드로는 보이지 않지만, 손쉽게 사용가능하게 해준다.
+ 롬복 예제
@RequiredArgsConstructor 를 통해 final 이 붙은 필드를 모아서 생성자를 자동으로 만들어주었다.
이것 외에 @Setter , @Getter, @ToString 예제도 만들어 보자
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@Setter
@Getter
@ToString
public class HelloLombok {
private String name;
private int age;
public static void main(String[] args) {
HelloLombok helloLombok = new HelloLombok();
helloLombok.setAge(27);
helloLombok.setName("Bang");
System.out.println("helloLombok.name = " + helloLombok.name);
System.out.println("helloLombok.age = " + helloLombok.age);
System.out.println("helloLombok = " + helloLombok); //toString 까지 만들어줌
}
}
우리가 자주 만들어야했던 클래스의 Construter, Setter, Getter, ToString , EqualsAndHashCode 등을
어노테이션 하나로 쉽게 사용가능하게 해준다.
5. 조회 빈이 2개 이상 - 문제
@AutoWired는 타입으로 Bean을 조회하기 때문에 2개 이상의 빈이 등록되는 경우,
NoUniqueBeanDefinitionException 이 발생한다.
Ex) discountPolicy - fixDiscountPolicy , rateDiscountPolicy
그렇다고 구현체에 의존하도록 설계할 순 없다.
어떠한 방법으로 자동 의존 관계주입에서 2개이상의 빈이 등록되었을때 하나만 연결되도록 설정해줄 수 있을까?
그 방법은 아래와 같이 3가지가 있다.
6. @Autowired 필드명, @Qualifier, @Primary
1) @AutoWired 필드명을 변경
@Autowired
private DiscountPolicy discountPolicy@Autowired
private DiscountPolicy rateDiscountPolicy의존관계 주입을 필드명을 빈이름으로 생성하여 적어주면,
2개 이상인 경우, 해당 필드명에 빈을 찾아 Mapping해준다.
2) @Qualfier 사용
추가 구분자로 @퀄리파이어를 이용하면, 빈 객체에 별칭을 부여하는것과 같다.
여러 빈 객체의 충돌이 우려되는 부분에 @Qualfier("별칭명") 을 주어서
등록된 빈의 별칭을 추가로 찾아서 매칭시켜준다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}매칭시 사용
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까?
그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
하지만 경험상 @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋기 때문에,
아예 사용을 안하거나, 모든 Bean에 설정하여 사용하는 방식으로 통일된 비즈니스 작업을 하는게 좋다.
3) @Primary
@Primary는 최 우선 순위를 정해주는 어노테이션이다.
@Autowired 시에 여러 빈이 매칭되면 @Primary 가 명시된 빈이 최우선적으로 매칭된다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}@Qualfier보다는 사용에 편의성을 가진다.
만약 @Qualfier @Primary가 둘 다 명시된다면, Spring은 자동보다 수동 설정에 우선권을 가지기 떄문에,
@Qualifier가 우선적으로 Mapping될 것이다. 물론 둘다 명시해서 난잡한 설정을 하지 않아야 한다.
7. 어노테이션 직접 만들기
@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.
타입체크와 컴파일타임에 에러검사는 규모있는 시스템 구축에 매우 중요한 일이다.
우리는 위에 예시보다 더 효과적으로 에러검출 및 테스트를 돕도록 애노테이션을 만들어서 문제를 해결할 수 있다.
package hello.core.annotataion;
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)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}애노테이션에는 상속이라는 개념이 없다.
이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qulifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
단적으로 @Autowired도 재정의 할 수 있다.
물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.
8. 조회한 Bean이 모두 필요할 때
의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자.
스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.
package hello.core.autowired;
import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
public class AllBeanTest {
@Test
void findAllBean() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
DiscountService discountService = ac.getBean(DiscountService.class);
Member member = new Member(1L, "userA", Grade.VIP);
int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
assertThat(discountService).isInstanceOf(DiscountService.class);
assertThat(discountPrice).isEqualTo(1000);
}
static class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
System.out.println("policyMap = " + policyMap);
System.out.println("policies = " + policies);
}
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);
}
}
}해당 테스트에서 DiscountService라는 정적 DI클래스를 정의하고, 사용하여 테스트를 진행한다.
ac.getBean을 통해 2개 이상의 조회된 빈을 DiscountService 생성자를 통해 Map과 List를 통해 받아줄 수 있다.
discount를 호출할때, 자신의 원하는 빈 이름을 넣어서 받아온 빈중에 선택 사용이 가능하도록 구현해주고
테스트하는 코드이다.
이렇게 2개이상의 빈을 ApplicationContext에 getBean을 통해 받아오는 빈 객체들을
Map이나 List로 넘겨받아 저장할 수 있다.
9. 자동, 수동의 올바른 실무 운영 기준
스트링은 수동보다 자동의존관계 주입을 더 많이 지원하고 있고, 사용하고 있는 추세이다.
이를 통해 유지보수 비용도 절감하고, 더 객체 지향적인 코드를 작성할 수 있다.
그동안 우리가 만들었던 DI컨테이너 AppConfig의 불필요한 사용을 지양하고,
@Component와 @Autowired를 적극 활용하여 OCP ,DIP 등 SOILD 기본원칙을 잘 지키는 좋은 구현을 하자.
+ 수동 빈 등록은 언제 사용하는게 좋을까?
1) 기술 지원 로직
수동 빈등록은 기술지원 로직에 많이 사용될 수 있다.
애플리케이션 전반에 걸쳐 광범위하게 영향을 미치는
기술 지원 로직 : AOP(공통 관심사), DataBase연결, 공통 로그 처리 등의
비즈니스 요구사항에 해당되는 서비스가 아닌 공통 하위 기술들을
가급적 수동 Bean등록을 사용하여 따로 관리해주는것이 유지보수에 더 좋다.
2) 다형성을 적극 활용할 때
방금 전 할인 정책 Bean과 같이 인터페이스를 활용해 다형성을 가지는 Bean을 관리할 때에는
아래와 같이 자동 등록보다 수동 빈 등록으로 따로 관리해주는게 쉽게 연결을 구성하고 변경하기 좋다.
@Configuration
public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
정리
- 편리한 자동 기능을 기본으로 사용하자
- 직접 등록하는 기술 지원 객체는 수동 등록을 하자
- 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자
소스코드 ↓
'Study > Java Spring Boot' 카테고리의 다른 글
| [Spring] 핵심 원리 9 빈 스코프 (0) | 2022.02.28 |
|---|---|
| [Spring] 핵심 원리 8 빈 생명주기 콜백 (0) | 2022.02.23 |
| [Spring] 핵심 원리 6 컴포넌트 스캔 (@Component) (0) | 2022.02.18 |
| [Spring] 핵심 원리 5 싱글톤 컨테이너 (싱글톤 패턴과 주의점) (0) | 2022.02.15 |
| [Spring] 핵심 원리 4 스프링 컨테이너와 빈 (Spring 전환) (0) | 2022.02.10 |
