의존 관계 자동 주입 - 1 (의존 관계 주입 방법들, 생성자 주입 사용 이유, lombok 설정 + 적용)

728x90

컴포넌트 스캔 (@ComponentScan, 의존 관계 자동 주입, 컴포넌트 스캔 위치 지정 + 제외)

컴포넌트 스캔 (@ComponentScan, 의존 관계 자동 주입, 컴포넌트 스캔 위치 지정 + 제외, )

싱글톤 컨테이너 - 2 (싱글톤 주의점, @Configuration, 바이트 코드 조작) 싱글톤 컨테이너 - 2 (싱글톤 주의점, @Configuration, 바이트 코드 조작) 싱글톤 컨테이너 - 1 (싱글톤 패턴 문제점 + 사용이유, 싱

soohykeee.tistory.com

의존관계 주입 방법들

의존관계 주입 방법은 크게 4가지가 존재한다.

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

생성자 주입

생성자 주입은 이름에서 보이듯 생성자를 통해서 의존관계를 주입받는 방법이다. 여태 프로젝트를 진행하며 주입해줬던 방법들이 생성자 주입이다. 생성자 주입의 특징은 다음과 같다.

생성자 주입은 생성자 호출시점에 오직 1번만 호출되는 것이 보장된다.
불변, 필수 의존관계에 사용한다.
생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입이 된다. (스프링 빈에만 해당)

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired	// --> 생성자가 1개만 있으므로 해당 어노테이션 생략 가능
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    
    // ... 생략
    
}

수정자 주입 (setter 주입)

생성자 주입은 setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.
해당 주입의 특징은 다음과 같다.

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

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public void setMemberRepository(MemerRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }
    
    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
    	this.discountPolicy = discountPolicy;
    }
    
    // ... 생략
    
}

참고
: @Autowired 의 기본 동작은, 주입할 대상이 없으면 오류가 발생한다. 따라서 만약 주입할 대상이 없어도 동작하게 하기 위해서는, @Autowired(required = false)로 작성해줘야 한다.

참고
: 앞서 말했던 자바빈 프로퍼티는, 자바에서 과거부터 필드의 값을 직접 변경하지 않고 setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 이것을 자바빈 프로퍼티 규약이라 한다. 예시는 다음과 같다.

public class Member {

    private Long id;
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

필드 주입

필드에 바로 주입하는 방법이다. 특징은 다음과 같다.

코드가 간결하지만, 외부에서 변경이 불가능해 테스트하기 어렵다는 단점이 존재
DI 프레임 워크가 없다면, 아무것도 할 수 없다.
사용안하는 것을 추천 ! (스프링 설정을 목적으로 하는 @Configuration 같은 곳, 또는 테스트 코드에 사용)

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private final MemberRepository memberRepository;
    
    @Autowired
    private final DiscountPolicy discountPolicy;
    
    // ... 생략
    
}

일반 메서드 주입

일반 메서드를 통해 주입받을 수 있다. 특징은 다음과 같다.

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

@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;
    }
   
    // ... 생략
    
}

참고
: 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 Member 같은 클래스에서 @Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.

옵션 처리

만약 주입할 스프링 빈이 없어도 동작해야 할 때가 존재한다. 하지만 앞서 말했듯이 스프링 빈이 없지만 @Autowired만 입력한다면 오류가 발생할 수 있다. 그 이유는 required 옵션의 기본값이 true로 되어있기 때문이다.

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

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

위의 옵션처리 기능들을 테스트해보기 위해 테스트 코드를 작성해보겠다.

public class AutowiredTest {

    static class TestBean {
    
        @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);
        }

    }

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

의존관계가 없기에 @Autowired(required = false)는 메서드 자체가 호출되지 않았고, @Nullable은 null로 입력이 되었고, Optional<>은 empty로 입력이 된 것을 확인할 수 있다.

생성자 주입을 선택해야 하는 이유

예전에는 수정자 주입과, 필드 주입을 주로 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그러한 이유는 다음과 같다.

불변

대부분의 의존관계 주입은 한번 일어나면, 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다 즉, 불변해야 한다.
수정자 주입을 사용하면, setXxx 메서드를 public 으로 선언해야 한다. 그렇게 되면, 누군가 실수로 변경할 수 있다. 변경하면 안되는 메서드를 public 으로 선언하는 것은 좋지 않은 설계방법이다.
앞서 설명했듯이, 생성자 주입은 객체를 생성할 때 1번만 호출되므로 이후에 호출될 일이 없다. 즉, 불변하게 설계할 수 있는 것이다.

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우에, 다음과 같이 수정자 의존관계인 경우

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public void setMemberRepository(MemerRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }
    
    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
    	this.discountPolicy = discountPolicy;
    }
    
    // ... 생략
    
}

@Autowired가 프레임 워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고있다.

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

그런데 막상 실행 결과는 NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.
만약 생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

final 키워드

생성자 주입을 사용하면, 필드에 final 을 사용할 수 있다. 그래서 만약 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

위의 코드를 보게되면, discoutPolicy에 값을 설정해야 하는데, 누락한것을 확인할 수 있다. 위처럼 작성하고 실행하게 되면 자바는 컴파일 시점에 오류를 발생시킨다.

참고
: 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

정리

위의 내용들을 정리하자면, 생성자 주입 방식을 선택하는 이유는 여러가지가 존재하지만, 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법이기에 그렇다. 또한 기본으로 생성자 주입 방식을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 그렇게 되면 생성자 주입과 수정자 주입을 동시에 사용할 수 있다. 필드 주입은 사용하지 않는 것이 좋다.

롬복과 최신 트렌드

막상 개발을 해보면, 대부분이 다 불변해야 하기에 필드에 final 키워드를 사용하게 된다. 하지만 이렇게 사용하다보면 생성자도 작성해줘야 하고, 주입 받은 값을 대입하는 코드도 만들어줘야 하는 번거로움이 존재한다. 필드 주입처럼 편리하게 코드를 작성할 방법은 없는걸까? 한번 지금 적용중인 기본 코드를 롬복을 이용하여 최적화 해보자.

기본 코드

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

최적화를 하기 위해, 우선적으로 앞서 말했듯이 위의 OrderServiceImpl 클래스에 생성자가 딱 1개만 존재하기에 @Autowired 어노테이션을 지워줄 수 있다. 또한 앞서 말했던 롬복을 적용시키면 된다. 롬복 라이브러리를 적용하면 @RequiredArgsContructor 어노테이션 기능을 사용하여 final이 붙은 필드를 모아 생성자를 자동으로 만들어준다. 그렇기에 해당 어노테이션을 작성해주면, 위의 기본코드의 생성자는 지워줘도 되는 것이다.

이러한 롬복 기능을 적용해주기 전에, build.gradle 설정 파일에 lombok과 관련된 dependency를 작성해줘야 한다.

compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    
}

위처럼 작성하게 되면 기존의 기본코드와 동일한 최적화된 코드이다.

728x90

저작자표시 (새창열림)

내 블로그 - 관리자 홈 전환	`Q` `Q`
새 글 쓰기	`W` `W`

글 수정 (권한 있는 경우)	`E` `E`
댓글 영역으로 이동	`C` `C`

이 페이지의 URL 복사	`S` `S`
맨 위로 이동	`T` `T`
티스토리 홈 이동	`H` `H`
단축키 안내	`Shift` + `/` `⇧` + `/`

의존 관계 자동 주입 - 1 (의존 관계 주입 방법들, 생성자 주입 사용 이유, lombok 설정 + 적용)

티스토리툴바

단축키

내 블로그

블로그 게시글

모든 영역