스프링 스터디 ; 의존관계 자동 주입, 빈 생명주기 콜백

강의 출처

의존관계 자동 주입

의존관계 주입은 크게 네 가지의 방법이 존재합니다.

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

생성자 주입

= 생성자 호출시점에 딱 한 번만 호출됩니다. 따라서 불변, 필수 의존관계에서 사용하는 주입 방식입니다. 이때 생성자가 딱 한 개만 있으면 @Autowired를 생략해도 자동 주입됩니다.

@Component
public class OrderServiceImpl implements OrderService{
	private final MemberRepository memberRepository;
    private final DisocuntPolicy discountPolicy;
    
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
    	this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;}}

수정자 주입(setter 주입)

이는 선택, 변경 가능성이 있는 의존관계에서 사용하는 방식입니다. @Autowired의 경우 주입할 대상이 없으면 오류가 발생하는데 이때 @ Autowired(requried=flase)로 하면 된다.

@Component
public class OrderServiceImpl implements OrderService{
	private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;
    
    @Autowired
    public void setMemberRepositry(MemberRepository memberRepository){
    this.memberRepository=memberRepository;
  }
  
  @Autowired
  public void setDiscountPolicy(DiscountPolicy discountPolicy){
  	this.discountPolicy = discountPolicy;
    }
}

필드 주입

이는 필드에 바로 주입하는 코드이기 때문에 코드가 매우 간결합니다. 하지만 외부에서 변경이 불가능하므로 테스트하기가 힘들다는 단점이 존재합니다. 즉, DI 프레임워크가 없으면 아무것도 할 수 없습니다.(순수한 자바 테스트 코드에서는 @Autowired가 동작하지 않고, 스프링 컨테이너를 테스트에 통합한 경우에만 가능합니다.) 따라서 애플리케이션의 실제 코드와 관계 없는 테스트 코드나 스프링 설정을 목적으로하는 @Configuration과 같은 곳에서만 특별한 용도로 사용하는 것이 좋습니다.

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

일반 메서드 주입

일반 메소드를 통해서도 주입 받을 수 있습니다. 한 번에 여러 필드를 주입 받을 수 있는데 주로 생성자 주입과 수정자 주입을 사용하므로.. 굳이 사용하지는 않습니다.

@Component
public class OrderServiceImpl implementes OrderSerivce{
	private MemberRepository memberRepository;
    private Discountpolicy discountPolicy;
    
    @Autowired
    public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy){
    	this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
        }
}

옵션 처리

주입할 스프링 빈이 없어도 동작해야할 경우가 생깁니다. 이때 사용할 수 있는 옵션은 총 세가지 입니다.

• @Autowired(required=false)
• @Nullable
• Optional<>

// 주입할 대상이 없이면 수정자 메소드가 호출되지 않습니다.
@Autowired(required=false){
public void setNoBean1(Member member){}

// 주입 대상 없으면 null이 입력됩니다.
@Autowired
public void setNoBean2(@Nullable Member member){}

// 주입 대상 없으면 Optional.empty가 입력됩니다.
@Autowired(required=false)
public void setNoBean3(Optional<Member> member){}

✔ 최근에는 DI 프레임 워크 대부분이 생정자 주입을 권장합니다.
왜냐하면 대부분의 의존관계 주입은 한 번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없습니다. 오히려 불변이어야하는 경우가 많습니다. 또한, 수정자 주입을 사용한다면 set~ 메소드를 public으로 오픈해두어야합니다. 그러면 실수로 외부에서 건드리게 되는데 이는 좋은 코딩 이 아닙니다. 또한 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생합니다.(생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있게 되어 생성자에서 값이 설정되지 않는다면 컴파일 시점에서 찾아낼 수 있습니다.) 따라서 이를 통해 어떤 값을 필수로 주입해야하는지 금방 파악할 수 있게 됩니다. (수정자 주입을 사용하는 경우 test에 가서야 null point exception이 발생할 가능성이 존재합니다.)

롬복

개발에서는 대부분이 불변이라 위와 같이 생성자에 final 키워드를 사용하게 됩니다. 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어줍니다.
(getter setter, toString.. 등의 메소드를 만들어주는 등 다양한 기능을 롬복이 제공해주고 있으며, 최근에는 많이 사용되는 추세입니다.)

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

조회 빈 중복

: 의존관계 주입시 조회 빈이 2개 이상 존재하게 되면 문제가 발생합니다.
@Autowired는 타입(Type)으로 조회하게 되는데 이때 선택된 빈이 2개 이상이면 문제가 발생합니다. (NoUniqueBeanDefinitionException)
FixDiscountPolicy, RateDiscountPolicy가 있을 때

@Autowired
private DiscountPolicy discountPolicy

로 하면 오류가 발생합니다. 이때 하위 타입으로 지정할 수도 있지만 이는 DIP(추상화에 의존해야한다.)를 위배하기 때문에 권장하지 않습니다. 이를 해결할 수 있는 방법은 또 존재합니다.

• @Autowired 필드 명 매칭
• @Qualifier
• @Primary

@Autowired 필드명

먼저 타입 매칭을 시도하고, 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능입니다. 타입 매칭의 결과가 두개 이상일 때 필드명이나 파라미터 명으로 빈 이름을 매칭합니다.

@Autowired
private DiscountPolicy rateDiscountPolicy

@Qualifier

(이는 빈 이름을 변경하는 것은 아닙니다.)

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

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

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy){
	this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

빈 등록시에도 사용 가능합니다.

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy(){
}

@Primary 사용

이는 우선순의를 정하는 방식입니다. @Primary가 우선권을 갖습니다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{}

@Qualifier vs @Primary

코드에서 자주 사용하는 메인 DB의 커넥션을 획득하는 스프링 빈은 @Primary를 사용해서 조회하는 곳에서 @Qualifier의 지정 없이 사용하는 것이 편합니다. 하지만 서브 DB 커넥션 획득하는 경우에는 @Qualifier로 명시적으로 획득하는 방식을 사용하면 깔끔하게 유지할 수 있습니다.
여기서 우선권은 사실 @Qualifier이 더 높습니다. 스프링은 자동보다는 수동이, 넓은 범위의 선택권보다는 좁은 범위의 선택권이 우선순위가 높기 때문입니다.

애노테이션 만들기

하단은 예제입니다.

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

조회 빈 List, Map

조회한 빈이 모두 필요할 때 사용합니다.

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.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");

}

	static 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);
