Spring 2.1中的注解驱动依赖注入

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

Spring 2.0 引入了注解支持和注解感知的配置选项,使用Java 5(或更高版本)开发的Spring用户可以利用这些选项。

@Transactional 用于划分和配置事务定义
@Aspect (AspectJ) 用于定义方面以及@Pointcut定义和建议(@Before,@After,@Around)
@Repository 用于指示充当存储库(又名数据访问对象或DAO)的类
@Required 用于强制为带注解的bean属性提供值

在Spring 2.1中,这种注解驱动配置的主题得到了显著扩展,并且将在我们向RC1版本推进的过程中继续发展。事实上,现在可以通过注解来驱动Spring的依赖注入。此外,Spring可以*发现*应用程序上下文中需要配置的bean。

这篇博客文章将作为对10个易于理解的步骤中的基本功能的教程式介绍。我将在本周晚些时候继续介绍一些更高级的功能和定制选项。如果您有兴趣了解其他配置选项,您还应该查看Spring Java配置项目和这篇博客

本教程至少需要Java 5,推荐使用Java 6(否则在步骤1的结尾处有一个单独的要求)。

步骤1

下载spring-framework-2.1-m1-with-dependencies.zip。解压存档后,您将在“dist”目录中找到spring.jar和spring-mock.jar。将它们添加到您的CLASSPATH以及以下文件(显示的路径相对于解压的2.1-m1存档的“lib”目录):

  • asm/asm-2.2.3.jar
  • asm/asm-commons-2.2.3.jar
  • aspectj/aspectjweaver.jar
  • hsqldb/hsqldb.jar
  • jakarta-commons/commons-logging.jar
  • log4j/log4j-1.2.14.jar
(注意:如果您没有在Java 6上运行,您还需要添加j2ee/common-annotations.jar)

步骤2

提供示例的接口和类。我尽量使其尽可能简单,同时又能够演示主要功能。我将所有代码和配置都包含在一个名为“blog”的包中。我鼓励遵循相同的准则,以便示例按原样工作;否则,请确保进行必要的修改。首先是GreetingService接口

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

然后是一个简单的实现


public class GreetingServiceImpl implements GreetingService {
    private MessageRepository messageRepository;

    public void setMessageRepository(MessageRepository messageRepository) {
        this.messageRepository = messageRepository;
    }

    public String greet(String name) {
        Locale locale = Locale.getDefault();
        String message = messageRepository.getMessage(locale.getDisplayLanguage());
        return message + " " + name;
    }
}

由于服务依赖于MessageRepository,因此接下来定义该接口


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

目前,一个存根实现


public class StubMessageRepository implements MessageRepository {
    Map<String,String> messages = new HashMap<String,String>();

    public void initialize() {
        messages.put("English", "Welcome");
        messages.put("Deutsch", "Willkommen");
    }

    public String getMessage(String language) {
        return messages.get(language);
    }
}

步骤3

为Spring应用程序上下文定义bean。请注意,我包含了一个新的“context”命名空间(注意:这里也包含了“aop”命名空间,并且将在最后一步中使用)


<?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:aop="http://www.springframework.org/schema/aop"
       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/aop
           http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-2.1.xsd">
      
    <bean class="blog.GreetingServiceImpl"/>

    <bean class="blog.StubMessageRepository"/>

</beans>

显然,这个配置看起来有点稀疏。正如您可能猜到的那样,“context”命名空间很快就会发挥作用。

步骤4

提供一个利用Spring基本支持类的简单测试用例

public class GreetingServiceImplTests extends AbstractDependencyInjectionSpringContextTests {
    private GreetingService greetingService;

    public void setGreetingService(GreetingService greetingService) {
        this.greetingService = greetingService;
    }

    @Override
    protected String[] getConfigLocations() {
        return new String[] { "/blog/applicationContext.xml" };
    }

    public void testEnglishWelcome() {
        Locale.setDefault(Locale.ENGLISH);
        String name = "Spring Community";
        String greeting = greetingService.greet(name);
        assertEquals("Welcome " + name, greeting);
    }

    public void testGermanWelcome() {
        Locale.setDefault(Locale.GERMAN);
        String name = "Spring Community";
        String greeting = greetingService.greet(name);
        assertEquals("Willkommen " + name, greeting);
    }
}

尝试运行测试,并注意它们会因NullPointerException而失败。这是可以预料的,因为GreetingServiceImpl尚未提供MessageRepository。在接下来的两个步骤中,您将添加注解来分别驱动依赖注入和初始化。

