[[358512]]

 1. 前言

在開(kāi)發(fā)中讀取項(xiàng)目中的配置或者靜態(tài)文件是家常便飯的事情，我相信很多同學(xué)都從網(wǎng)上找下面的例子來(lái)進(jìn)行文件加載讀取操作。

利用ClassLoader獲取classpath路徑：

ClassLoader loader = Thread.currentThread().getContextClassLoader(); 
String classPath =  loader.getResource("").getPath() 

或者利用Class對(duì)象來(lái)獲取絕對(duì)路徑或者classpath路徑：

String absolutepath =  this.getClass().getResource("").getPath(); 
String classPath =  this.getClass().getResource("/").getPath(); 

然后在拼接文件路徑讀取文件。為什么我這么清楚?因?yàn)槲乙策@么干過(guò)。但是現(xiàn)在我已經(jīng)不這么干了，因?yàn)槲野l(fā)現(xiàn)了 Spring 框架提供了更加好用的加載讀取文件的方式。

2. ClassPathResource

一般來(lái)說(shuō)，我們項(xiàng)目的配置文件及靜態(tài)資源都會(huì)放置在resources目錄下。這時(shí)我們可以通過(guò) Spring 提供的ClassPathResource來(lái)訪問(wèn)。例如在我最新的微信支付 SDK 項(xiàng)目中要加載微信支付的證書(shū)：

微信證書(shū)的類路徑為wechat/apiclient_cert.p12

對(duì)應(yīng)讀取方法為：

ClassPathResource resource = new ClassPathResource(keyPath); 
InputStream is =  resource.getInputStream(); 

然后你就能從流中讀取配置文件的內(nèi)容了，非常簡(jiǎn)單。

還有其它一些方法，例如判斷文件是否存在、獲取文件的File對(duì)象等等，也非常有用。

微信支付開(kāi)發(fā)包：https://felord.gitee.io/payment-spring-boot

ClassPathResource 的坑

說(shuō)到獲取文件對(duì)象的getFile()方法，這里是有一個(gè)小坑的。當(dāng)你利用這個(gè)方法去讀取 Jar 包里面類路徑的文件的時(shí)候是行不通的。

經(jīng)過(guò)代碼調(diào)試，發(fā)現(xiàn)加載的地址是一個(gè) Jar 文件協(xié)議地址，它類似這種格式j(luò)ar:file:/xxx/xx.jar!/xxxx。

而getFile()方法只支持JBoss的vfs協(xié)議頭和傳統(tǒng)文件系統(tǒng)的file協(xié)議頭。所以推薦使用getInputStream()。

3. 總結(jié)

ClassPathResource在讀取類路徑下的文件配置、或者 Excel 模板、靜態(tài)配置時(shí)非常有用，封裝了很多好用的 API，推薦大家在合適的場(chǎng)景下使用。

本文轉(zhuǎn)載自微信公眾號(hào)「碼農(nóng)小胖哥  」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系碼農(nóng)小胖哥公眾號(hào)。