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

---

다양한 의존 관계 주입 방법

---

다양한 의존관계 주입 방법에 대해 예제 코드와 함께 공부해 보도록 하겠습니다.

의존 관계 주입에는 4 가지 방법이 있습니다.

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

 

생성자 주입

---

생성자에 @Autowired를 하면 스프링 컨테이너에 @Component로 등록된 빈에서 생성자에 필요한 빈들을 주입합니다.

 

특징

• 생성자 호출 시점에 1번만 호출되는 것이 보장됩니다.
• 불변과 필수 의존 관계에서 사용됩니다.
• 사용자가 1개만 존재하는 경우에는 @Autowired를 생략해도 자동 주입 됩니다.
• NullPointerException을 방지할 수 있습니다.
• 주입받을 필드를 final로 선언 가능합니다.

@Component
public class SnackService {
    private final MemberRepository memberRepository;
    private final SnackRepository snackRepository;

    @Autowired
    public SnackService(SnackRepository snackRepository, MemberRepository memberRepository){
        this.snackRepository = snackRepository;
        this.memberRepository = memberRepository;
    }

 

 

수정자 주입(setter 주입)

---

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

 

특징

• 선택과 변경 가능성이 있는 의존 관계에 사용됩니다.
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법입니다.

@Component
public class SnackService {
    private MemberRepository memberRepository;
    private SnackRepository snackRepository;

    @Autowired
    public SnackService(SnackRepository snackRepository, MemberRepository memberRepository){
        this.snackRepository = snackRepository;
        this.memberRepository = memberRepository;
    }
    @Autowired
    public void setMemberRepository(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }
    
    @Autowired
    public void setSnackRepository(SnackRepository snackRepository){
        this.snackRepository = snackRepository;
    }

 

• 생성자 대신 set필드명 메서드를 생성하여 의존 관계를 주입하는 것이 생성자 주입과의 차이점입니다.
• 수정자의 경우 @Autowired를 입력하지 않으면 실행이 되지 않습니다.
  • @Component가 실행하는 클래스를 스프링 빈으로 등록합니다.
  • 스프링 빈으로 등록한 다음 의존 관계를 주입하게 되는데 @Autowired 있는 것들을 자동으로 주입하게 됩니다.

 

 

필드 주입

---

필드에 @Autowired를 붙여 바로 주입하는 방법입니다.

 

특징

• 코드가 간결해서 예전에 많이 사용된 방식이지만, 외부에서 변경이 불가능하여 테스트하기 힘들다는 단점이 있습니다
• DI 프레임워크가 없으면 아무것도 할 수 없습니다.
• 실제 코드와 상관없는 특정 테스트를 하고 싶을 때 사용할 수 있습니다.
• 정상적으로 작동되게 하려면 결국 setter가 필요하게 돼서 수정자 주입을 사용하는 게 더 편리합니다.

 

@Component
public class SnackService {
    @Autowired
    private MemberRepository memberRepository;
    @Autowired
    private SnackRepository snackRepository;
    }

 

 

일반 메서드 주입

---

일반 메서드를 사용해 주입하는 방법입니다.

 

특징

• 한 번에 여러 필드를 주입받을 수 있습니다.
• 일반적으로 사용되지 않습니다.

 

옵션 처리

---

주입할 스프링 빈이 없을 때 동작해야 하는 경우가 있습니다.

• @Autowired만 사용하는 경우 requried 옵션 기본값인 true가 사용되어 자동 주입 대상이 없으면 오류가 발생하는 경우가 있을 수 있습니다.
• 스프링 빈을 옵셔널 하게 해 둔 상태에서 등록이 되지 않고, 기본 로직으로 동작하게 하는 경우입니다.
• 자동 주입 대상 옵션 처리 방법
  • @Autowired(required=false): 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출되지 않게 됩니다.
  • org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null이 입력됩니다.
  • Optional<>: 자동 주입할 대상이 없으면 Optional.empty가 입력됩니다.

 

 

실습 예제

sample_Project 패키지에 AutowiredTest.java 클래스를 작성합니다.

 

package developingman.sample_Project;

import developingman.sample_Project.member.Member;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {
    public static void main(String[] args){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }

    static class TestBean {
        @Autowired(required = false)
        public void setBean1(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);
        }
    }
}

 

출력 결과

 

 

생성자 주입을 사용해야 하는 이유

---

과거에는 수정자, 필드 주입을 많이 사용했지만, 최근에는 대부분 생성자 주입 사용을 권장합니다.

 

이유

• 불변
  • 의존 관계 주입은 처음 애플리케이션이 실행될 때 대부분 정해지고 종료 전까지 변경되지 않고 변경되어서는 안 됩니다.
  • 수정자 주입 같은 경우 이름 메서드를 public으로 열어두어 변경이 가능하기 때문에 적합하지 않습니다.
  • 누군가 실수로 변경할 수도 있고, 애초에 변경하면 안 되는 메서드가 변경할 수 있게 설계하는 것은 좋은 방법이 아닙니다.
  • 생성자 주입은 객체를 생성할 때 최초로 1번만 호출되고 그 이후에는 다시는 호출되는 일이 없기 때문에 불변하게 설계할 수 있습니다.
• 누락
  • 호출했을 때는 NPE(Null Point Exception)이 발생하는데 의존관계 주입이 누락되었기 때문에 발생합니다.
  • 생성자 주입을 사용하면 주입 데이터 누락 시 컴파일 오류가 발생합니다.
• final 키워드 사용 가능
  • 생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있습니다.
  • 생성자에서 값이 설정되지 않으면 컴파일 시점에서 오류를 확인할 수 있습니다.
  • java: variable(데이터 이름) might not have been initialized
  • 생성자 주입을 제외한 나머지 주입 방식은 생성자 이후에 호출되는 형태이므로 final 키워드를 사용할 수 없습니다.
• 순환 참조
  • 순환 참조를 방지할 수 있습니다.
  • 필드 주입과 수정자 주입은 빈이 생성된 후에 참조를 하기 때문에 애플리케이션이 어떠한 오류와 경고 없이 구동됩니다.
    • 실제 코드가 호출될 때까지 문제를 알 수 없습니다.
  • 생성자를 통해 주입하게 되면 BeanCurrentlyInCreationException이 발생하게 됩니다.