用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，推荐大家在合适的场景下使用。