Spring便攜開發(fā)之工具類專題(一)

Java作為高級程序語言中的老將改橘,自然擁有很多技術(shù)工具,其中Spring框架為人所熟知自脯,里面也有很多utils提供給開發(fā)者贞谓,隨我一起來看看吧!

前言

Spring的工具類都是以Utils結(jié)尾叛溢,所以要查看這些工具類塑悼,只需要在API文檔中查詢所有*Utils即可,可以看到有多達(dá)幾十個(gè)楷掉。其中有我們非常熟悉的org.springframework.util.StringUtils厢蒜,有用到過的org.springframework.aop.support.AopUtils,還有可能沒有聽過的org.springframework.core.annotation.AnnotatedElementUtils等等烹植。后面我們會選擇十來個(gè)有用的Utils斑鸦,給大家展示一下Spring中的工具類的有用和常用方法。

org.springframework.core.io.support.PropertiesLoaderUtils

我們今天第一個(gè)介紹的是PropertiesLoaderUtils草雕,這個(gè)工具類主要是針對Properties文件的加載操作巷屿,在Spring對.properties文件和.factories文件的操作都有使用到。

先來簡單看看這個(gè)類提供的有用方法:

  • Properties loadProperties(Resource resource) throws IOException:從一個(gè)資源文件加載Properties墩虹;
  • Properties loadProperties(EncodedResource resource) throws IOException:加載資源文件嘱巾,傳入的是提供了編碼的資源類(EncodedResource)憨琳;和上面方法基本一致;
  • void fillProperties(Properties props, Resource resource) throws IOException:從一個(gè)資源類中加載資源浓冒,并填充到指定的Properties對象中栽渴;
  • void fillProperties(Properties props, EncodedResource resource)
    throws IOException:從一個(gè)編碼資源類中加載資源,并填充到指定的Properties對象中稳懒;和上面方法基本一致闲擦;
  • Properties loadAllProperties(String resourceName) throws IOException:根據(jù)資源文件名稱,加載并合并classpath中的所有資源文件场梆;
  • Properties loadAllProperties(String resourceName, ClassLoader classLoader) throws IOException:從指定的ClassLoader中墅冷,根據(jù)資源文件名稱,加載并合并classpath中的所有資源文件或油;

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

loadProperties

測試方法很簡單腔彰,我們首先準(zhǔn)備一個(gè)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"));

}

測試完成辖佣。沒有太大難度霹抛; 但是,其實(shí)Properties對象不僅僅支持.properties文件卷谈,還支持XML格式的資源配置文件杯拐。先來看看Properties對象對XML類型資源文件的DTD定義(http://java.sun.com/dtd/properties.dtd):

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

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

<!ELEMENT comment (#PCDATA) >

<!ELEMENT entry (#PCDATA) >

<!ATTLIST entry key CDATA #REQUIRED>

那么我們就可以有以下測試。創(chuàng)建一個(gè)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"));

}

測試通過世蔗。當(dāng)然端逼,我們是非常不建議使用XML的方式來做配置的。

接下來使用EncodeResource來測試污淋,EncodeResource在Resource上增加了字符編碼設(shè)置顶滩。同樣使用之前的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基礎(chǔ)之上包裝了UTF-8字符編碼的EncodeResource寸爆;

loadAllProperties

loadProperties方法诲祸,從當(dāng)前classpath下加載properties文件,如果使用loadAllProperties而昨,可以從當(dāng)前classpath下加載所有的相同名稱的properties文件救氯,并執(zhí)行合并。

來完成一個(gè)測試歌憨。把上一個(gè)例子中的test.properties文件保留着憨,放到src/main/resources中;然后在src/test/resources目錄下再創(chuàng)建一個(gè)test.properties文件务嫡,內(nèi)容為:

key3=value

測試代碼:

@Test

public void testLoadAllPropertiesString() throws Exception {

Properties ret = PropertiesLoaderUtils

        .loadAllProperties("test.properties");

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

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

}

執(zhí)行測試通過甲抖;可以看到漆改,main下的test.properties和test下的test.properties都被識別并執(zhí)行了合并;那如果在test/resources中的test.properties中增加

key=update

再次執(zhí)行測試准谚,仍然通過挫剑,說明在多個(gè)配置文件中如果有重復(fù)key,最近的classpath為準(zhǔn)(比如當(dāng)前應(yīng)用的properties內(nèi)容會優(yōu)先于jar包中的properties)

但是柱衔,如果這種情況下樊破,使用loadProperties方法,那么只會加載到test/resources中的test.properties唆铐;這個(gè)結(jié)果可以對loadAllProperties有更深刻理解哲戚。

fillProperties

fillProperties方法其實(shí)是loadProperties方法的真正調(diào)用方法。先來看看測試代碼:

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

}

可以看到顺少,其實(shí)調(diào)用的就是fileProperties方法,而這個(gè)方法的實(shí)現(xiàn)其實(shí)也很簡單:

public static void fillProperties(Properties props, EncodedResource resource)

    throws IOException {

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

}

代理給了fillProperties(Properties props, EncodedResource resource, PropertiesPersister persister)方法王浴;只是最后一個(gè)參數(shù)是一個(gè)PropertiesPersister脆炎,抽取了一個(gè)統(tǒng)一的從XML或者properties資源加載和裝載接口;來看看具體實(shí)現(xiàn)(我只保留了最基本的關(guān)鍵代碼):

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

}

}

