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 Configuration 專案和這篇部落格

本教程至少需要 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> 

重新執行測試。它們仍然會失敗,但如果你仔細觀察,會發現是一個新問題。斷言失敗,因為返回的訊息是 null。這意味著 'messageRepository' 屬性 *已* 設定在 greeting 服務上!現在,只需要初始化 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 { ... }

然後透過刪除現有的顯式 bean 定義並簡單地新增一個 component-scan 標籤來修改 XML 檔案


<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 社群所有即將舉行的活動。

檢視所有