어노테이션을 이용한 DI (@Autowired, @Qualifier)

이전 포스팅에서 빈의 생성과 주입에 관련한 부분을 소스 코드 외부인 xml으로 빼놓은 과정을 살펴보았다. 소스에 수정사항이 있을 때 소스 자체를 수정하지 않아도 되고 xml의 설정 부분만 수정하면 된다는 이점이 있었다.

예를 들어, B2라는 소스 코드가 B3으로 바뀌어야 된다는 상황을 가정해 보자.

<bean id="b" class="data.B2"/>

xml에 다음과 같은 빈 생성 코드가 있었을 때, B2를 B3로 수정하면 되는 것이다.

(수정 후) <bean id="b" class="data.B3"/>

하지만 이 과정 역시 번거로움이 있었고, 코드에 아예 메타 데이터를 설정하는 방법을 고안하게 되었다. 설정 파일을 바꿀 필요가 없이, @Componect가 붙은 객체 자체를 바꿔버리는 것이다. => 어노테이션

=> 설정 파일을 밖으로 빼놓는 xml 방식에서, 설정을 아예 코드에 심어놓는 어노테이션 방식으로 트렌드가 변화하였다.

 

xml을 통한 DI 예제를 어노테이션을 이용한 DI로 바꾸는 과정을 진행해 보겠다. xml 설정 부분을 줄이고 자바 코드 자체에 설정을 박아버리는 것이기 때문에, xml과 자바 코드 모두 수정해야 한다.

 

setting.xml

<!--namespace에서 context 체크 -->
<context:annotation-config/>

<bean id="console" class="spring.di.ui.GridExamConsole">
	<!-- <property name="exam" ref="exam"></property> -->
</bean>

 

세터 함수를 통해 부품을 조립하는 propery 태그를 주석처리 하였다. 의존성 주입이 되지 않은 상태이므로 이대로 실행하면 널 포인터 에러가 발생한다. xml을 통한 세터 함수를 없앤 것이기 때문에 값이 세팅되지 않은 채로 비어있는 껍데기 객체만 생성된다. 값을 세팅하기 위해 세터 함수가 실제로 쓰인 부분에 직접 설정을 해주도록 하겠다.

 

또한 주목해야 할 것은 <context:annotation-config/>라는 태그이다. 이는 스프링에게 xml을 통해 빈을 생성하면서 설정 파일에서 빠진 부분이 있으면 @Autowired를 읽어서 세팅하라고 알려주는 부분이다. 이 태그가 없으면 @Autowired가 제 기능을 할 수 없으므로 반드시 붙여야 한다.

 

즉, context 태그를 통해 Autowired로 세팅하는 객체가 있으니 확인해보라는 지시를 하는 것이다. 

(생성된 객체의 속을 들여보아라, 라는 지시)

 

 

GridExamConsole.java

@Autowired
@Override
public void setExam(Exam exam) {
	this.exam = exam;
}

 

setExam이라는 세터 함수에 @Autowired 어노테이션을 붙인다. 이렇게 하면 스프링이 xml을 통해 console이라는 이름의 빈을 생성하면서 @Autowired가 붙은 객체가 있는지 찾아보고, 있으면 그에 맞게 자동으로 세팅을 해주는 것이다. 이렇게 세팅한 후 실행을 하면 기존에 xml에서 property를 통해 세터 주입을 한 것과 마찬가지로 빈이 생성되고 주입된다.

 

그렇다면 @Autowired를 찾아보는 기준이 무엇일까? Exam이라는 객체를 기준으로 찾는 것일까, 아니면 exam이라는 객체의 이름을 기준으로 찾는 것일까? 

 

스프링은 우선 자료형을 기준으로 @Autowired를 찾아보는데, 이 경우 Exam이라는 객체를 기준으로 찾는다는 뜻이다. 예제를 통해 조금 더 살펴보도록 하겠다.

 

 

Program.java

ExamConsole console = (ExamConsole) context.getBean("console");

 

확실히 하기 위해서 ExamConsole.class 방식으로 객체를 꺼내지 않고 생성한 빈의 이름으로 꺼낸다.

 

setting.xml

<context:annotation-config/>
	<bean id="exam1" class="spring.di.entity.NewlecExam" p:kor="1" p:eng="1" />

 

빈의 이름을 exam이 아닌 exam1으로 바꾸어서 실행했을 때 문제 없이 실행된다. 즉, 스프링은 빈의 이름이 아니라 자료형인 객체 타입으로 @Autowired를 찾아서 값을 세팅한다. 그렇기 때문에 심지어 이름이 없어도(id="exam1" 부분을 삭제해도) 정상적으로 실행된다. 이름과는 관련없이 객체 타입을 통해 세팅하기 때문이다.

 

그렇다면 같은 객체를 여러개 생성한다면 어떤 일이 일어날까?

 

setting.xml

<context:annotation-config/>
	<bean class="spring.di.entity.NewlecExam" p:kor="1" p:eng="1" />
	<bean class="spring.di.entity.NewlecExam" p:kor="2" p:eng="2" />

 

이 경우 스프링이 두 개의 객체를 찾았기 때문에 세팅할 수 없다는 에러가 발생한다. 따라서 이런 경우에는 이름을 지정해 주어야 한다. 다음과 같이 수정한 후 실행을 해본다.

 

setting.xml

<context:annotation-config/>
	<bean id="exam" class="spring.di.entity.NewlecExam" p:kor="1" p:eng="1" />
	<bean class="spring.di.entity.NewlecExam" p:kor="2" p:eng="2" />

 