可以看到秒裕,其實(shí)就是調(diào)用了PropertiesPersister的loadFromXml和load方法來分別加載XML或properties;

如果再往下看筛婉,有興趣的童鞋可以看看DefaultPropertiesPersister的相關(guān)的這兩個(gè)方法簇爆,其實(shí)核心還是使用Properties對象的load和loadFromXML方法完成的癞松。

小結(jié)
Properties對象的load和loadFromXML方法是核心爽撒,重要知識要?jiǎng)澲攸c(diǎn)。后續(xù)會推出更多spring utils响蓉,歡迎持續(xù)關(guān)注硕勿。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市枫甲,隨后出現(xiàn)的幾起案子源武,更是在濱河造成了極大的恐慌,老刑警劉巖想幻,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件粱栖,死亡現(xiàn)場離奇詭異,居然都是意外死亡脏毯,警方通過查閱死者的電腦和手機(jī)闹究,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來食店,“玉大人渣淤,你說我怎么就攤上這事赏寇。” “怎么了价认?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵嗅定,是天一觀的道長。 經(jīng)常有香客問我用踩,道長渠退,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任捶箱,我火速辦了婚禮智什,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘丁屎。我一直安慰自己荠锭,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布晨川。 她就那樣靜靜地躺著证九,像睡著了一般。 火紅的嫁衣襯著肌膚如雪共虑。 梳的紋絲不亂的頭發(fā)上愧怜,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天,我揣著相機(jī)與錄音妈拌,去河邊找鬼拥坛。 笑死,一個(gè)胖子當(dāng)著我的面吹牛尘分,可吹牛的內(nèi)容都是我干的猜惋。 我是一名探鬼主播,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼培愁,長吁一口氣:“原來是場噩夢啊……” “哼著摔!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起定续,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤谍咆,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后私股,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體摹察,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年倡鲸,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了供嚎。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,965評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖查坪,靈堂內(nèi)的尸體忽然破棺而出寸宏,到底是詐尸還是另有隱情,我是刑警寧澤偿曙,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布氮凝,位于F島的核電站,受9級特大地震影響望忆,放射性物質(zhì)發(fā)生泄漏罩阵。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一启摄、第九天 我趴在偏房一處隱蔽的房頂上張望稿壁。 院中可真熱鬧,春花似錦歉备、人聲如沸傅是。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽喧笔。三九已至,卻和暖如春龟再,著一層夾襖步出監(jiān)牢的瞬間书闸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工利凑, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留浆劲,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓哀澈,卻偏偏與公主長得像牌借,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子日丹,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容

  • 工具從古至今都是為了方便人們生活和工作的利器走哺,在程序語言中也不例外蚯嫌,Spring具有很多工具類哲虾,有的是專屬框架工具...
    可以寫但沒有必要閱讀 404評論 0 0
  • 在Spring中,有非常多Utils工具類择示,這些工具類有的是為了開發(fā)者使用的束凑,有的只是提供給Spring框架使用的...
    可以寫但沒有必要閱讀 2,422評論 0 0
  • 在Java開發(fā)過程中,我們會用到很多工具類來為我們項(xiàng)目開發(fā)做工作栅盲,同樣汪诉,Spring板塊中,也有很多工具類,他們有...
    可以寫但沒有必要閱讀 496評論 0 0
  • feisky云計(jì)算扒寄、虛擬化與Linux技術(shù)筆記posts - 1014, comments - 298, trac...
    不排版閱讀 3,849評論 0 5
  • 記錄自己對于母親的思想鱼鼓,反抗是在嘗試找到自己,修復(fù)自己该编,至于方法迄本,在反抗中反思,不斷優(yōu)化方式课竣。 好的方面 正直 勤...
    nancy的成長閱讀 194評論 0 0