用Spring的這個類來讀取配置文件真的是贊
1. 前言
在開發中讀取項目中的配置或者靜態文件是家常便飯的事情，我相信很多同學都從網上找下面的例子來進行文件加載讀取操作。
利用ClassLoader獲取classpath路徑：
- ClassLoader loader = Thread.currentThread().getContextClassLoader();
- String classPath = loader.getResource("").getPath()
或者利用Class對象來獲取絕對路徑或者classpath路徑：
- String absolutepath = this.getClass().getResource("").getPath();
- String classPath = this.getClass().getResource("/").getPath();
然后在拼接文件路徑讀取文件。為什么我這么清楚?因為我也這么干過。但是現在我已經不這么干了，因為我發現了 Spring 框架提供了更加好用的加載讀取文件的方式。
2. ClassPathResource
一般來說，我們項目的配置文件及靜態資源都會放置在resources目錄下。這時我們可以通過 Spring 提供的ClassPathResource來訪問。例如在我最新的微信支付 SDK 項目中要加載微信支付的證書：
微信證書的類路徑為wechat/apiclient_cert.p12
對應讀取方法為：
- ClassPathResource resource = new ClassPathResource(keyPath);
- InputStream is = resource.getInputStream();
然后你就能從流中讀取配置文件的內容了，非常簡單。
還有其它一些方法，例如判斷文件是否存在、獲取文件的File對象等等，也非常有用。
微信支付開發包：https://felord.gitee.io/payment-spring-boot
ClassPathResource 的坑
說到獲取文件對象的getFile()方法，這里是有一個小坑的。當你利用這個方法去讀取 Jar 包里面類路徑的文件的時候是行不通的。
經過代碼調試，發現加載的地址是一個 Jar 文件協議地址，它類似這種格式jar:file:/xxx/xx.jar!/xxxx。
而getFile()方法只支持JBoss的vfs協議頭和傳統文件系統的file協議頭。所以推薦使用getInputStream()。
3. 總結
ClassPathResource在讀取類路徑下的文件配置、或者 Excel 模板、靜態配置時非常有用，封裝了很多好用的 API，推薦大家在合適的場景下使用。
本文轉載自微信公眾號「碼農小胖哥 」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。
