@Required

优质

小牛编辑

137浏览

2023-12-01

@Required注释适用于bean属性setter方法，它指示必须在配置时在XML配置文件中填充受影响的bean属性。否则，容器抛出BeanInitializationException异常。以下示例显示@Required注释的使用。

例子 (Example)

让我们有一个可用的Eclipse IDE，并按照以下步骤创建一个Spring应用程序 -

脚步	描述
1	创建一个名为SpringExample的项目，并在创建的项目中的src文件夹下创建一个包cn.xnip 。
2	使用Add External JARs选项添加所需的Spring库，如Spring Hello World Example章节中所述。
3	在cn.xnip包下创建Java类Student和MainApp 。
4	在src文件夹下创建Beans配置文件Beans.xml 。
5	最后一步是创建所有Java文件和Bean配置文件的内容并运行应用程序，如下所述。

这是Student.java文件的内容 -

package cn.xnip;
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 cn.xnip;
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 = "cn.xnip.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'

接下来，您可以在从'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 = "cn.xnip.Student">
      <property name = "name" value = "Zara" />
      <property name = "age"  value = "11"/>
   </bean>
</beans>

以上示例将产生以下结果 -

Name : Zara
Age : 11