Spring有很多自定义的(Java5+)注解。
org.springframework.beans.factory.annotation
包
中的@Required
注解能用来标记
属性,标示为'需要设置'(例如,一个类中的被注解的(setter)
方法必须配置一个用来依赖注入的值),否则一个Exception
必须(并且将会)在运行时被容器抛出。
演示这个注解用法的最好办法是给出像下面这样的范例:
public class SimpleMovieLister { // theSimpleMovieLister
has a dependency on theMovieFinder
private MovieFinder movieFinder; // a setter method so that the Spring container can 'inject' aMovieFinder
@Required public void setMovieFinder(MovieFinder movieFinder) { this.movieFinder = movieFinder; } // business logic that actually 'uses' the injectedMovieFinder
is omitted... }
还好上面的类定义看起来比较简单。基本上(在Spring IoC容器的上下文中),
所有针对SimpleMovieLister
类的BeanDefinitions
一定要提供一个值(用Spring API的话来讲就是那个属性一定要设置一个PropertyValue
)。
让我们看一个不能通过验证的XML配置范例。
<bean id="movieLister" class="x.y.SimpleMovieLister">
<!-- whoops, no MovieFinder is set (and this property is @Required
) -->
</bean>
运行时Spring容器会生成下面的消息(追踪堆栈的剩下部分被删除了)。
Exception in thread "main" java.lang.IllegalArgumentException: Property 'movieFinder' is required for bean 'movieLister'.
现在先停一下……还有最后一点(小的)Spring配置需要用来'开启'这个行为。
简单注解一下你类的'setter'属性不足以实现这个行为。
你还需要能发现@Required
注解并能适当地处理它的东西。
进入RequiredAnnotationBeanPostProcessor
类。
这是一个由Spring提供的特殊的BeanPostProcessor
实现,
@Required
-aware能提供'要求属性未被设置时提示'的逻辑。
它很容易配置;只要简单地把下列bean定义放入你的Spring XML配置中。
<bean class="org.springframework.beans.factory.annotation.RequiredAnnotationBeanPostProcessor"/>
最后,你能配置一个RequiredAnnotationBeanPostProcessor
类的实例
来查找另一个Annotation
类型。
如果你已经有自己的@Required
风格的注解这会是件很棒的事。
简单地把它插入一个RequiredAnnotationBeanPostProcessor
的定义中就可以了。
看个例子,让我们假设你(和你的组织/团队)已经定义了一个叫做@Mandatory
的属性。你能建一个如下的RequiredAnnotationBeanPostProcessor
实例
@Mandatory
-aware:
<bean class="org.springframework.beans.factory.annotation.RequiredAnnotationBeanPostProcessor"> <property name="requiredAnnotationType" value="your.company.package.Mandatory"/> </bean>
注解也被用于Spring中的其他地方。相比在这里说明,那些注解在他们各自的章节或与他们相关的章节中予以说明。