步骤5

在GreetingServiceImpl的setter方法上提供@Autowired注解,例如

@Autowired
public void setMessageRepository(MessageRepository messageRepository) {
    this.messageRepository = messageRepository;
}

然后,将“annotation-config”元素(来自新的“context”命名空间)添加到您的配置中


<beans ... >
    
    <context:annotation-config/>

    <bean class="blog.GreetingServiceImpl"/>

    <bean class="blog.StubMessageRepository"/>

</beans> 

重新运行测试。它们仍然会失败,但是如果您仔细观察,这是一个新的问题。断言失败,因为返回的消息为空。这意味着“messageRepository”属性已在问候服务上设置!现在,StubMessageRepository只需要初始化。

步骤6

Spring提供了一些初始化回调选项:Spring的InitializingBean接口或XML中的“init-method”声明。从Spring 2.1开始,支持JSR-250注解——提供另一个选项:@PostConstruct(并且@PreDestroy注解可用于销毁回调,正如您很快就会看到的)。在StubMessageRepository中,将注解添加到initialize方法

@PostConstruct
public void initialize() {
    messages.put("English", "Welcome");
    messages.put("Deutsch", "Willkommen");
}

重新运行测试。这次应该通过了!

步骤7

@Autowired注解也可用于基于构造函数的注入。如果您想尝试该选项,请从GreetingServiceImpl中删除setter方法,并添加此构造函数(然后重新运行测试)


@Autowired
public GreetingServiceImpl(MessageRepository messageRepository) {
    this.messageRepository = messageRepository;
}

如果需要,您甚至可以使用字段注入。删除构造函数,将注解直接添加到字段,然后重新运行测试。代码应如下所示


@Autowired
private MessageRepository messageRepository;

步骤8

添加MessageRepository的基于JDBC的存储库实现


public class JdbcMessageRepository implements MessageRepository {

    private SimpleJdbcTemplate jdbcTemplate;

    @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);
    }

}

请注意,除了用于初始化的@PostConstruct之外,这里还使用@PreDestroy来标记要在销毁时调用的方法。此实现中有一点不清楚:SimpleJdbcTemplate将如何提供?一种选择是为模板提供bean定义。另一种选择是通过某种方式向模板的构造函数提供DataSource实现。添加以下(带注解的)方法


@Autowired
public void createTemplate(DataSource dataSource) {
    this.jdbcTemplate = new SimpleJdbcTemplate(dataSource);
}

这演示了依赖注入如何与任意方法(不是传统的“setter”)一起工作。这将在下一步的测试过程中进行测试。

步骤9

在Spring 2.1中,甚至可以发现“候选”bean,而不是像上面那样在XML中显式提供。默认情况下会识别某些注解。这包括@Repository注解以及新的@Component注解。分别将这两个注解添加到JdbcMessageRepository和GreetingServiceImpl


@Repository
public class JdbcMessageRepository implements MessageRepository { ... }

@Component
public class GreetingServiceImpl implements GreetingService { ... }

然后修改XML文件,删除现有的显式bean定义,只需添加一个component-scan标签


<beans ... >
    <context:component-scan base-package="blog"/>
</beans>

然后,添加DataSource bean定义和配置属性占位符的新标签


<beans ... >
    <context:component-scan base-package="blog"/>

    <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>

……以及jdbc.properties文件本身


jdbc.driver=org.hsqldb.jdbcDriver
jdbc.url=jdbc:hsqldb:mem:blog
jdbc.username=sa
jdbc.password=

重新运行测试,您应该看到绿色条,即使只有数据源在XML中定义。

步骤10

最后,添加一个方面(@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);
    }
}

要激活自动代理生成,只需将以下标签添加到xml


<aop:aspectj-autoproxy/>

重新运行测试,您应该看到日志消息!

注意:扫描和配置过程可以在没有任何XML的情况下启动,并且可以自定义(例如,检测您自己的注解和/或类型)。我将在下一篇文章中讨论这些功能以及更多内容。

同时,我希望这篇文章能够很好地发挥其作用——提供对这些新的Spring 2.1功能的实践经验。与以往一样,我们期待来自社区的反馈,因此请随时留下评论!

获取Spring通讯

保持与Spring通讯的联系

订阅

领先一步

VMware 提供培训和认证,以加快您的进度。

了解更多

获取支持

Tanzu Spring在一个简单的订阅中提供对OpenJDK™、Spring和Apache Tomcat®的支持和二进制文件。

了解更多

即将举行的活动

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

查看全部