의존관계 자동 주입 (Autowired)

최주영·2024년 3월 19일
0

스프링 핵심 원리

목록 보기
8/9
post-custom-banner

총 4가지가 존재
Autowired
생성자 주입, setter주입, 필드 주입, 일반 메서드 주입

✅ 생성자 주입

  • 생성자 호출 시점에 딱 1번만 호출되는 것이 보장
  • 불변, 필수 관계에서 사용
  • 불변 : 어플리케이션 종료 전까지 변하면 안됨

💡 정리
setter 주입을 사용하면, set 메소드를 public으로 열어두어야 한다
누군가가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는것은 좋을 설계 방법이 아니다
생성자 주입을 하면 객체를 생성할 때, 딱 1번만 호출되므로 이후에 호출되는 일이 없다
즉 생성자 주입은 불변 하게 설계할 수 있다

웬만하면 항상 생성자 주입을 사용하자

추가로 밑에 코드와 같이
생성자 주입을 사용하면 final 키워드를 사용할 수 있다
(생성자 주입만 사용 가능) -> 나머지 주입 방법들은 생성자 이후에 호출되기 때문에 사용 x
생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에서 막아준다

ex) 다음과 같은 예시로 final로 설정한 필수 필드인 discountPolicy에 값을 설정해야 하는데
누락이 되어서 -> 이부분은 컴파일 시점에서 다음 오류를 발생시킨다

  • java: variable discountPolicy might not have been initialized
  • 개발자 입장에서는 컴파일 오류가 빠르게 해결할 수 있는 좋은 오류다
 @Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

생성자 주입 예시
@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired // 생성자가 1개만 존재한다면 @Autowired 생략 가능  
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) { 
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

✅ setter(수정자)주입

  • setter라고 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계 주입하는 방법
  • 선택, 변경 관계에서 사용
  • 선택 -> @Autowired(required = false or true)
@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;
    }
}

✅ 필드 주입

  • 코드가 간결하지만, 외부에서 변경이 불가능해서 테스트 하기 힘듬
  • DI 프레임워크가 없으면 아무것도 할 수 없음 -> 사용하지 않기
  • 굳이 쓴다면 테스트 코드에서 쓸 때 있음
@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private MemberRepository memberRepository;
    @Autowired
    private 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;
    }
}

✅ Autowired 옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.

그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true로 되어 있어서
자동 주입 대상이 없으면 오류가 발생한다.

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

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

우선 코드를 보기 전 Member 은 스프링 빈이 아니다
그러므로 Member 객체를 읽을 수 없다

//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
    System.out.println("setNoBean1 = " + member);
}

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

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

✅ 롬복

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 필드에 final 키워드를 사용하게 된다.
그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고 불편한점이 많다

하지만 롬복을 사용하면 그 귀찮은 문제점들이 바로 해결된다

✅ 롬복의 기능

여기서 @RequiredArgsConstructor 기능을 사용하면
final 이 붙은 필드를 모아서 생성자를 자동으로 만들어준다 (코드로는 보이지 않음)
즉 다음 코드와 같이 주석 친 매개변수 있는 생성자를 생략해도 알아서 만들어준다

@Component
@RequiredArgsConstructor
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;
        }*/
}

✅ 조회 대상 빈이 2개이상일 때 해결 방법

  1. @Autowired 필드 명 매칭
  2. Qualifier -> Qualifier 끼리 매칭
  3. @Primary 사용

@Autowired 필드 명 매칭

  • 타입 매칭의 결과가 2개 이상일 때 필드명, 파라미터 명으로 빈 이름 매칭
// 기존 코드  
@Autowired
private DiscountPolicy discountPolicy
// 필드명을 빈 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy

Qualifier -> Qualifier 끼리 매칭
1. 추가 구분자를 붙여주는 방법
2. @Qualifier 끼리 매칭
3. @Qualifier 로 주입할 때 못찾으면 빈 이름으로 찾음
4. 빈 이름으로도 못찾으면 NoSuchBeanDefinitionException 예외 발생

ex)
빈 등록시 @Qualifier 붙여줌

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

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

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

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

@Primary 사용

  • 우선순위를 정하는 방법으로 여러 빈이 매칭되면 @Primary 가 우선권을 가짐
  • 만약 비율이이닌 정률의 할인 방법으로 변경하고 싶다면 다음 코드처럼 어노테이션을 붙이자
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}
//생성자
@Autowired 
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
// discountPolicy 타입은 RateDiscountPolicy 로 매칭된다
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

실무에서는 @Qualifier 보다 @Primary 를 더 많이 사용하며
두개 중 @Qualifier 이 더 상세하게 동작하기 때문에 우선권이 더 높다


✅ 에노테이션 직접 만들기

꼭 에노테이션 양식으로 생성

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

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

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

그러면 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세다. 스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

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

업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

profile
우측 상단 햇님모양 클릭하셔서 무조건 야간모드로 봐주세요!!
post-custom-banner

0개의 댓글