System.out.println("discountCode = " + discountCode);
System.out.println("discountPolicy = " + discountPolicy);
return discountPolicy.discount(member, price);
}
}
}

해당 코드는 다음과 같이 작동합니다.

• DiscountService는 Map으로 모든 DiscountPolicy를 주입받습니다.
• discount() 메서드에서 discountCode를 기반으로 스프링 빈을 찾아서 실행합니다.
  
  

Map을 사용하면 키에 스프링 빈의 이름을 넣어주고 그 값으로 DiscountPolicy 타입으로 조회한 스프링 빈을 담아주고, List<DiscountPolicy>는 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아줍니다.
해당하는 타입의 스프링 빈이 없으면 빈 컬렉션이나 Map을 주입합니다.

✔ 참조
스프링 컨테이너는 생성자에 클래스 정보를 받습니다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록됩니다.
new AnnotationConfigApplication(AutoAppConfig.class, DiscountService.class)

해당 코드는 new AnnotationConfigApplicationContext()로 스프링 컨테이너를 생성하고,파라미터를 자동으로 스프링 빈으로 등록합니다.
즉, 스프링 컨테이너를 생성하면서 해당 컨테이너에 동시에 스프링 빈을 자동 등록하는 것입니다.

자동, 수동의 실무 운영 기준

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

👉 업무 로직 빈
: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 레포지토리 등이 모두 업무 로직입니다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경됩니다.
(=> 숫자도 매우 많고, 유사한 패턴이 존재합니다.)
(=> 이런 경우 자동 기능을 적극 사용하는 것이 좋습니다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽습니다.)

👉 기술 지원 빈
: 기술적인 문제나 공통 관심사를 처리할 때 사용됩니다. DB 연결이나 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들입니다.
최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했습니다.
(=> 이는 잘 적용되고 있는지 파악하기 어려운 경우가 많습니다. 그래서 이는 가급적 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋습니다.)

따라서, 애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수하기 좋습니다.

비즈니스 로직 중에서 다형성을 적극 활용할 때
조회한 빈이 모두 필요할 때 사용한 List, Map을 다시 확인해봅시다.
DiscoutnService가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입을 받는 상황에서는 자동 등록을 사용하고 있으므로 (코드 개발자가 아닌) 다른 개발자는 로직을 파악하는데 시간이 걸릴 것입니다. 이 경우 수동 빈으로 등록하거나, (자동을 사용한다면) 특정 패키지에 같이 묶어두는 것이 좋습니다.

// 별도의 설정 정보로 만들고 수동으로 등록한다면
// 한 눈에 빈의 이름과, 주입되는 상황을 파악할 수 있게 됩니다.
// 그래도 자동 등록을 사용하고 싶다면
// DiscoutnPolicy의 구현 빈들만 따로 모아서 특정 패키지에 모아두는 것이 좋습니다.
@Configuration
public class DiscountPolicyConfig{
	@Bean
    public DiscountPolicy rateDiscountPolicy{
    	return new RateDiscountPolicy();}
    
    @Bean
    public DiscountPolicy fixDiscountPolicy{
    	return new FixDiscountPolicy();
        }
}

스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 그대로 두고, 스프링 부트가 아니라 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋습니다.

---

빈 생명주기 콜백

