Spring使用@Required註解依賴檢查

Spring依賴檢查 bean 組態檔案用於確定的特定型別(基本，集合或物件)的所有屬性被設定。在大多數情況下，你只需要確保特定屬性已經設定但不是所有屬性..

對於這種情況，你需要 @Required 註解，請參見下面的例子：

@Required範例

Customer物件，適用@Required在 setPerson()方法，以確保 person 屬性已設定。

package com.tw511.common;

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

public class Customer 
{
	private Person person;
	private int type;
	private String action;
	
	public Person getPerson() {
		return person;
	}
	@Required
	public void setPerson(Person person) {
		this.person = person;
	}
}

簡單地套用@Required註解不會強制執行該屬性的檢查，還需要註冊一個RequiredAnnotationBeanPostProcessor以了解在bean組態檔案@Required註解。

RequiredAnnotationBeanPostProcessor可以用兩種方式來啟用。

1. 包函 <context:annotation-config />

新增 Spring 上下文和 <context:annotation-config />在bean組態檔案。

<beans 
	...
	xmlns:context="http://www.springframework.org/schema/context"
	...
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context-2.5.xsd">
	...
	<context:annotation-config />
	...
</beans>

完整的範例,

<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-2.5.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context-2.5.xsd">

	<context:annotation-config />

	<bean id="CustomerBean" class="com.tw511.common.Customer">
		<property name="action" value="buy" />
		<property name="type" value="1" />
	</bean>

	<bean id="PersonBean" class="com.tw511.common.Person">
		<property name="name" value="yiibai" />
		<property name="address" value="address ABC" />
		<property name="age" value="29" />
	</bean>
	
</beans>

2. 包函 RequiredAnnotationBeanPostProcessor

直接在 bean 組態檔案包函「RequiredAnnotationBeanPostProcessor」。

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<bean 
class="org.springframework.beans.factory.annotation.RequiredAnnotationBeanPostProcessor"/>
	
	<bean id="CustomerBean" class="com.tw511.common.Customer">
		<property name="action" value="buy" />
		<property name="type" value="1" />
	</bean>

	<bean id="PersonBean" class="com.tw511.common.Person">
		<property name="name" value="yiibai" />
		<property name="address" value="address ABC" />
		<property name="age" value="29" />
	</bean>	
</beans>

如果你執行它，下面的錯誤資訊會丟的，因為 person 的屬性未設定。

org.springframework.beans.factory.BeanInitializationException: 
	Property 'person' is required for bean 'CustomerBean'

結論

嘗試@Required註解，它比依賴檢查XML檔案中更加靈活，因為它可以適用於只有一個特定屬性。

定義@Required
請閱讀本文有關如何建立新的自定義 @Required-style 註解。