인프런 스프링 기본 강의 정리 #7

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

• 생성자 주입
• 수정자 주입(setter 주입)
• 필드 주입
• 일반 메서드 주입

1) 생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법으로 가장 추천되는 방식이다. 

생성자 호출 시점에 1번만 호출되며 불변, 필수 객체로 유지된다. 또한 생성자가 1개인 경우 @Autowired를 생략 가능하다.

@Autowired
 public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {

 this.memberRepository = memberRepository;
 this.discountPolicy = discountPolicy;
 }

위 경우는 OderServiceImpl 생성자가 하나이므로 @Autowired를 생략 가능하다.

 

2) 수정자 주입

setter를 통해 주입한다. 컴파일 이후에도 변경 가능성이 있기 때문에 선택, 변경 가능성이 있는 의존관계에 사용한다.

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

'set + 객체 이름' 으로 지정하고 @Autowired를 붙여서 생성한다.

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

 

3) 필드 주입

 필드에 바로 주입하는 방법이다. @Autowired만 추가하면 되기 때문에 코드가 간결해서 실무에서 많이 사용하는데 외부에서 변경이 불가능해 테스트가 힘들다. DI프레임워크가 없으면 아무 것도 할 수 없다. 그렇기 때문에 가급적 사용하지 않는 것이 좋다.

@Component
public class OrderServiceImpl implements OrderService {

 @Autowired
 private MemberRepository memberRepository;
 
 @Autowired
 private DiscountPolicy discountPolicy;
}

 

4) 일반 메서드 주입

일반 메서드를 통해서 주입 받는 방법으로 한 번에 여러 필드를 주입받을 수 있다. 그러나 잘 사용하지는 않는다.

 @Autowired
 public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
 
 this.memberRepository = memberRepository;
 this.discountPolicy = discountPolicy;
 }
}

 

2. 옵션 처리

스프링 빈이 없어도 동작이 필요할 때가 있다. 이럴 경우에는 그냥 컴파일을 하면 빈이 null로 들어와서 오류가 발생한다. 이때 @Autowired의 옵션과 다른 옵션 처리 방법을 사용한다.

• @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안 된다
• org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
• Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

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.lang.reflect.Member;
import java.util.Optional;

public class AutoWiredTest {

    @Test
    void AutowiredOption(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }
    
    static class TestBean {

        //호출 안됨
        //기본적으로 Member는 스프링 관리 빈이 아니기 때문에 자동 주입 대상이 될 수 없다.
        //@Autowired(required=true)가 기본값으로 되어있기 때문에 자동 주입 대상이 없으면 오류가 발생한다.
        @Autowired(required = false)
        public void setNoBean1(Member member) {
            System.out.println("setNoBean1 = " + member);
        }

        //null 호출
        //결과 : noBean2 = null
        @Autowired
        public void setNoBean2(@Nullable Member member) {
            System.out.println("setNoBean2 = " + member);
        }

        //Optional.empty 호출
        //결과 : noBean3 = Optional.empty
        @Autowired(required = false)
        public void setNoBean3(Optional<Member> member) {
            System.out.println("setNoBean3 = " + member);
        }
    }
}

 

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

의존관계 주입 방법 중 생성자 주입이 다음과 같은 이유로 가장 권장된다.

 

1) 불변

• 의존관계 주입이 한 번 일어나면 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다. 오히려 의존관계는 애플리케이션 종료 전까지 변하면 안 된다.(불변해야 함)
• 생성자 주입은 객체 생성시 1번만 호출되기 때문에 이후 호출할 일이 없다. 불변 설계가 가능하다.
• 수정자 주입 사용시 setXXX등으로 메서드를 public으로 열여둬야 한다. 누군가 실수로 변경할 수 도 있고 의도적으로 변경할 수 있기 때문에 좋은 설계가 아니다.

2) 생성자 주입은 누락 문제가 발생하지 않는다.

• 생성자 주입은 주입 데이터를 누락했을 때, 컴파일 오류를 발생시켜서 에러를 미리 예방할 수 있다.
• 생성자 주입이 아닌 setter 주입의 경우, 다음과 같이 자바테스트코드를 작성하면 실행은 되지만 널포인터가 발생한다. 