애플리케이션 시작 시점에 필요한 연결을 미리 해두고 종료 시점에 연결을 모두 종료하는 작업을 진행하려면 객체의 초기화와 종료 작업이 필요합니다.

스프링 빈은 객체 생성 👉 의존관계 주입 이라는 라이프 사이클을 가집니다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야합니다. 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메소드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공합니다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줍니다.

정리된 스프링의 이벤트 라이프 사이클은 다음과 같습니다.

1) 스프링 컨테이너 생성 2) 스프링 빈 생성 3) 의존관계 주입 4) 초기화 콜백 5) 사용 6) 소멸 전 콜백 7) 스프링 종료

참조 : 객체의 생성과 초기화를 분리하자
생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성합니다.
하지만 초기화는 생성된 값을 활용해서 외부 커넥션을 연결하는 등의 역할을 합니다.
따라서 생성자 안에서 무거운 초기화 작업을 함께하는 것은 유지보수 관점에서 좋지 않습니다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순하면 생성자에서 한 번에 처리하는 것이 나을 수도 있습니다.

참고 : 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되므로 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어납니다. 싱글톤처럼 컨테이너와 시작과 종료까지 생존하는 빈도 있지만 생명주기가 짧은 빈들도 존재합니다.

스프링은 크게 세가지 방법으로 빈 생명주기 콜백을 지원합니다.
1. 인터페이스
2. 설정 정보에 메소드 지정
3. @PostContstruct, @PreDestroy

인터페이스

import org.springrframework.beans.factory.DisposableBean;
//  destroy() 메소드로 소멸 지원
import org.srpingframework.beans.factory.InitializingBean;
// afterPropertiesSet() 메소드로 소멸 지원

public class NetworkClient implemets InitializingBean, DisposableBean{
	private String url;
    
    public NetworkClient(){}
    
    public void setUrl(String url){
    	this.url= url;}
    
    // 서비스 시작시 호출
    public void connect(){}
    
    public void call(String message){
    	System.out.println("call: "+url+"message= "+message);}
   
    //서비스 종료시 호출
	public void disConnect() {
		System.out.println("close + " + url);
	}
	@Override
	public void afterPropertiesSet() throws Exception {
		connect();
		call("초기화 연결 메시지");
		}
	@Override
	public void destroy() throws Exception {
		disConnect();
		}
		}

사용한 인터페이스는 스프링 전용 인터페이스로서, 해당 코드가 스프링 전용 인턴페이스에 의존하게 됩니다. 따라서 메소드의 이름을 변경할 수 없고, 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없습니다.

메소드 지정

: 설정 정보에 초기화, 소멸 메소드를 지정할 수 있습니다.
위와 동일하게 서비스 시작시 호출할 connect(), disConnect()를 NetworkClient 클래스에 지정해두고 설정 정보에 지정하면 됩니다.

@Configuration
static class LifeCycleConfig{
	
    @Bean(initMethod = "init", destroyMethod="close")
    public NetworkClient networkClient(){
    	NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("~");
        return networkClient;
        }}

이러한 방법은 메소드 이름을 자유롭게 줄 수 있으며 스프링 빈이 스프링 코드에 의존하지 않는다는 장점이 있습니다. 또한 코드가 아니라 설정 정보를 사용하므로! 코드를 고칠 수 없는 외부 라이브러에도 초기화, 종료 메소드를 적용할 수 있습니다.

@Bean의 destroyMethod는 기본값이 (inferred)여서 close, shutdown이라는 이름의 메소드를 자동으로 추론해서 호출해줍니다. 따라서 직접 스프링 빈으로 등록하려면 종료 메소드는 따로 적어주지 않아도 잘 동작합니다. 추론 기능을 사용하기 싫으면 destroyMethod = ""처럼 빈 공백을 지정하면 됩니다.

애노테이션

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class NetworkClient {
  private String url;
  
  public NetworkClient() {
  	System.out.println("생성자 호출, url = " + url);
  }
  
  public void setUrl(String url) {
  	this.url = url;
  }
	//서비스 시작시 호출
	public void connect() {
		System.out.println("connect: " + url);
	}
	public void call(String message) {
		System.out.println("call: " + url + " message = " + message);
	}
	//서비스 종료시 호출
	public void disConnect() {
		System.out.println("close + " + url);
	}
	@PostConstruct
	public void init() {
		System.out.println("NetworkClient.init");
		connect();
		call("초기화 연결 메시지");
	}
	@PreDestroy
	public void close() {
		System.out.println("NetworkClient.close");
		disConnect();
	}
  }

해당 방법은 최신 스프링에서 가장 권장하는 방법입니다. javax.annotation.PostConstruct라는 패키지를 봐도 파악할 수 있듯 스프링에 종속적인 기술이 아니라 자바 표준입니다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작합니다. 하지만 외부 라이브러리에는 적용하지 못한다는 단점은 존재합니다.