[Spring] 스프링 핵심 원리 기본편 7) 의존관계 자동 주입

스프링 핵심 원리 - 기본편

Session 7 의존관계 자동 주입 

1. 다양한 의존 관계 주입 방법

1) 의존관계 주입 방법

생성자 주입

수정자 주입(setter 주입)

필드 주입

일반 메서드 주입

 

2) 생성자 주입

생성자를 통해서 의존 관계를 주입받는 방법

생성자 호출 시점에 딱 1번만 호출되는 것이 보장됨, 불변, 필수 의존 관계에 사용

생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입된다

@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;
	}
}

 

3) 수정자 주입(setter 주입)

setter라 불리는 필드 값 변경하는 수정자 메서드 통해 의존 관계 주입하는 방법

자바 빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법(setXxxx, getXxxx)

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

@Autowired의 기본 동작은 주입 대상이 없으면 오류 발생, 주입 대상이 없어도 동작하게 하려면@Autowired(required = false)로 지정

@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;
	}
}

 

3) 필드 주입

필드에 바로 주입하는 방법

코드가 간결하지만 외부에서 변경이 불가능해 테스트하기 힘들다는 단점이 있다.

DI프레임워트가 없으면 아무것도 할 수 없다. 사용하지 말자!

# 애플리케이션의 실제 코드와 관계없는 테스트 코드, 스프링 설정을 목적으로 하는 @configuration 같은 곳에서만 특별한 용도로 사용

 

@Component
public class OrderServiceImpl implements OrderService {
    @Autowired private MemberRepository memberRepository;
    @Autowired private DiscountPolicy discountPolicy;
}

4) 일반 메서드 주입

일반 메서드를 통해서 주입받을 수 있다.

한 번에 여러 필드를 주입받을 수 있으나 일반적으로 잘 사용하지 않는다.

의존 관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 빈이 아닌 클래스에 @Autowired 해도 동작하지 않음

@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;
    }
}

---

2. 옵션 처리

스프링 빈이 없어도 동작해야 할 때 자동 주입 대상을 옵션으로 처리하는 방법

1) @Autowired(required = false)

자동 주입할 대상이 없으면 메서드 자체가 호출 안됨

 

2) @Nullable

자동 주입할 대상이 없으면 null 입력됨

 

3) Optional<>

자동 주입할 대상이 없으면 Optional.empty 입력

// Member는 스프링 빈이 아님       
@Autowired(required = false)
public void setNoBean1(Member noBean1) {
    System.out.println("noBean1 = " + noBean1);
}
// 의존 관계가 없어어 메서드 호출 자체가 안됨

@Autowired
public void setNoBean2(@Nullable Member noBean2) {
    System.out.println("noBean2 = " + noBean2);
}

@Autowired
public void setNoBean3(Optional<Member> noBean3) {
    System.out.println("noBean3 = " + noBean3);
}

---

3. 생성자 주입을 선택해라

1) 불변

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

수정자 주입을 사용하면 public으로 열어두기 때문에 실수로 변경할 수도 있어 열어두는 것은 좋은 설계 방법이 아니다.

생성자 주입은 객체를 생성할 때 1번만 호출되고 이후에 호출되는 일이 없어 불변하게 설계 가능하다

 

2) 누락

생성자 주입은 누락했을 때 컴파일 오류로 에러를 미리 예방 가능하다.

수정자 주입인 경우 순수한 자바 테스트 코드를 실행하면 실행은 되지만 NullPointerException발생

memberRepository, discountPolicy 의존 관계 주입이 누락되었기 때문

 

3) final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용가능해 값이 설정되지 않으면 컴파일 오류 발생, 에러를 컴파일 시점에서 미리 예방 가능

나머지 방식은 생성자 이후에 호출되기 때문에 final 키워드 사용 불가

 

4) 정리

프레임워크에 의존하지 않고, 순순한 자바 언어의 특징을 잘 살리는 방법

