의존관계 자동 주입

업데이트:

의존성 주입 방법

생성자 주입

  • 생성자를 통해 의존관계를 주입, 컴파일시 빈에서 객체를 찾아 주입한다.
  • 생성자 호출시점에 딱 1번만 호출되는 것을 보장됨
  • 불변, 필수 항목에 대해 주입
  • 생성자가 한개일 경우 @Autowired 생략가능

셋터 주입

  • 선택, 변경 가능성이 있는 의존관계에 사용
  • 자바빈 프로퍼티 규약의 수정자 메서드 방식 사용(setter)
  • @Autowired(required = false) 설정할 경우 주입할 빈이 없어도 동작한다.

자밥빈 프로퍼티는 자바에서 값을 직접 변경하지 않고 set.., get.. 라는 메서드를 통해 값을 읽거나 수정하는 규칙을 말한다.

필드 주입

  • 외부에서 변경하기 불가능해 테스트 하기가 어렵다
  • DI 프레임워크가 없으면 아무것도 할 수 없다.
  • 사용 X
  • Test에서만 사용

일반 메서드 주입

  • 한번에 여러 필드에 주입 받을 수 있다.
  • 수정자 주입과 비슷하다.
  • 일반적으로 사용하지 않는다.

옵션 처리

주입할 스프링 빈이 없어도 동작해야 될때 사용한다.

reequired

  • false로 설정할 경우 주입할 대상이 없으면 생성자 메서드 자체가 호출되지 않음
@Autowired(required = false)
public void setNoBean1(Member noBean1){
    System.out.println("noBean1 = " + noBean1);
}

@Nullable

  • 자동 주입할 대상이 없는 경우 null 입력됨
@Autowired
public void setNoBean2(@Nullable Member noBean2){
    System.out.println("noBean2 = " + noBean2);
}

**Optional**

  • Optional 객체로 감싸서 사용
  • 빈이 없는 경우 빈 Optional이 생성되고 빈이 있는 경우 Optional 생성됨
@Autowired
public void setNoBean2(Optional<Member> noBean3){
    System.out.println("noBean3 = " + noBean3);
}

생성자를 통한 DI 권장

최근에 스프링을 포함한 DI 프레임워크에서 권장되는 주입 방식이다,

불변

  • 애플리케이션은 주입 후 종료 시점까지 의존성을 변경할 일이 없고 대부분은 변경되어서는 안됀다.
  • 수정자 주입의 경우 public으로 실수 혹은 변경되어선 안되는 주입이 변경될 수 있다.
  • 객체 생성시 딱 한번만 생성되기 떄문에 불변이다.
  • 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류가 발생하거 어떤 값을 필수로 넣어야 할지 알 수 있따.

final 사용

  • 주입되는 객체에 final 키워드를 사용함으로써 생성자 시점에 값이 넣어지지 않으면 오류를 컴파일 시점에 막아준다.

정리

  • 프레임 워크에 의존하지 않고 순수한 자바 언어의 특징을 살리는 방법이다.
  • 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우 수정자 주입방식을 옵션으로 부여하면 된다.
  • 항상 생성자 주입을 사용하고 옵션이 필요한 경우 수정자 주입 사용, 필드 주입은 사용 X

Lombok

어노테이션 기반으로 코드를 자동완성 해주는 라이브러리다.

Equlas

ToString

@AllArgsConstructor

  • 모든 변수를 사용하는 생성자를 자동 완성 해준다.

@NoArgsConstructor

  • 변수를 사용하지 않는 기본 생성자를 자동완성 시켜준다.

@Getter, @Setter

  • 변수의 getter, setter를 자동으로 만들어준다.

@RequiredArgsConstructor

  • 특정 변수만을 활용하는 생성자를 자동완성 시켜준다. -생성자의 인자로 추가할 변수에 @NotNull 어노테이션을 붙여서 변수를 생성자의 인자로 추가할 수 있다.
  • final이 붙은 클래스 변수에 DI를 해주는 생성자 주입 메서드를 만들어준다.
  • 직접 생성자 함수를 만들 필요가 없음

