在 Spring 2.1 中自定义注解配置和组件检测

工程 | Mark Fisher | 2007年5月29日 | ...

注意:此帖子已于 2007 年 5 月 31 日更新,以反映 2.1-M2 官方发布的状态

两周前我撰写博客介绍了 Spring 2.1 新的注解驱动依赖注入功能,并提到我将在“本周晚些时候”提供更多信息。事实证明这有点乐观,但好消息是此功能在此期间已经发展了很多。因此,要跟随这里的示例,您需要下载2.1-M2 官方版本(或者如果您是第一批阅读此更新条目且 M2 尚未发布的人,您应该至少获取 nightly build #115,您可以在此处下载)。

我想演示的第一件事是如何不使用任何 XML 创建应用程序上下文。对于那些使用过 Spring 的 BeanDefinitionReader 实现的人来说,这会非常熟悉。然而,在创建上下文之前,我们需要在类路径上准备一些“候选”bean。继续我之前博客中的示例,我有以下两个接口:


public interface GreetingService {
	String greet(String name);
}

public interface MessageRepository {
	String getMessage(String language);
}

……以及这些对应的实现


@Component
public class GreetingServiceImpl implements GreetingService {

	@Autowired
	private MessageRepository messageRepository;
	
	public String greet(String name) {
		Locale locale = Locale.getDefault();
		if (messageRepository == null) {
			return "Sorry, no messages";
		}
		String message = messageRepository.getMessage(locale.getDisplayLanguage());
		return message + " " + name;
	}
}

@Repository
public class StubMessageRepository implements MessageRepository {

	Map<String,String> messages = new HashMap<String,String>();
	
	@PostConstruct
	public void initialize() {
		messages.put("English", "Welcome");
		messages.put("Deutsch", "Willkommen");
	}
	
	public String getMessage(String language) {
		return messages.get(language);
	}
}

现在,如我所承诺的……我们将组装这个虽然不值一提但确实“不使用任何 XML”的“应用程序”


Locale.setDefault(Locale.GERMAN);
GenericApplicationContext context = new GenericApplicationContext();
ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(context);
scanner.scan("blog"); // the parameter is 'basePackage'
context.refresh();
GreetingService greetingService = (GreetingService) context.getBean("greetingServiceImpl");
String message = greetingService.greet("Standalone Beans");
System.out.println(message);

结果如下


Willkommen Standalone Beans

本质上,这与使用新“context”命名空间中的 component-scan XML 元素时的行为完全相同(如我在上一篇博客中演示的那样)。然而,我想重点介绍一些较新的功能以及自定义选项。首先,我将从 StubMessageRepository 中删除 @Repository 注解,然后重新运行测试,这将产生以下异常:


org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'greetingServiceImpl': Autowiring of fields failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private blog.MessageRepository blog.GreetingServiceImpl.messageRepository; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [blog.MessageRepository] is defined: expected single bean but found 0

显然,@Autowired 注解默认表示一个必需的依赖项,但可以通过添加值为 'false' 的 'required' 参数轻松切换,例如:


@Component
public class GreetingServiceImpl implements GreetingService {

	@Autowired(required=false)
	private MessageRepository messageRepository;
	...

修改后的结果


Sorry, no messages

为了让事情变得更有趣一些,我将添加 MessageRepository 的 JDBC 版本(同样来自上一篇文章):


@Repository
public class JdbcMessageRepository implements MessageRepository {

	private SimpleJdbcTemplate jdbcTemplate;

	@Autowired
	public void createTemplate(DataSource dataSource) {
		this.jdbcTemplate = new SimpleJdbcTemplate(dataSource);
	}
	
	@PostConstruct
	public void setUpDatabase() {
		jdbcTemplate.update("create table messages (language varchar(20), message varchar(100))");
		jdbcTemplate.update("insert into messages (language, message) values ('English', 'Welcome')");
		jdbcTemplate.update("insert into messages (language, message) values ('Deutsch', 'Willkommen')");
	}
	
	@PreDestroy
	public void tearDownDatabase() {
		jdbcTemplate.update("drop table messages");
	}
	
	public String getMessage(String language) {
		return jdbcTemplate.queryForObject("select message from messages where language = ?", String.class, language);
	}
}

只要 stub 版本仍然包含 @Repository 注解,重新运行测试现在将产生以下异常:


org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'greetingServiceImpl': Autowiring of fields failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private blog.MessageRepository blog.GreetingServiceImpl.messageRepository; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'jdbcMessageRepository': Autowiring of methods failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire method: public void blog.JdbcMessageRepository.createTemplate(javax.sql.DataSource); nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [javax.sql.DataSource] is defined: expected single bean but found 0

显然,由于上下文中没有可用的 DataSource,因此发生了一连串的自动装配失败。然而,作为测试驱动开发的坚定支持者,我希望在设置基础设施之前单元测试我的实现。幸运的是,扫描器相当可定制,我可以提供过滤器,例如:


Locale.setDefault(Locale.GERMAN);
GenericApplicationContext context = new GenericApplicationContext();

boolean useDefaultFilters = false;

ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(context, useDefaultFilters);
scanner.addExcludeFilter(new AssignableTypeFilter(JdbcMessageRepository.class));
scanner.addIncludeFilter(new AnnotationTypeFilter(Component.class));
scanner.addIncludeFilter(new RegexPatternTypeFilter(Pattern.compile("blog\\.Stub.*")));
scanner.scan("blog");

context.refresh();
GreetingService greetingService = 
             (GreetingService) context.getBean("greetingServiceImpl");
String message = greetingService.greet("Standalone Beans");
System.out.println(message);

正如你所见,我禁用了 'defaultFilters' 并显式添加了自己的过滤器。在这种情况下,这并非完全必要,因为默认过滤器包含了 @Component 和 @Repository 注解,但我还是想展示各种过滤选项——包括注解、可分配类型甚至正则表达式。当然,主要目标是禁用 MessageRepository 的 JDBC 版本,转而使用 stub 版本,而根据我的结果,这正是发生的:


Willkommen Standalone Beans

假设我现在准备集成 JDBC 版本,我可能会需要包含一些用于 DataSource 的 XML 配置,例如:


<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.0.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-2.1.xsd">
      
    <context:property-placeholder location="classpath:blog/jdbc.properties"/>
    
    <bean class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    	<property name="driverClassName" value="${jdbc.driver}"/>
    	<property name="url" value="${jdbc.url}"/>
    	<property name="username" value="${jdbc.username}"/>
    	<property name="password" value="${jdbc.password}"/>
    </bean>
	
</beans>

然后,我可以将扫描与 XmlBeanDefinitionReader 结合起来(请注意,我只恢复了默认过滤器):


Locale.setDefault(Locale.GERMAN);
GenericApplicationContext context = new GenericApplicationContext();

ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(context);
scanner.scan("blog");

BeanDefinitionReader reader = new XmlBeanDefinitionReader(context);
reader.loadBeanDefinitions("classpath:/blog/dataSource.xml");

context.refresh();
GreetingService greetingService = (GreetingService) context.getBean("greetingServiceImpl");
String message = greetingService.greet("Hybrid Beans");
System.out.println(message);

上下文包含扫描的 bean 以及 XML 中定义的 bean,结果是:


Willkommen Hybrid Beans

到目前为止,你已经看到 0 个候选 bean 将导致自动装配失败,除非 @Autowired 的 'required' 参数被设置为false。考虑到自动装配遵循“按类型”语义,无论 required 参数的值如何,超过 1 个 bean 都将导致失败。例如,在将 @Repository 注解重新添加到 StubMessageRepository 并重新运行之前的示例后,我收到了以下异常:


org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'greetingServiceImpl': Autowiring of fields failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private blog.MessageRepository blog.GreetingServiceImpl.messageRepository; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [blog.MessageRepository] is defined: expected single bean but found 2

这可以通过切换到“按名称”语义来解决——通过 Spring 2.1 对 JSR-250 @Resource 注解的支持来实现:


@Component
public class GreetingServiceImpl implements GreetingService {

	@Resource(name="jdbcMessageRepository")
	private MessageRepository messageRepository;
	...

你可能在之前的示例中注意到,bean 名称(如 @Resource 注解中指定的)默认为首字母小写的非限定类名。要覆盖此行为,可以添加自己的 BeanNameGenerator 策略实现,例如:


private static class MyBeanNameGenerator implements BeanNameGenerator {

	public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
		String fqn = definition.getBeanClassName();
		return Introspector.decapitalize(fqn.replace("blog.", "").replace("Jdbc", ""));
	}
}

然后将此策略提供给扫描器会覆盖默认设置:


ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(context);
scanner.setBeanNameGenerator(new MyBeanNameGenerator());
scanner.scan("blog");

因此,@Resource 注解中指定的名称可以相应地修改:


@Resource(name="messageRepository")
private MessageRepository messageRepository;

注意:当依赖容器进行自动装配时,默认命名策略通常足够(即它在“后台”工作)。因此,命名策略只应在其他地方按名称引用 bean 的情况下考虑。即使如此,对于孤立的情况,在“stereotype”注解(例如 @Repository("messageRepository"))中显式提供 bean 名称要简单得多。提供自己的策略很有用,如果你能够利用在整个应用程序中一致使用的命名约定(这个特定的示例有点牵强,但希望能说明该策略非常灵活,以便你能够遵循自己的命名约定)。

到目前为止,所有 bean 都已配置为默认的“singleton”作用域,但作用域解析是扫描器的另一个可自定义策略。默认情况下,它将查找每个组件上的 @Scope 注解。例如,要将 GreetingServiceImpl 配置为“prototype”,只需添加以下内容:


@Scope("prototype")
@Component
public class GreetingServiceImpl implements GreetingService { .. }

虽然默认的注解方法非常简单,但作用域几乎总是部署特定的考虑因素。因此,它通常不属于类级别,也不在源代码中。出于这些原因,以下策略接口可用,并且可以像上一个示例中的 BeanNameGenerator 一样在扫描器上指定:


public interface ScopeMetadataResolver {
	ScopeMetadata resolveScopeMetadata(BeanDefinition definition);
}

请注意,名称生成和作用域解析策略也可以在基于 XML 的配置中提供,例如:


<context:component-scan base-package="blog"
                        name-generator="blog.MyBeanNameGenerator"
                        scope-resolver="blog.MyScopeMetadataResolver"/>

同样,自定义过滤器可以作为子元素添加:


<context:component-scan base-package="blog" use-default-filters="false">
    <context:include-filter type="annotation" expression="org.springframework.stereotype.Component"/>
    <context:include-filter type="regex" expression="blog\.Stub.*"/>
    <context:exclude-filter type="assignable" expression="blog.JdbcMessageRepository"/>
</context:component-scan>

我知道这篇条目已经涉及了很多内容,但我还有最后一个主题想讲。在上一篇文章中,我包含了带有 <aop:aspectj-autoproxy/> 元素的 aspect。现在我想演示如何在我们的独立版本中添加 autoproxy 行为。首先,aspect 本身(与上次相同):


@Aspect
public class ServiceInvocationLogger {

	private int invocationCount;
	
	@Pointcut("execution(* blog.*Service+.*(..))")
	public void serviceInvocation() {}
	
	@Before("serviceInvocation()")
	public void log() {
		invocationCount++;
		System.out.println("service invocation #" + invocationCount);
	}
}

接下来,我需要为 @Aspect 注解添加一个 include 过滤器(它已不再包含在默认过滤器中):


scanner.addIncludeFilter(new AnnotationTypeFilter(Aspect.class));
scanner.scan("blog");

最后,我需要在调用上下文的 refresh() 之前注册 AspectJ 注解驱动的 autoproxy 创建器:


AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary(context);
context.refresh();

结果


service invocation #1
Willkommen Hybrid Beans

希望这篇条目和上一篇为这些 Spring 2.1 的新功能提供了一个充分的介绍。现在,你应该对如何在“传统”Spring XML 配置中少量地结合组件扫描和注解配置有一个不错的理解,如果你愿意的话。此外,通过提供自己的过滤器、名称生成器和作用域解析器,你可以自定义配置过程。官方的 2.1-M2 版本在参考文档中包含更详细的信息。

请继续关注Interface21 Team Blog,了解更多新功能,因为我们正在从当前的里程碑阶段向 Spring 2.1 的 RC1 版本迈进,如果你对注解驱动的配置不太感兴趣,那么你可能需要关注 Costin Leau 即将发布的关于 Spring Java Configuration 的博客——它提供了另一种替代 XML 的方法,但不会侵入你的应用程序代码。

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,助您加速进步。

了解更多

获得支持

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件,只需一份简单的订阅。

了解更多

即将举行的活动

查看 Spring 社区所有即将举行的活动。

查看所有