帶你了解Spring中的各種Utils

在Spring中，有非常多Utils工具類，這些工具類有的是為了開發者使用的，有的只是提供給Spring框架使用的。了解這些工具類，在適當的時候使用這些工具類，對我們平時的開發還是很有幫助的，能極大方便我們的開發。

前言

Spring的工具類都是以Utils結尾，所以要查看這些工具類，只需要在API文檔中查詢所有*Utils即可，可以看到有多達幾十個。其中有我們非常熟悉的org.springframework.util.StringUtils，有用到過的org.springframework.aop.support.AopUtils，還有可能沒有聽過的org.springframework.core.annotation.AnnotatedElementUtils等等。后面我們會選擇十來個有用的Utils，給大家展示一下Spring中的工具類的有用和常用方法。

org.springframework.core.io.support.PropertiesLoaderUtils

我們今天第一個介紹的是PropertiesLoaderUtils，這個工具類主要是針對Properties文件的加載操作，在Spring對.properties文件和.factories文件的操作都有使用到。

先來簡單看看這個類提供的有用方法：

• Properties loadProperties(Resource resource) throws IOException：從一個資源文件加載Properties；
• Properties loadProperties(EncodedResource resource) throws IOException：加載資源文件，傳入的是提供了編碼的資源類（EncodedResource）；和上面方法基本一致；
• void fillProperties(Properties props, Resource resource) throws IOException：從一個資源類中加載資源，并填充到指定的Properties對象中；
• void fillProperties(Properties props, EncodedResource resource)
  throws IOException：從一個編碼資源類中加載資源，并填充到指定的Properties對象中；和上面方法基本一致；
• Properties loadAllProperties(String resourceName) throws IOException：根據資源文件名稱，加載并合并classpath中的所有資源文件；
• Properties loadAllProperties(String resourceName, ClassLoader classLoader) throws IOException：從指定的ClassLoader中，根據資源文件名稱，加載并合并classpath中的所有資源文件；

方法不是很多，而且共性較大，我們就從最簡單的Properties loadProperties(Resource resource)開始。

loadProperties

測試方法很簡單，我們首先準備一個test.properties文件，放到resources下面：

key=value

key2=\u4E2D\u6587

完成代碼：

@Test

public void testLoadPropertiesResource() throws Exception {

????Properties ret = PropertiesLoaderUtils

????????????.loadProperties(new ClassPathResource("test.properties"));

????assertEquals("value", ret.getProperty("key"));

????assertEquals("中文", ret.getProperty("key2"));

}