기본으로 생성자 주입을 사용하고 필수 값이 아닌 경우 수정자 주입 방식을 옵션으로 사용하자

---

4. 롬복과 최신 트렌드

1) 롬복 라이브러리 적용

build.gradle 파일 수정

//lombok 설정 추가 시작
configurations {
     compileOnly {
         extendsFrom annotationProcessor
     } 
}
dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'
	//lombok 라이브러리 추가 시작
	compileOnly 'org.projectlombok:lombok' 
	annotationProcessor 'org.projectlombok:lombok'
	testCompileOnly 'org.projectlombok:lombok' 
	testAnnotationProcessor 'org.projectlombok:lombok' 
	//lombok 라이브러리 추가 끝
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	} 
}

 

2) 롬복 적용

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
	private final MemberRepository memberRepository;
	private final DiscountPolicy discountPolicy;
}

롬복이 자바의 애노테이션 프로세서라는 기능을 이용해 컴파일 시점에서 생성자 코드를 자동으로 생성해 줌

@RequiredArgsConstructor 애노테이션이 final이 붙은 필드를 모아서 생성자를 만들어준다.

생성자를 직접 작성할 필요가 없으니 필드 추가하기 편리하다

---

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

1) @Autowired는 타입으로 조회한다

타입으로 조회하기 때문에 ac.getBean(DiscountPolicy.class) 메서드와 유사하게 동작

Fix와 Rate 둘 다 스프링 빈으로 선언되어 있으면 NoUniqueBeanDefinitionException 발생

하위 타입으로 지정할 수도 있지만, 하위타입 지정은 DIP위배, 유연성이 떨어짐, 이름만 다르고 똑같은 타입의 스프링 빈이 있는 경우도 해결 안 됨

이를 해결하는 여러 방법 존재

---

6. @Autowired 필드명, @Qualifier, @Primary

1) 조회 대상 빈이 2개 이상일 때 해결방법

@Autowired 필드명 매칭

@Qualifier 끼리 매칭 → 빈이름 매칭

@Primary 사용

 

2) @Autowired 필드명 매칭

타입 매칭을 시도하고 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭

@Autowired
private DiscountPolicy rateDiscountPolicy;

타입인 DiscountPolicy로 매칭을 시도 fixDiscountPolicy, rateDiscountPolicy 2개 조회, 이때 rateDiscountPolicy 필드명으로 rateDiscountPolicy를 주입해 준다.

 

3) @Qualifier

추가 구분자를 붙여주는 방법, 빈이름이 변경되는 것은 아니다.

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

// 생성자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
   this.discountPolicy = discountPolicy;
}

@Qualifier를 이용해 추가 구분자를 붙여주고 생성자에서 @Qualifier을 이용해 구분자로 지정해 준다.

만약 @Qualifier("mainDiscountPolicy")를 못 찾으면 mainDiscountPolicy 이름의 스프링 빈을 추가로 찾고 스프링 빈조차도 없으면 NoSuchBeanDefinitionException 발생

@Qualifier는 @Qualifier를 찾는 용도로만 사용하자

 

4) @Primary

우선순위를 지정해 주는 방법, @Primary가 우선순위를 가진다.

 @Component
 @Primary
 public class RateDiscountPolicy implements DiscountPolicy {}
 
 @Component
 public class FixDiscountPolicy implements DiscountPolicy {}

 

5) @Qualifier, @Primary 활용

메인 데이터베이스 커넥션을 획득하는 스프링빈, 가씀 사용하는 서브용 데이터베이스 커넥션을 획득하는 스프링 빈이 있을 때

메인 데이터베이스 사용하는 빈은 @Primary 적용, 서브 데이터베이스 사용하는 빈은 @Qualifier를 지정해서 명시적으로 획득하는 방식을 사용하면 코드 간결하게 유지 가능

@Qualifier가 @Primary보다 우선권이 높다

