php 框架注解,注解 - [ Spring中文手册 ] - 在线原生手册 - php中文网

25.3.1. @Required

org.springframework.beans.factory.annotation包

中的@Required注解能用来标记

属性，将其标示为'需要设置'(例如，一个类中的被注解的(setter)

方法必须配置一个用来依赖注入的值)，否则容器会在运行时抛出一个Exception。

演示这个注解用法的最好办法是给出像下面这样的范例：

public class SimpleMovieLister {

// the SimpleMovieLister has a dependency on the MovieFinder

private MovieFinder movieFinder;

// a setter method so that the Spring container can 'inject' a MovieFinder

@Required

public void setMovieFinder(MovieFinder movieFinder) {

this.movieFinder = movieFinder;

}

// business logic that actually 'uses' the injected MovieFinder is omitted...

}

希望上面的类定义看起来还算简单。你必须为所有SimpleMovieLister类的BeanDefinitions

提供一个值。

让我们看一个不能通过验证的XML配置范例。

运行时Spring容器会生成下面的消息(追踪堆栈的剩下部分被删除了)。

Exception in thread "main" java.lang.IllegalArgumentException:

Property 'movieFinder' is required for bean 'movieLister'.

最后还需要一点(小的)Spring配置来'开启'这个行为。

简单注解类的'setter'属性不足以实现这个行为。

你还需要一个了解@Required注解并能适当地处理它的组件。

这个组件就是RequiredAnnotationBeanPostProcessor类。

这是一个由特殊的BeanPostProcessor实现，

能感知@Required并提供'要求属性未被设置时提示'的逻辑。

它很容易配置；只要简单地把下列bean定义放入你的Spring XML配置中。

最后，你还能配置一个RequiredAnnotationBeanPostProcessor类的实例来查找

其他Annotation类型。

如果你有自己的@Required风格的注解这会是件很棒的事。

简单地把它插入一个RequiredAnnotationBeanPostProcessor的定义中就可以了。

看个例子，让我们假设你(或你的组织/团队)已经定义了一个叫做@Mandatory的属性。

你能用如下方法让一个RequiredAnnotationBeanPostProcessor实例感知@Mandatory：

这是@Mandatory注解的源代码。

请确保你的自定义注解类型本身针对目标(target)和运行时保持策略(runtime retention policy)使用了合适的注解。

package your.company.package;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface Mandatory {

}