測試完成。沒有太大難度； 但是，其實Properties對象不僅僅支持.properties文件，還支持XML格式的資源配置文件。先來看看Properties對象對XML類型資源文件的DTD定義(http://java.sun.com/dtd/properties.dtd)：

<!--

???Copyright 2006 Sun Microsystems, Inc.??All rights reserved.

??-->

<!-- DTD for properties -->

<!ELEMENT properties ( comment?, entry* ) >

<!ATTLIST properties version CDATA #FIXED "1.0">

<!ELEMENT comment (#PCDATA) >

<!ELEMENT entry (#PCDATA) >

<!ATTLIST entry key CDATA #REQUIRED>

那么我們就可以有以下測試。創建一個text.xml文件在classpath下：

<?xml version="1.0" encoding="UTF-8"?>??

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

<properties>

????<comment>一些自定義說明</comment>

????<entry key="key">value</entry>

????<entry key="key2">中文</entry>

</properties>

完成測試代碼：

@Test

public void testLoadPropertiesResourceXml() throws Exception {

????Properties ret = PropertiesLoaderUtils

????????????.loadProperties(new ClassPathResource("test.xml"));

????assertEquals("value", ret.getProperty("key"));

????assertEquals("中文", ret.getProperty("key2"));

}

測試通過。當然，我們是非常不建議使用XML的方式來做配置的。

接下來使用EncodeResource來測試，EncodeResource在Resource上增加了字符編碼設置。同樣使用之前的test.properties：

@Test

public void testLoadPropertiesEncodedResource() throws Exception {

????Properties ret = PropertiesLoaderUtils.loadProperties(

????????????new EncodedResource(new ClassPathResource("test.properties"),

????????????????????"UTF-8"));

????assertEquals("value", ret.getProperty("key"));

????assertEquals("中文", ret.getProperty("key2"));

}

可以看到，只是在之前的ClassPathResource基礎之上包裝了UTF-8字符編碼的EncodeResource；

loadAllProperties

loadProperties方法，從當前classpath下加載properties文件，如果使用loadAllProperties，可以從當前classpath下加載所有的相同名稱的properties文件，并執行合并。

來完成一個測試。把上一個例子中的test.properties文件保留，放到src/main/resources中；然后在src/test/resources目錄下再創建一個test.properties文件，內容為：

key3=value

測試代碼：

@Test

public void testLoadAllPropertiesString() throws Exception {

????Properties ret = PropertiesLoaderUtils

????????????.loadAllProperties("test.properties");

????assertEquals("value", ret.getProperty("key"));

????assertEquals("value", ret.getProperty("key3"));

}

執行測試通過；可以看到，main下的test.properties和test下的test.properties都被識別并執行了合并；那如果在test/resources中的test.properties中增加

key=update

再次執行測試，仍然通過，說明在多個配置文件中如果有重復key，最近的classpath為準（比如當前應用的properties內容會優先于jar包中的properties）

但是，如果這種情況下，使用loadProperties方法，那么只會加載到test/resources中的test.properties；這個結果可以對loadAllProperties有更深刻理解。

fillProperties

fillProperties方法其實是loadProperties方法的真正調用方法。先來看看測試代碼：

@Test

public void testFillPropertiesPropertiesResource() throws Exception {

????Resource res = new ClassPathResource("test.properties");

????Properties ret = new Properties();

????PropertiesLoaderUtils.fillProperties(ret, res);

????assertEquals("value", ret.getProperty("key"));

}

使用非常簡單。

我們來看一下loadProperties方法的源代碼：

/**

?* Load properties from the given EncodedResource,

?* potentially defining a specific encoding for the properties file.

?* @see #fillProperties(java.util.Properties, EncodedResource)

?*/

public static Properties loadProperties(EncodedResource resource) throws IOException {

????Properties props = new Properties();

????fillProperties(props, resource);

????return props;

}

可以看到，其實調用的就是fileProperties方法，而這個方法的實現其實也很簡單：

public static void fillProperties(Properties props, EncodedResource resource)

????????throws IOException {

????fillProperties(props, resource, new DefaultPropertiesPersister());

}

代理給了fillProperties(Properties props, EncodedResource resource, PropertiesPersister persister)方法；只是最后一個參數是一個PropertiesPersister，抽取了一個統一的從XML或者properties資源加載和裝載接口；來看看具體實現（我只保留了最基本的關鍵代碼）：

static void fillProperties(Properties props, EncodedResource resource, PropertiesPersister persister)

????????throws IOException {

????InputStream stream = null;

????Reader reader = null;

????try {

????????String filename = resource.getResource().getFilename();

????????//如果是XML文件，

????????if (filename != null && filename.endsWith(XML_FILE_EXTENSION)) {

????????????stream = resource.getInputStream();

????????????persister.loadFromXml(props, stream);

????????}else {

????????????stream = resource.getInputStream();

????????????persister.load(props, stream);

????????}

????}finally {

????????//close方法

????}

}

可以看到，其實就是調用了PropertiesPersister的loadFromXml和load方法來分別加載XML或properties；

如果再往下看，有興趣的童鞋可以看看DefaultPropertiesPersister的相關的這兩個方法，其實核心還是使用Properties對象的load和loadFromXML方法完成的。

小結
java工具類含有很多不同功能的類別，本文簡單介紹了Spring的第一個utils：propertiesloaderutils，提供了加載作用。更多工具類可以持續關注發文