다양한 의존관계 주입 방법
의존관계 주입은 크게 4가지 방법이 있다.
- 생성자 주입
- 수정자 주입(setter 주입)
- 필드 주입
- 일반 메서드 주입
생성자 주입
- 이름 그대로 생성자를 통해서 의존관계를 주입 받는 방법이다.
- 지금까지 우리가 진행했던 방법이 바로 생성자 주입이다.
- 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.(setter가 없으니까)
- 불변, 필수 의존관계에서 사용
@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;
}
**중요! 생성자가 딱 1개만 있으면, @Autowired를 생략해도 자동 주입된다.** --> 물론 스프링 빈에만 해당한다.
수정자 주입(setter 주입)
- setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관게를 주입하는 방법이다.
- 특징
- 선택, 변경 가능성이 있는 의존관계에 사용
- 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
@Component
public class OrderServiceImpl implements OrderService{
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void setMemberRepository(MemberRepository memberRepository) {
System.out.println("memberRepository = " + memberRepository);
this.memberRepository = memberRepository;
}
@Autowired
public void setDiscountPolicy(DiscountPolicy discountPolicy) {
System.out.println("discountPolicy = " + discountPolicy);
this.discountPolicy = discountPolicy;
}참고 : @Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 된다.
참고 : 자바빈 프로퍼티, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다. 더 자세한 내용이 궁금하면 자바빈 프로퍼티로 검색해보자.
-- 자바빈 프로퍼티 규약 예시--
class Data{
private int age;
public void setAge(int age) {
this.age = age;
}
public int getAge() {
return age;
}
}
필드 주입
- 이름 그대로 필드에 바로 주입하는 방법이다.
- 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트하기 힘들다는 단점이 있다.
- DI 프레임워크가 없으면 아무것도 할 수 없다.
- 사용하지 말자
@Component
public class OrderServiceImpl implements OrderService{
@Autowired private MemberRepository memberRepository;
@Autowired private DiscountPolicy discountPolicy;만약 이 상테에서 테스트코드를 스프링을 사용하지 않고 돌린다고 가정하자.
@Test
void fieldInjection(){
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}테스트 코드는 위와 같다. 새로운 orderservice를 만들고 createorder를 하였으나
@Override
public Order createOrder(Long memberId, String itemName, int itemPrice) {
Member member = memberRepository.findById(memberId);
int discountPrice = discountPolicy.discount(member, itemPrice);
return new Order(memberId, itemName, itemPrice, discountPrice);
}createOrder는 memberRepository를 필요로 한다. 따라서 nullpointException이 터지게 된다.
이 문제를 해결하기 위해서는 결국 setter를 열어서 해결해야 한다.
@Component
public class OrderServiceImpl implements OrderService {
@Autowired private MemberRepository memberRepository;
@Autowired private DiscountPolicy discountPolicy;
public void setMemberRepository(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
public void setDiscountPolicy(DiscountPolicy discountPolicy) {
this.discountPolicy = discountPolicy;
}
위에서 연 set을 통해
@Test
void fieldInjection(){
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.setMemberRepository(new MemoryMemberRepository());
orderService.setDiscountPolicy(new FixDiscountPolicy());
orderService.createOrder(1L, "itemA", 10000);
}이처럼 다시 테스트를 실행할 수 있다.(이것도 member가 없어서 null 에러가 터지긴 하지만)
이런 식으로 필드주입을 하게 된다면 set도 열어서 테스트 해야하고 변경이 아예 불가능 하기 때문에 권장되지 않는 방법이다.
다음과 같은 상황에서는 사용해도 괜찮다.
- 애플리케이션의 실제 코드와 관계 없는 테스트 코드
- 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
일반 메서드 주입
- 일반 메서드를 통해서 주입 받을 수 있다.
- 한번에 여러 필드를 주입 받을 수 있다.
- 일반적으로 잘 사용하지 않는다.
@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 {
@Test
void AutowiredOption() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}
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);
}
}
}실행 결과는 다음과 같다.
noBean2 = null
noBean3 = Optional.empty
- Member는 스프링 빈이 아니다.
- setNoBean1은 @Autowired(required=false)이므로 호출 자체가 안된다.
-- 참고 : @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어 생성자 자동주입에서 특정 필드에만 사용해도 된다.
생성자 주입을 선택해라.
과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유는 다음과 같다.
*불변*
- 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)
- 수정자 주입을 사용하면, setXxx메서드를 public으로 열어두어야 한다. -> 바꿀 여지가 있음
- 누군가 실수로 변경할 수도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
- 생성자 주입은 객체를 생성할 때 딱 한번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.
*누락*
프레임워크 없이 순수한 자바 코드를 단위 테스트에 하는 경우에
다음과 같이 수정자 의존관계인 경우(setter로 주입시)
@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;
}테스트 코드를 만들면 문제가 발생한다.
@Test
void createOrder(){
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}orderService.createOrder에는 memberRespository뿐만 아니라 discountPolicy까지 필요한데 이거에 관련한 컴파일 에러를 띄워주지 못하고 nullPointException의 에러가 도출되기 때문이다.
이 문제를 생성자 주입을 통한다면 컴파일시점부터 에러가 발생한다고 알려줄 것이다.
그럼 그 문제를 아래와 같은 코드로 수정할 수 있다.
@Test
void createOrder(){
MemoryMemberRepository memberRepository = new MemoryMemberRepository();
memberRepository.save(new Member(1L, "name", Grade.VIP));
OrderServiceImpl orderService = new OrderServiceImpl(memberRepository, new FixDiscountPolicy());
Order order = orderService.createOrder(1L, "itemA", 10000);
Assertions.assertThat(order.getDiscountPrice()).isEqualTo(1000);
}
*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;
}final 설정을 해주면 memberRepository와 discountPolicy의 값의 누락을 컴파일 시점에서 오류를 잡을 수 있다.
--> 컴파일 오류는 눈에 보이는 쉬운 오류이므로 개발자 입장에서 수정하기 좋은 오류이다.
*참고 : 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 'final' 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 'final' 키워드를 사용할 수 있다.
정리
- 생성자 주입 방식을 선택하는 이유는, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다.
- 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여한다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
- 항상 생성자 주입을 선택하자. 그리고 가끔 옵션이 필요하다면 수정자 주입을 사용하자. 필드 주입은 사용하지 않는게 좋다.
롬복과 최신 트렌드
막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 생성자에 final 키워드를 사용하게 된다.
그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고, 필드 주입처럼 편리하게 사용하는 방법은 없을까?
이 부분을 lombok이라는 라이브러리를 사용해서 좀 더 편리하게 개발해보자.
우선 build.gradel에 lombok 설정을 해주어야 한다.
group = 'hello'
version = '0.0.1-SNAPSHOT'
//lombok 설정 추가 시작
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
//lombok 설정 추가 끝
configuration annotationProcessor를 추가해준다.
그리고 dependencies에 lompok 라이브러리를 추가하여준다.
dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
//lombok 라이브러리 추가 시작
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
//lombok 라이브러리 추가 끝
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}
스프링 버전마다 세부 사양은 다를 수 있다 설정 추가 부분만 복사하여 설정한다.
그리고 file > settings > plugins에 lombok을 설치하여준다.
마지막으로 file > settings > annotation Processors의 Enable annotation processing을 꼭 설정하여준다.
예제 파일을 하나 만들어서 롬복을 테스트 해보자.
@Getter
@Setter
@ToString
public class HelloLombok {
private String name;
private int age;
public static void main(String[] args) {
HelloLombok helloLombok = new HelloLombok();
helloLombok.setName("lombok");
String name = helloLombok.getName();
System.out.println("name = " + name);
System.out.println("helloLombok = " + helloLombok);
}
}name = lombok
helloLombok = HelloLombok(name=lombok, age=0)
어노테이션을 붙혔을 뿐인데 롬복에서 getter, setter, toString 메서드를 만들어주었다.
참 신기한 친구다.
롬복은 여러가지 기능을 지원해준다. 세부 스펙은 롬복에 관련하여 따로 검색을 해보자.
롬복은 생성자를 만들어주는 기능 또한 지원하는데 @RequiredArgsConstructor를 붙히면 생성자를 만들어준다. 따라서 OrderServiceImpl에 적용을 시켜보면
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
생성자를 따로 만들지 않았음에도
OrderServiceImpl(MemberRepository, DiscountPolicy)의 생성자가 만들어진 것을 볼 수 있다.
--> 현재 내 객체의 필수값인 final이 붙은 것을 가지고 생성자를 만들어준다.
- 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다. (코드에는 보이지 않지만 실제 호출이 가능하다.)
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
이 최종결과 코드와 이전의 @Autowired가 붙어있는 생성자 코드는 완전히 동일하다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다. 실제'class'를 열어보면 다음 코드가 추가되어 있는 것을 확인할 수 있다.
*정리 : 최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor를 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.
조회 빈이 2개 이상 - 문제
@Autowired는 타입(Type)으로 조회한다.
ex) @Autowired
private DiscountPolicy discountPolicy
타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다.(실제로는 더 많은 기능을 제공한다.)
'ac.getBean(DiscountPolicy.class)'
스프링 빈 조회해서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상힐 때 문제가 발생한다.
DiscountPolicy의 하위 타입인 'FixDiscountPolicy', 'RateDiscountPolicy' 둘 다 스프링 빈으로 선언해보자.
Fix, Rate 둘 다 @Component로 지정을 한다면
No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
다음과 같은 에러가 발생한다.
single bean 하나가 매칭되길 기대했는데 빈이 두개가 발견된 것이다.
이때 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.
(하위타입 -> DiscountPolicy가 아닌 Rate or Fix로 직접 지정하는 것)
그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을때는 해결이 안된다.
스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.
해결 방법은 아래와 같다.
@Autowired 필드명, @Qualifier, @Primary
조회 대방 빈이 2개 이상일 때 해결 방법
1. @Autowired 필드 명 매칭
2. @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
3. @Primary 사용
@Autowired 필드 명 매칭
@Autowired는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = rateDiscountPolicy;
}생성자에 주입할때 매개변수 명을 rateDiscountPolicy로 정하였기 때문에 DiscountPolicy 빈 중 fix가 아닌 rateDiscountPolicy가 매칭된다.
@Autowired 매칭 정리
1. 타입 매칭
2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭
@Qualifier 사용
@Qualifier는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지, 빈 이름을 변경하는 것이 아니다.
*빈 등록 시 @Qualifier를 붙여준다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy{@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy{이 Qualifier를 통해 구분한다.
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}Qualifier의 이름이 mainDiscountPolicy인 것은 rateDiscountPolicy이므로 rateDiscountPolicy가 적용된다.
만약 @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.
다음과 같이 직접 빈 등록시에도 @Qualifier를 동일하게 사용할 수 있다.
@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy(){
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
@Qualifier 정리
1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. 'NoSuchBeanDefinitionException' 예외 발생
@Primary 사용
@Primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈 매칭되면 @Primary가 우선권을 가진다.
'rateDiscountPolicy'가 우선권을 가지도록 하려면 다음과 같이 정의하면 된다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{@Component
public class FixDiscountPolicy implements DiscountPolicy{RateDiscountPolicy에 @Primary 어노테이션이 붙어 있으면, 우선순위를 가진다.
여기까지 보면 @Primary와 @Qualifier중 어떤 것을 사용하면 좋을지 고민이 될 것이다. @Qualifier의 단점은 주입 받을 때 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다.
반면 @Primary를 사용하면 @Qualifer를 붙일 필요가 없다.
*@Primary, @Qualifier 활용*
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자. 메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할때는 @Qualifier를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 데이터베이스의 스프링 빈을 등록할 때 @Qualifier를 지정해주는 것은 상관 없다
*우선순위*
@Primary는 기본값처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier가 우선권이 높다.
애노테이션 직접 만들기
@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있다. ---> "mainDiscountPolicy" 부분이 문자이기 때문에 컴파일타임에 체크가 안된다.
@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{
private int discountPercent = 10;
@Override
public int discount(Member member, int price) {
if (member.getGrade() == Grade.VIP) {
return price * discountPercent / 100;
}
return 0;
}
}
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,@MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}이 문제를 해결하기 위해 MainDiscountPolicy라는 어노테이션을 직접 만들어서 컴파일 에러를 유도하도록 만들 수 있다.
애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. @Qualifier뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired또한 재정의 할 수 있다.
--> 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의하는 것은 유지보수에 더 혼란만 가중시킬 수 있으니 주의하자.
조회한 빈이 모두 필요할 때, List, Map
의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자. 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.
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");
assertThat(discountService).isInstanceOf(DiscountService.class);
assertThat(discountPrice).isEqualTo(1000);
int rateDiscountPolicy = discountService.discount(member, 20000, "rateDiscountPolicy");
assertThat(rateDiscountPolicy).isEqualTo(2000);
}
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;
System.out.println("policyMap = " + policyMap);
System.out.println("policies = " + policies);
}
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}
}
자동, 수동의 올바른 실무 운영 기준
편리한 자동 기능을 기본으로 사용하자.
그러면 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?
결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세이다. 스프링은 @Component뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일히 적어주는 과정은 상당히 번거롭다.
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
그리고 결정적으로 자동 빈 등록을 사용해도 OCP,DIP를 지킬 수 있다.
"그러면 수동 빈 등록은 언제 사용하면 좋을까?"
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
- 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
- 기술지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 떄 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
- 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
- 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.
"애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다."
"비즈니스 로직 중에서 다형성을 적극 활용할 때"
의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 보자.
DiscountService가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입받는 상황을 생각해보자.
여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 없게 된다.
이런 경우 수동 빈으로 등록하거나 또는 자동으로 하면 "특정 패키지에 같이 묶어"두는게 좋다. 핵심은 딱 보고 이해가 되어야 한다.
참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외이다. 이런 부분들은 스프링 자체를 잘 이해하고, 스프링 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다. 반면 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.
*정리
- 편리한 자동 기능을 기본으로 사용하자
- 직접 등록하는 기술 지원 객체는 수동 등록
- 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자
'공부 > Spring' 카테고리의 다른 글
| 빈 스코프 (0) | 2024.11.08 |
|---|---|
| bean 생명주기 콜백 (0) | 2024.11.06 |
| 컴포넌트 스캔 (1) | 2024.10.31 |
| 싱글톤 컨테이너 (0) | 2024.10.30 |
| 스프링 컨테이너와 스프링 빈 (1) | 2024.10.27 |