SpringBoot如何读取war包jar包和Resource资源

这篇文章主要介绍了springboot如何读取war包jar包和resource资源,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

场景描述

在开发过程中我们经常会碰到要在代码中获取资源文件的情况，而我在最近在springboot项目中时碰到一个问题，就是在本地运行时，获取本地的xml资源文件是能够获取到的，但是项目打成war包jar包启动运行时，就会发生问题，报找不到资源文件的错误。然后经过寻找排查确定了是下面代码通过classloader获取路径的时候出错了。

常用方式：

/**
 * @author mazhq
 * @title: testmain
 * @projectname: zeus
 * @description: todo
 * @date 2019/3/5 16:10
 */
public class testmain {
  public static void main(string[] args) {
    string path = testmain.class.getclassloader().getresource("1.xml").getpath();
    system.out.println(path);
  }
　/**
   * 输出：
   *
   */d:/demo_projects/sc-architecture/service-hi/target/classes/1.xml
   */
}

但是在将springboot打包放到linux服务器启动打印的目录为

/data/zeus/service-hi-1.0.0-snapshot.war!/web-inf/classes!/1.xml

可以看到在linux中无法直接访问未经解压的文件，所以就会找不到文件。

解决办法

1. 通过classloader的getresourceasstream()方法获取其流，就能够获取到。

读取jar里面的文件，我们只能用流去读取，不能用file

public class testmain {
  public static void main(string[] args) {
    try {
      list<string> content = ioutils.readlines(testmain.class.getclassloader().getresourceasstream("1.xml"), "utf-8");
    } catch (ioexception e) {
      e.printstacktrace();
    }
  }
}

2. 采用绝对路径将文件放到服务器某个路径，在application.properties中配置路径读取。

3. 不推荐：将内容放到数据库中。

获取资源的两种方式

通常在开发过程中会碰到读取配置文件的问题，一般有两种方式进行读取。一种是class.getresource(string path)，一种是classloader.getresource(string path)，这两种虽然都能读取文件，但是在path的填写上有一点点的不同。

class.getresource

path以/开头：则是从classpath根下获取

path不以/开头：默认是从此类所在的包下取资源

下面有个例子

public class testmain {
  public static void main(string[] args) {
    system.out.println(testmain.class.getresource("/"));
    system.out.println(testmain.class.getresource(""));
  }
  /**
   * 输出：
   *
   * file:/d:/demo_projects/sc-architecture/service-hi/target/classes/
   * file:/d:/demo_projects/sc-architecture/service-hi/target/classes/com/mazhq/servicehi/
   */
}

那么读取在resource下的1.xml，就如下的获取方法

public class testmain {
  public static void main(string[] args) {
    system.out.println(testmain.class.getresource("/1.xml"));
    system.out.println(testmain.class.getresource("../../../1.xml"));
  }
  /**
   * 输出：
   *
   * file:/d:/demo_projects/sc-architecture/service-hi/target/classes/1.xml
   * file:/d:/demo_projects/sc-architecture/service-hi/target/classes/1.xml
   */
}

classloader.getresource

classloader.getresource的path中不能以/开头，path是默认是从根目录下进行读取的

代码如下：

public class testmain {
  public static void main(string[] args) {
    system.out.println(testmain.class.getclassloader().getresource(""));
    system.out.println(testmain.class.getclassloader().getresource("/"));
  }
  /**
   * 输出：
   *
   * file:/d:/demo_projects/sc-architecture/service-hi/target/classes/
   * null
   */
}

从上面例子我们可以看到

testmain.class.getclassloader().getresource("")=testmain.class.getresource("/")

两个获取资源文件的差别

其实查看class.getresource中可以看到

public java.net.url getresource(string name) {
    name = resolvename(name);
    classloader cl = getclassloader0();
    if (cl==null) {
      // a system class.
      return classloader.getsystemresource(name);
    }
    return cl.getresource(name);
  }

他最后调用的还是classloader.getresource这个方法，那么为什么会有path的差别呢，因为其resolvename方法中对传的/进行了解析，解析为了空字符串。

resolvename 方法实现如下：

private string resolvename(string name) {
    if (name == null) {
      return name;
    }
    if (!name.startswith("/")) {
      class<?> c = this;
      while (c.isarray()) {
        c = c.getcomponenttype();
      }
      string basename = c.getname();
      int index = basename.lastindexof('.');
      if (index != -1) {
        name = basename.substring(0, index).replace('.', '/')
          +"/"+name;
      }
    } else {
      name = name.substring(1);
    }
    return name;
  }<br><br>　　//传入 "/" 返回 ""

最后：大家用的时候注意一下这些问题，避免在这个上面耽误时间。 

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。