---

7. 애노테이션 직접 만들기

1) 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일 시 타입 체크를 할 수 없다 ▶ 애노테이션을 만들어 해결

@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

// 생성자 자동 주입
@Autowired
 public OrderServiceImpl(MemberRepository memberRepository,@MainDiscountPolicy DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
 }

---

8. 조회한 빈이 모두 필요할 때 List, Map

1) 조회한 빈이 모두 필요할 때

해당 타입의 스프링 빈이 모두 필요할 때 스프링을 사용하면 전략패턴을 매우 간단하게 구현할 수 있다.

 

2) 테스트 코드 작성

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

스프링 컨테이너를 생성하면서 AutoAppConfig와 DiscountService를 스프링 빈으로 자동 등록!

@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> polices) {
    this.policyMap = policyMap;
    this.polices = polices;
}

DiscountService는 Map<String, DiscountPolicy> DiscountPolicy타입으로 조회한 모든 DiscountPolicy를 주입받는다(fix와 rate 모두 주입) 스프링 빈이름과 스프링 빈을 반환

List<DiscountPolicy>는 DiscountPolicy 타입으로 조회한 모든 스프링 반환

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

int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
// rateDiscountPolicy 스프링 빈을 찾아 적용한다.

dicount() 메서드는 discountCode로 스프링 빈을 찾아서 실행

---

9. 자동, 수동의 올바른 실무 운영 기준

1) 편리한 자동 기능을 기본으로 사용하자

스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원, 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고 다양한 스프링 빈들을 조건이 맞으면 자동으로 등록하도록 설계

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적

스프링 빈을 등록할 때 @Component 만 넣어주면 등록가능(수동 등록 시 설정 정보에서 @Bean을 적고 객체 생성, 주입할 대상 적는 일을 생략 가능)

관리할 빈이 많아서 설정 정보가 커지면 관리하는 것 자체에 부담

OCP, DIP 만족 

 

2) 수동 빈 등록은 언제 사용하면 좋을까?

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

 

2-1) 업무 로직

웹을 지원하는 컨트롤러, 핵심 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

컨트롤러, 서비스, 리포지토리처럼 어느 정도 유사한 패턴이 있음, 문제가 발생하여도 어떤 곳에서 문제가 발생했는지 명확하게 파악가능하기 때문에 자동 빈 등록을 사용하는 것이 좋다

 

2-2) 기술 지원 로직

기술적인 문제나 공통관심사 AOP를 처리할 때 사용, 데이터베이스 연결, 공통 로그처리처럼 업무 로직을 지원하니 위한 하부 기술이나 공통 기술

업무 로직에 비해 수가 적음, 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미침, 문제가 발생했을 때 파악이 어려운 경우가 많아 가급적 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋다

 

3) 다형성을 적극 활용하는 비즈니스 로직은 수동 빈 등록을 고려하자

이전 강의를 보면 DiscountService가 의존관계 자동 주입으로 Map<Stirng, DiscountPolicy>에 주입받는 빈이 어떤 빈인지, 어떤 이름인지  코드만 보고 파악이 불가하고 파악하려면 여러 코드를 찾아봐야 함

▶ 이런 경우 수동 빈으로 등록하거나 자동 빈 등록을 하되 특정 패키지에 같이 묶어두는 것이 좋다.

// 별도의 설정 정보를 만들고 수동으로 등록
@Configuration
 public class DiscountPolicyConfig {
     @Bean
     public DiscountPolicy rateDiscountPolicy() {
         return new RateDiscountPolicy();
     }
     @Bean
     public DiscountPolicy fixDiscountPolicy() {
         return new FixDiscountPolicy();
     }
}

특정 패키지에 같이 묶어둠

4) 정리

편리한 자동 기능을 기본으로 사용

직접 등록하는 기술 지원 객체는 수동 등록

다형성을 적극 활용하는 비즈니스 로직은 수동 등록 고민