[014-1] Spring @Required Annotation

Spring @Required Annotation

(원문 위치 : http://www.tutorialspoint.com/spring/spring_required_annotation.htm )

@Required annotation은 bean의 setter함수 속성(property)에 적용되고 설정시 XML설정파일에서 영향을 받는 bean속성이 반드시 있어야 함을 나타낸다. 만약 존재하지 않으면 container는 BeanInitializationException을 발생시킨다. 아래는 @Required annotation의 예제이다.

Example:

[003] HelloWorld Example 강좌를 참조하여 프로젝트를 생성한다.

Student.java: setAge()와 setName()에 @Required annotation이 있음을 알 수 있다.

package com.tutorialspoint;

import org.springframework.beans.factory.annotation.Required;

public class Student {
   private Integer age;
   private String name;

   @Required
   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      return age;
   }

   @Required
   public void setName(String name) {
      this.name = name;
   }
   public String getName() {
      return name;
   }
}

MainApp.java: 이전 예제들과 큰 차이는 없다.

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");

      Student student = (Student) context.getBean("student");

      System.out.println("Name : " + student.getName() );
      System.out.println("Age : " + student.getAge() );
   }
}

Beans.xml:

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.0.xsd">

   <context:annotation-config/>

   <!-- Definition for student bean -->
   <bean id="student" class="com.tutorialspoint.Student">
      <property name="name"  value="Zara" />

      <!-- try without passing age and check the result -->
      <!-- property name="age"  value="11"-->
   </bean>

</beans>

위의 Beans.xml로 실행하면 'BeanInitializationException'이 발생하며 아래와 같은 메시지가 출력된다.

Property 'age' is required for bean 'student'

아래와 같이 'age' 속성의 주석을 제거하고 실행해 보자

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.0.xsd">

   <context:annotation-config/>

   <!-- Definition for student bean -->
   <bean id="student" class="com.tutorialspoint.Student">
      <property name="name"  value="Zara" />
      <property name="age"  value="11"/>
   </bean>

</beans>

실행 결과는 아래와 같다.

Name : Zara
Age : 11

--> 어? 이전 예제들 중에서 그냥 property를 사용하는 것과 어떤 차이가 있지? 라는 기특한 생각이 들 수 있을 것이다. 딱 보기엔 @Required annotation만 차이가 있고 나머진 큰 차이가 없다.

중요한 차이점은...@Required annotation을 사용한 녀석에 대한 속성(property)가 정의되지 않으면 바로 에러가 발생한다는 것이다. 즉 필수값의 개념으로 봐도 무방할 것이다.