//실행은 되지만 createOrder 내부에서 memoryMemberRepository 등의 메소드를 호출할 때 NPE가 발생

@Test
void createOrder() {
	OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
}

 

3) final 키워드를 사용할 수 있다.

• 생성자 주입 사용시 필드에 final 키워드를 사용할 수 있다. 생성자에서 값 설정이 안 되어 있을 때 컴파일 오류를 발생시킬 수 있어 좋다.
• 수정자 주입을 포함한 나머지 방식은 생성자 이후 호출되기 때문에 final 키워드를 사용할 수 없다.

public class OrderServiceImpl implements OrderService {

 private final MemberRepository memberRepository;
 private final DiscountPolicy discountPolicy;
 
 @Autowired
 public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
 
 this.memberRepository = memberRepository;
 }
 //...
}

위 코드에서는 필수 필드인 discountPolicy의 값이 설정되지 않았다. 이 경우 final 키워드가 사용되어 바로 컴파일 오류를 발생시킨다.

4. 롬복과 최신 트랜드

생성자 주입 방식이 선호되지만 코드가 길어지고 귀찮아진다. 이때 롬복 라이브러리를 사용하면 생성자 코드 없이

컴파일 시점에 생성자 호출이 가능하다.

 

먼저 롬복 라이브러리를 적용하기 위해 build.gradle을 수정한다.

plugins {
 id 'org.springframework.boot' version '2.3.2.RELEASE'
 id 'io.spring.dependency-management' version '1.0.9.RELEASE'
 id 'java'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

//lombok 설정 추가 시작
configurations {
 compileOnly {
 extendsFrom annotationProcessor
 }
}

//lombok 설정 추가 끝
repositories {
 mavenCentral()
}

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'
 }
}

test {
 useJUnitPlatform()
}

1. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)

2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)

3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

lombok을 이용해서 아래 기본 코드를 바꿔보도록 하자.

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

아래와 같이 롬복을 사용하여 @RequiredArgsConstructor을 붙여주면 된다.

@RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

memberRepository, discountPolicy에 인스턴스 참조값이 자동으로 주입되기 때문에 코드가 간결해진다.

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

 private final MemberRepository memberRepository;
 private final DiscountPolicy discountPolicy; 
 
}

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

@Autowired는 타입으로 조회한다. 만약 타입이 DiscountPolicy인 경우, ac.getBean(DiscountPolicy.class)처럼 동작한다.

그러나 자식타입으로도 인식을 하기 때문에 선택된 빈이 동일한 빈인 FixDiscountPolicy, RateDiscountPolicy로 2개일 경우 오류가 발생한다. 

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

조회 대상 빈이 2개 이상인 경우 해결할 수 있는 3가지 방법이 있다.

• @Autowired 필드 명 매칭
• @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
• @Primary 사용

1) @Autowired 필드 명 매칭

  @Autowired 는 타입 매칭을 시도한다. 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

//@Autowired
//private DiscountPolicy discountPolicy;
 
@Autowired
private DiscountPolicy rateDiscountPolicy;

 

 

2) @Qualifier 사용

@Qualifier는 빈 이름을 변경하는 것이 아닌 추가 구분자를 붙여주는 방법이다.

먼저 빈 등록시 @Qualifier를 붙여준다. 

//RateDiscountPolicy.java

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {
//...
}
 
//FixDiscountPolicy.java
 
@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {
//...
}

그리고 주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.

