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

 更新时间:2020年01月16日 09:51:14   作者:森林木马  
这篇文章主要介绍了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>  //传入 "/" 返回 ""

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

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

相关文章

  • java使用this调用构造函数的实现方法示例

    java使用this调用构造函数的实现方法示例

    这篇文章主要介绍了java使用this调用构造函数的实现方法,结合实例形式分析了java面向对象程序设计中函数调用相关操作技巧,需要的朋友可以参考下
    2019-08-08
  • JAVA(MAVEN项目)添加JUnit依赖配置全过程

    JAVA(MAVEN项目)添加JUnit依赖配置全过程

    在Maven项目中进行单元测试是确保代码质量的重要步骤,本教程提供SpringBoot和微服务平台适用的单元测试方法,包括环境准备、创建测试类、JUnit简介及注解使用,环境准备涉及引入依赖和安装JUnit插件,测试类创建可通过快捷键或手动添加@Test注解来实现
    2024-10-10
  • 一文弄懂Java中ThreadPoolExecutor

    一文弄懂Java中ThreadPoolExecutor

    ThreadPoolExecutor是Java中的一个线程池实现,它可以管理和控制多个 Worker Threads,本文就详细的介绍一下Java中ThreadPoolExecutor,具有一定的参考价值,感兴趣的可以了解一下
    2023-08-08
  • SpringBoot中的统一异常处理详细解析

    SpringBoot中的统一异常处理详细解析

    这篇文章主要介绍了SpringBoot中的统一异常处理详细解析,该注解可以把异常处理器应用到所有控制器,而不是单个控制器,借助该注解,我们可以实现:在独立的某个地方,比如单独一个类,定义一套对各种异常的处理机制,需要的朋友可以参考下
    2024-01-01
  • JVM指令的使用深入详解

    JVM指令的使用深入详解

    这篇文章主要给大家介绍了关于JVM指令使用的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-01-01
  • Java真题实练掌握哈希表的使用

    Java真题实练掌握哈希表的使用

    哈希表是一种根据关键码去寻找值的数据映射结构,该结构通过把关键码映射的位置去寻找存放值的地方,说起来可能感觉有点复杂,我想我举个例子你就会明白了,最典型的的例子就是字典
    2022-07-07
  • Java生成PDF文件的实例代码

    Java生成PDF文件的实例代码

    Java生成PDF文件的实例代码,需要的朋友可以参考一下
    2013-05-05
  • 简析Java中的util.concurrent.Future接口

    简析Java中的util.concurrent.Future接口

    这篇文章主要介绍了简析Java中的util.concurrent.Future接口,作者把future归结为在未来得到目标对象的占位符,需要的朋友可以参考下
    2015-07-07
  • IDEA设置生成带注释的getter和setter的图文教程

    IDEA设置生成带注释的getter和setter的图文教程

    通常我们用idea默认生成的getter和setter方法是不带注释的,当然,我们同样可以设置idea像MyEclipse一样生成带有Javadoc的模板,具体设置方法,大家参考下本文
    2018-05-05
  • IntelliJ IDEA快速创建getter和setter方法

    IntelliJ IDEA快速创建getter和setter方法

    这篇文章主要介绍了IntelliJ IDEA快速创建getter和setter方法,本文通过图文实例相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-03-03

最新评论