@EqualsAndHashCode

  • equals 함수와 hashCode 함수를 자동으로 생성해준다.

@ToString

  • 변수들 기반으로 ToString을 만들어준다.

빈 중복(구현체) 처리 방법

@Autowired 필드명 매칭

  1. 타입으로 매칭한다.
  2. 타입 매칭이 2개 이상일떄 필드명, 파라미터 명으로 매칭한다.

@Quilifier

  • 추가 구분자를 붙여주는 방법으로 빈이름이 변경되는건 아니다.
  • 빈등록시 @Quilifier를 붙여주고 주입시 등록한 이름을 적어준다.
//주입
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy{

}

//주입되지 않음
@Component
@Qualifier("subDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy{
}


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

@Primary

  • 우선순위를 정하는 방법이다.
  • @Autowired 시에 가장 우선권을 가진다.
//주입
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{

}

//주입되지 않음
@Component
public class FixDiscountPolicy implements DiscountPolicy{
}


//RateDiscountPolicy 주입됨
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rageDiscountPolicy){
    this.memberRepository = memberRepository;
    this.discountPolicy = rageDiscountPolicy;
}

@Primary, @Quilifier 활용
코드에서 자주 사사용하는 메인 데이터베이스의 커넥션을 획득하는 빈이 있고 가끔 사용하는 서브 데이터베이스가 있는 경우 메인은 @Primary를 사용함으로써 명시적으로 입력하지 않아도 기본으로 사용할 수 있도록 하고 서브는 @Quilifier를 사용하여 명시적으로 필요할때 획득하게 하여 코드를 깔끔하게 구분 할 수 있다.

우선순위
@Primary는 기본값처럼 동작하고 @Quilifier 상세 내용을 정의하므로 상새내용을 입력하는 @Quilifier가 우선권을 갖는다.

어노테이션 생성

  • @Qualifier대신에 어노테이션으로 만들어 좀 더 명확하게 사용할 수 있다고 생각하면 됨
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{
}

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy rageDiscountPolicy){
    this.memberRepository = memberRepository;
    this.discountPolicy = rageDiscountPolicy;
}

조회한 빈이 모두 필요할때

클라이언트가 직접 선택할때 빈을 조회해서 고를 수 있게 한다.(전략 패턴)

List, Map

  • List와 Map을 활용하면 클러이언트에서 선택한 항목을 통해 주입을 할수 있다.
  • 전략패턴을 활용
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");

        Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);
        Assertions.assertThat(discountService).isEqualTo(1000);

    }

    static class DiscountService{
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> polices;

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

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

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

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

  • 객체를 생성학소 주입하는 걸 일일이 적어주는 과정은 상당히 번거롭다.
  • 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

수돟 빈 등록 사용

  • 업무 로직 : 컨트롤러, 서비스, 리포지토리등은 요구사항에 따라 추가되거나 변경된다.
    • 숫자도 많고 한번 개발하면 어느정도 유사한 패턴이 있다. 이런경우에는 자동기능을 적극 사용하는게 좋다.
    • 문제가 발생해도 명확하게 파악하기 쉽다.
  • 기술지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할떄 주로 사용된다. 데이터베이스 연결, 공통로그 처리 등 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들
    • 업무 로직에 비해 수가 적고 광범위하게 영향을 미친다.
    • 문제가 명확하게 나오지 않아 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋다.

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

업무로직에서의 수동 빈 등록

  • 다향성을 적극 활용할때 별도의 설정 정보로 만들고 수동으로 등록하면 코드만 봐도 쉽게 파악할 수 있다.
    • 자동으로 설정시 특정 패키지에 같이 묶어 두는 것이 좋다.

정리

  • 편리한 자동기능을 기본으로 사용하는게 좋다.
  • 직접 등록하는 기술 지원 객체는 수동 등록하는게 좋다.
  • 다향성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민한다.

댓글남기기