//OrderServiceImpl.java
 
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy 
discountPolicy) {

    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

만약 주입시에 @Qualifier("mainDiscountPolicy)를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 찾는다.

그러나 추천하지는 않는다.

 

3) @Primary 사용

@Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 갖는다.

//RateDiscountPolicy.java
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
 
//FixDiscountPolicy.java
@Component
public class FixDiscountPolicy implements DiscountPolicy {}

위 코드에서는 RateDiscountPolicy가 우선권을 가지고 호출된다.

 

- @Primary와 @Qualifier 활용

• 메인 데이터베이스 커넥션 : @Primary
• 서브 데이터베이스 커넥션 : @Qualifier

이때 @Primary와 @Qualifier 중 @Qualifier가 우선권을 갖는다.

스프링은 자동보다 수동이, 넓은 범위 선택권 보다 좁은 범위 선택권이 우선권이 높다.

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

@Qualifier("mainDiscountPolicy")와 같이 문자로 적으면 컴파일 시 타입 체크가 안 된다.

이 경우 다음과 같이 어노테이션을 만들어서 해결 가능하다.

 

먼저 src/main/java에 annotation 패키지를 생성하고, 그 아래에 MainDiscountPolicy 어노테이션 클래스를 생성한다.

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)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")

public @interface MainDiscountPolicy {

}

 

다음으로 어노테이션을 적용할 컴포넌트에 어노테이션을 붙여준다. 컴파일시 체크 가능하다.

RateDiscountPolicy를 mainDiscountPolicy로 설정한다.

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

 

이를 주입받을 생성자에도 어노테이션을 붙여준다.

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

//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {

 this.discountPolicy = discountPolicy;
}

 

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

해당 타입의 스프링 빈이 다 필요한 경우도 있다.

예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다.

 

src/test/java/autowired에 AllBeanTest 클래스를 생성한다.

먼저 Map과 List로 받는 static 설정정보를 만든다.

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

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

다음으로 테스트 코드를 작성한다.

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

        int rateDiscountPrice = discountService.discount(member, 20000,"rateDiscountPolicy");
        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(rateDiscountPrice).isEqualTo(2000);
    }

1. AnnotationConfigApplicationContext를 통해 스프링 컨테이너를 초기화한다.
   • AutoAppConfig 클래스는 @Configuration 어노테이션이 붙어있고, @ComponentScan을 통해 빈을 스캔한다.
   • 또한, DiscountService 클래스는 @Component 어노테이션이 붙어 자동으로 스프링 빈으로 등록된 클래스이다.
2. DiscountService 빈을 스프링 컨테이너에서 가져온다.
   • DiscountService 클래스는 생성자를 통해 Map<String, DiscountPolicy>과 List<DiscountPolicy>를 주입받는다.
   • 이 DiscountService는 다양한 할인 정책(DiscountPolicy)을 관리하고, 이를 사용하여 할인을 계산한다.
3. 테스트 메서드에서 DiscountService의 discount() 메서드를 호출하여 할인을 계산하고 결과를 검증한다.
   • member 객체와 금액을 전달하면서 fixDiscountPolicy와 rateDiscountPolicy를 각각 적용하여 할인을 계산한다.
   • assertThat을 사용하여 각 할인 정책을 통해 계산된 할인 금액이 예상한 값과 일치하는지 확인한다.
     • 첫 번째 호출에서는 fixDiscountPolicy를 사용하여 10,000원의 할인이 예상되고, 이를 검증한다.
     • 두 번째 호출에서는 rateDiscountPolicy를 사용하여 20,000원의 할인이 예상되고, 이를 검증한다.

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

빈등록은 자동등록방식과 수동등록방식으로 나눌 수 있다. 

• 자동 등록 방식 : @ComponentScan을 통해 @Component를 전체 조회하여 빈 등록
• 수동 등록 방식 : @Configuration을 사용하여 @Bean을 개별적으로 등록

자동 등록 방식은 주로 업무 로직을, 수동 등록 방식은 주로 기술 지원 로직에 사용된다.

• 업무 로직 빈: 웹 지원 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리
• 기술 지원 빈: 데이터베이스 연결이나, 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술

다만 업무 로직 빈들 중 다형성을 활용해야 하는 경우는 수동 등록 방식이 추천된다. 위의 List, Map을 활용하여 조회된 빈들을 받는 곳에서 자동등록을 사용하면 어떤 빈들이 주입되는지 알기 어렵다. 이런 경우 명시적으로 수동 등록 방식을 사용하면 해당 로직의 이해를 도울 수 있다.