一个小坑：java如何访问依赖jar包中的资源文件

• 最近在实现NFIT（异常错误注入包）的远程加压接口的时候，踩了一个小坑，估计大家在今后的工作中也有可能遇到，所以拿出来分享下。
• 其实很简单，就是我编写的一个CPU加压接口内部逻辑是先把配置文件和启动脚本拷贝到远端，然后远程拉起加压工具进程，在远端服务器加压。这个接口在本地工程调试都通过没问题，然而打包后在真正的测试工程去引用这个包的接口却报错。
• 报错信息如下：

  09:51:38 ERROR NFITServiceImpl:151 - putFiletoRemote fail
  java.io.FileNotFoundException: file:\C\Users\hzcuixiaoqing\.m2\repository\com\netease\qa\cloudqa\nfit
  \0.1.0\nfit-0.1.0.jar!\cmdline_config_CPU.txt (文件名、目录名或卷标语法不正确。)
  

定位分析

• 后来查找资料发现是java获取依赖jar包中资源文件跟获取本工程中的资源文件的使用姿势还是有一定区别的，没有使用正确的姿势，经过修正后，我的jar包中的接口欢快的跑起来了。

• 在逻辑中涉及到拷贝本地配置文件和启动脚本到远端的操作，这个配置文件是作为一个工程内的资源文件存在的，其路径为：NFIT_PACKAGE\src\main\resources\cmdline_config_CPU.txt

• 需要先获取本地文件然后再传递，这里我一开始用了一个ClassLoader.getSystemResource方法来获取文件，如下所示：

  String localFilename = "cmdline_config_CPU.txt";    
  localFilepath = ClassLoader.getSystemResource(localFilename).getPath();
  File localfile =new  File(localFilepath);
  boolean ret = NFITService.putFiletoRemote(localfile, remotePath,localFilename);
  

• 在NFIT这个包内直接运行没有任何问题，结果输出如下,可以从日志中看到传输成功了：

  [INFO ]10:27:07, [Class]NFITServiceImpl, [Method]putFileInputStreamtoRemote, =========putFiletoRemote==========
  [INFO ]10:27:07, [Class]NFITServiceImpl, [Method]putFileInputStreamtoRemote, remotefile is /home/hzcuixiaoqing/cmdline_config.txt
  [INFO ]10:27:07, [Class]NFITServiceImpl, [Method]putFileInputStreamtoRemote, =========putFiletoRemote Success!==========
  

• 但是为什么打包以后在其他工程中调用会出错呢，可以注意到错误提示里面提示的是(文件名、目录名或卷标语法不正确。) 并且查看打印的绝对路径\C\Users\hzcuixiaoqing.m2\repository\com\netease\qa\cloudqa\nfit \0.1.0\nfit-0.1.0.jar!\cmdline_config_CPU.txt 存在一个nfit-0.1.0.jar!叹号，并且查看这个目录，由于指向的确实是一个jar包，因此这样的路径确实访问不到cmdline_config_CPU.txt这个文件。那如何来解决这个问题呢，难道jar包中的资源都没办法获取了么，当然不是！

• java的类装载器(ClassLoader)早就考虑到了这一点。
• ClassLoader是个什么东东呢：

  ClassLoader 是类加载器的抽象类。它可以在运行时动态的获取加载类的运行信息。 可以这样说，当我们调用jar中的Resource类时，JVM加载进Resource类，并记录下Resource运行时信息(包括Resource所在jar包的路径信息)。而ClassLoader类中的方法可以帮助我们动态的获取这些信息。
  

真相即将大白

• 搜索ClassLoader的API发现除了getSystemResource以后还有一个逼格很高的接口叫getSystemResourceAsStream,这两个接口的描述如下

  static URL    getSystemResource(String name)
  Find a resource of the specified name from the search path used to load classes.
  static InputStream    getSystemResourceAsStream(String name)
  Open for reading, a resource of the specified name from the search path used to load classes.
  

• 我们一开始是使用的第一个接口，首先根据资源的名称，来返回资源的URL对象，然后获取到它的绝对路径，并且new一个File对象，然后获取File对象的输入流从而获取这个对象内部的数据以传输到远端。
• 这样的话既然需要获取绝对路径就避免不了会出现文章一开始的路径不存在的尴尬境地，因为jar包中的资源实际上是没有一个有效的绝对路径来访问的，因此new File的时候就会报错。
• 转而观察第二个接口，它是直接返回读取指定资源的输入流。这样就可以避免获取绝对路径带来的错误。
• 修改代码如下：

                String localFilename = "cmdline_config_CPU.txt";
               -String localFilepath = ClassLoader.getSystemResource(localFilena
              -File localfile =new  File(localFilepath);
              +InputStream localFileis = ClassLoader.getSystemResourceAsStream(
                //生成默认的传输目的文件夹（默认传到用户home目录下，root需要另外
                String remotePath = "/home/"+getUnit().getUserName()+"/";
                if (getUnit().getUserName().equalsIgnoreCase("root")){
                        remotePath = "/root/";
                }
                String remotefile = "cmdline_config.txt";
        -boolean ret = NFITService.putFiletoRemote(localfile, remotePath,remotefi
       +boolean ret = NFITService.putFileInputStreamtoRemote(localFileis, remote
        if (!ret){
                return false;
        }

*重新打包，更新，然后在其他测试工程中引用这个接口，接口就可以欢快的运行起来了。 运行结果：

10:54:30 INFO  NFITServiceImpl:46 - =========install burninTest already exsits==========
10:54:30 INFO  NFITServiceImpl:186 - =========putFiletoRemote==========
10:54:30 INFO  NFITServiceImpl:188 - remotefile is /home/hzcuixiaoqing/cmdline_config.txt
10:54:30 INFO  NFITServiceImpl:204 - =========putFiletoRemote Success!==========

总结

小伙伴们， 千言万语汇成一句话，如果你想访问依赖jar包中的资源，一定ClassLoader.getSystemResourceAsStream这个接口，你值得拥有！

本文来自网易实践者社区，经作者崔晓晴授权发布。