에러없이 정상적으로 실행되며, 이름을 exam으로 지정한 빈대로 kor="1", eng="1" 값을 세팅하게 된다.

 

=> 스프링은 우선 자료형 타입(객체 타입)으로 @Autowired를 검색하고, 같은 객체를 두 개 이상 생성했을 때는 지정한 이름을 기준으로 @Autowired를 검색하여 세팅한다.

 

<context:annotation-config/>
	<bean id="exam1" class="spring.di.entity.NewlecExam" p:kor="1" p:eng="1" />
	<bean class="spring.di.entity.NewlecExam" p:kor="2" p:eng="2" />

 

만약 이처럼 bean id="exam"이 아니라 bean id="exam1"이었다면 찾을 수 없기 때문에 에러가 발생한다.

 

마지막으로 다음과 같은 경우를 살펴보도록 하겠다. 두 개의 빈의 이름이 각각 파라미터의 이름인 exam과는 다른 이름으로 지정된 경우이다.

 

<context:annotation-config/>
	<bean id="exam1" class="spring.di.entity.NewlecExam" p:kor="1" p:eng="1" />
	<bean id="exam2" class="spring.di.entity.NewlecExam" p:kor="2" p:eng="2" />

 

이 경우 물론 바인딩이 안 되어 에러가 날 것이고, 이럴 경우에 정상적으로 빈을 찾아 세팅할 수 있게 해주는 것이 바로 @Qualifier이다. @Qualifier를 통해 생성한 빈의 이름을 찾아 그것에 맞게 @Autowired를 찾고, 세팅할 수 있다.

 

 

GridExamConsole.java

@Autowired
@Qualifier("exam1")
@Override
public void setExam(Exam exam) {
	this.exam = exam;
}

 

 

*@Autowired의 위치

 

지금까지는 세터 함수에 @Autowired를 붙여 객체에 값을 세팅해 주었다. 이외에도 @Autowired는 필드에 붙을 수도, 생성자에 붙을 수도 있다.

 

 

GridExamConsole.java

public class GridExamConsole implements ExamConsole {

	//1. @Autowired
	//@Qualifier("exam1")
	private Exam exam;
	
	public GridExamConsole() {
	}
	
	//2. @Autowired
	public GridExamConsole(@Qualifier("exam1") Exam exam) {
		this.exam = exam;
	}

	//3. @Autowired
	//@Qualifier("exam1")
	@Override
	public void setExam(Exam exam) {
		this.exam = exam;
	}
}

 

1. 필드에 붙은 경우

기본 생성자를 통해 빈을 세팅한다. 그렇기 때문에 기본 생성자가 없고 오버로드 된 생성자만 있는 경우에는 에러가 발생한다. 기본 생성자, 오버로드 된 생성자 모두 없는 경우에는 빈 생성시 자동으로 기본 생성자가 생성되기 때문에 에러가 발생하지 않는다.

 

2. 오버로드 된 생성자에 붙은 경우

생성자에 @Qualifier를 붙이면 기준이 모호하기 때문에 빨간줄이 뜬다. 매개변수에 직접 @Qualifier를 붙여야 하며, 여러 개에 각자 붙이는 것도 가능하다.

(public GridExamConsole(@Qualifier("exam1") Exam exam1, @Qualifier("exam2") Exam exam2))

 

3. 세터 함수에 붙은 경우

기본 생성자를 통해 빈을 생성한 후, 세터 함수로 값을 세팅한다.

 

일반적으로는 필드에 @Autowired를 붙이는 방법을 가장 많이 사용한다.

 

 

 

* required 옵션

 

GridExamConsole.java

public class GridExamConsole implements ExamConsole {

	@Autowired
	@Qualifier("exam1")
	private Exam exam;
	
	public GridExamConsole() {
	}
	
	public GridExamConsole(Exam exam) {
		this.exam = exam;
	}

	@Override
	public void setExam(Exam exam) {
		this.exam = exam;
	}
}

 

가장 일반적인 방법인 필드에 @Autowired를 붙이는 상황으로 예를 들어보겠다. @Qualifier를 붙여 exam1이라는 이름으로 생성된 빈을 찾아 세팅하는 코드이다. 그러나 setting.xml에 exam1이라는 이름으로 빈을 생성하지 않는 상황을 생각해보자. 이 경우 실행하는 즉시 에러가 발생한다. exam1이라는 빈을 생성하지 않아서 없는 상태에서, @Autowired 태그를 통해 빈을 세팅하라고 하니 에러가 발생할 수 밖에 없다. 없는 것을 찾으라고 하니 에러가 발생하는 것이다. 하지만 어떠한 이유로든, 빈이 생성되지 않아도 프로그램이 정상적으로 실행되어야 하는 상황이 있을 것이다. 가령, exam이 null이라면 "null입니다"라고 출력해야 하는 상황을 상상해보자. 이런 상황에서 사용할 수 있는 것이 바로 required 옵션이다.

 

위 코드를 아래처럼 수정해보도록 한다.

 

GridExamConsole.java

public class GridExamConsole implements ExamConsole {

	@Autowired(required = false)
	@Qualifier("exam1")
	private Exam exam;
	
	public GridExamConsole() {
	}
	
	public GridExamConsole(Exam exam) {
		this.exam = exam;
	}

	@Override
	public void setExam(Exam exam) {
		this.exam = exam;
	}
}

 

@Autowired(required = false) 옵션을 사용함으로써 빈이 없는 상태여도 프로그램이 진행되게 할 수 있다.

 

 

---

뉴렉처 스프링 프레임워크 강의를 듣고 정리한 게시글입니다.

www.youtube.com/user/newlec1