Spring @Required Annotation

*@ Required* 注釈はBeanプロパティのセッターメソッドに適用され、影響を受けるBeanプロパティを構成時にXML構成ファイルに入力する必要があることを示します。 そうでない場合、コンテナはBeanInitializationException例外をスローします。 以下は、@ Requiredアノテーションの使用方法を示す例です。

例

動作するEclipse IDEを用意し、次の手順を実行してSpringアプリケーションを作成します。

Steps	Description
1	Create a project with a name SpringExample and create a package com.finddevguides under the src folder in the created project.
2	Add required Spring libraries using Add External JARs option as explained in the Spring Hello World Example chapter.
3	Create Java classes Student and MainApp under the com.finddevguides package.
4	Create Beans configuration file Beans.xml under the* src* folder.
5	The final step is to create the content of all the Java files and Bean Configuration file and run the application as explained below.

これが Student.java ファイルの内容です-

package com.finddevguides;

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.finddevguides;

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.finddevguides.Student">
      <property name = "name" value = "Zara"/>

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

</beans>

ソースおよびBean構成ファイルの作成が完了したら、アプリケーションを実行しましょう。すべてがアプリケーションで問題ない場合、_BeanInitializationException_例外が発生し、他のログメッセージとともに次のエラーが出力されます-

Property 'age' is required for bean 'student'

次に、次のように「年齢」プロパティからコメントを削除した後、上記の例を試すことができます-

<?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.finddevguides.Student">
      <property name = "name" value = "Zara"/>
      <property name = "age"  value = "11"/>
   </bean>

</beans>

上記の例では、次の結果が生成されます-

Name : Zara
Age : 11

Spring-required-annotation

Spring @Required Annotation

例