14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）

原创

小虚竹51CTO 2022-04-24 10:08:49 ©著作权

文章标签 java 开发语言后端 hutool ResourceUtil 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者小虚竹51CTO的原创作品，请联系作者获取转载授权，否则将追究法律责任

❤️作者主页：小虚竹
❤️作者简介：大家好,我是小虚竹。Java领域优质创作者????，华为云享专家????，掘金年度人气作者????，阿里云专家博主????
❤️技术活，该赏
❤️点赞 ???? 收藏，养成习惯

用途：ResourceUtil 资源工具

使用场景

资源工具类：可以用来读取Classpath下的资源和获取指定路径下的资源列表；

方法摘要

方法	描述
cn.hutool.core.io.resource.ResourceUtil.readUtf8Str(java.lang.String)	读取Classpath下的资源为字符串，使用UTF-8编码
cn.hutool.core.io.resource.ResourceUtil.readStr(java.lang.String, java.nio.charset.Charset)	读取Classpath下的资源为字符串
cn.hutool.core.io.resource.ResourceUtil.readBytes(java.lang.String)	读取Classpath下的资源为byte[]
cn.hutool.core.io.resource.ResourceUtil.getStream(java.lang.String)	从ClassPath资源中获取{@link InputStream}
cn.hutool.core.io.resource.ResourceUtil.getStreamSafe(java.lang.String)	从ClassPath资源中获取{@link InputStream}，当资源不存在时返回null
cn.hutool.core.io.resource.ResourceUtil.getUtf8Reader(java.lang.String)	从ClassPath资源中获取{@link BufferedReader}
cn.hutool.core.io.resource.ResourceUtil.getReader(java.lang.String, java.nio.charset.Charset)	从ClassPath资源中获取{@link BufferedReader}
cn.hutool.core.io.resource.ResourceUtil.getResource(java.lang.String)	获得资源的URL<br> 路径用/分隔，例如: config/a/db.config spring/xml/test.xml
cn.hutool.core.io.resource.ResourceUtil.getResources(java.lang.String)	获取指定路径下的资源列表<br> 路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
cn.hutool.core.io.resource.ResourceUtil.getResourceIter(java.lang.String)	获取指定路径下的资源Iterator<br> 路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
cn.hutool.core.io.resource.ResourceUtil.getResource(java.lang.String, java.lang.Class)	获得资源相对路径对应的URL
cn.hutool.core.io.resource.ResourceUtil.getResourceObj(java.lang.String)	获取{@link Resource} 资源对象<br> 如果提供路径为绝对路径或路径以file:开头，返回{@link FileResource}，否则返回{@link ClassPathResource}

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.readUtf8Str(java.lang.String)

方法描述

读取Classpath下的资源为字符串，使用UTF-8编码

支持版本及以上

3.1.1

参数描述:

参数名	描述
String resource	resource 资源路径，使用相对ClassPath的路径

返回值:

资源内容

参考案例:

final String str = ResourceUtil.readUtf8Str("test.xml");
    System.out.println(str);
    Assert.assertNotNull(str);
    System.out.println("------------------");

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_后端

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.readStr(java.lang.String, java.nio.charset.Charset)

方法描述

读取Classpath下的资源为字符串

支持版本及以上

3.1.1

参数描述:

参数名	描述
String resource	resource 可以是绝对路径，也可以是相对路径（相对ClassPath）
Charset charset	charset 编码

返回值:

资源内容

参考案例:

final String str = ResourceUtil.readStr("test.xml", CharsetUtil.CHARSET_UTF_8);
    System.out.println(str);
    Assert.assertNotNull(str);
    System.out.println("------------------");
    final String str1 = ResourceUtil.readStr("C:\\Users\\Administrator\\Desktop\\xuzhu\\aaa.txt", CharsetUtil.CHARSET_UTF_8);
    System.out.println(str1);

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_02

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.readBytes(java.lang.String)

方法描述

读取Classpath下的资源为byte[]

支持版本及以上

4.5.19

参数描述:

参数名	描述
String resource	resource 可以是绝对路径，也可以是相对路径（相对ClassPath）

返回值:

资源内容

参考案例:

final byte[] bytes = ResourceUtil.readBytes("test.xml");
    System.out.println(new String(bytes,CharsetUtil.CHARSET_UTF_8));

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_java_03

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getStream(java.lang.String)

方法描述

从ClassPath资源中获取{@link InputStream}

支持版本及以上

3.1.2

参数描述:

参数名	描述
String resource	resource ClassPath资源

返回值:

{@link InputStream}

参考案例:

final byte[] bytes = IoUtil.readBytes(ResourceUtil.getStream("hutool.jpg"));
    Assert.assertEquals(22807, bytes.length);

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_04

源码解析：

/**
   * 从ClassPath资源中获取{@link InputStream}
   * 
   * @param resource ClassPath资源
   * @return {@link InputStream}
   * @throws NoResourceException 资源不存在异常
   * @since 3.1.2
   */
  public static InputStream getStream(String resource) throws NoResourceException {
    return getResourceObj(resource).getStream();
  }

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getStreamSafe(java.lang.String)

方法描述

从ClassPath资源中获取{@link InputStream}，当资源不存在时返回null

支持版本及以上

4.0.3

参数描述:

参数名	描述
String resource	resource ClassPath资源

返回值:

{@link InputStream}

参考案例:

//与readBytes 效果一致，只是多加了try catch 的处理，有异常返回Null
    final byte[] bytes = IoUtil.readBytes(ResourceUtil.getStreamSafe("hutool.jpg"));
    Assert.assertEquals(22807, bytes.length);

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_05

源码解析：

/**
   * 从ClassPath资源中获取{@link InputStream}，当资源不存在时返回null
   * 
   * @param resource ClassPath资源
   * @return {@link InputStream}
   * @since 4.0.3
   */
  public static InputStream getStreamSafe(String resource) {
    try {
      return getResourceObj(resource).getStream();
    } catch (NoResourceException e) {
      // ignore
    }
    return null;
  }

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getUtf8Reader(java.lang.String)

方法描述

从ClassPath资源中获取{@link BufferedReader}

支持版本及以上

5.3.6

参数描述:

参数名	描述
String resource	resource ClassPath资源

返回值:

{@link InputStream}

参考案例:

final CsvReader reader = CsvUtil.getReader();
    final List<Map<String, String>> result = reader.readMapList(
        ResourceUtil.getUtf8Reader("test_bean.csv"));

    Assert.assertEquals("张三", result.get(0).get("姓名"));
    Assert.assertEquals("男", result.get(0).get("gender"));
    Assert.assertEquals("无", result.get(0).get("focus"));
    Assert.assertEquals("33", result.get(0).get("age"));

    Assert.assertEquals("李四", result.get(1).get("姓名"));
    Assert.assertEquals("男", result.get(1).get("gender"));
    Assert.assertEquals("好对象", result.get(1).get("focus"));
    Assert.assertEquals("23", result.get(1).get("age"));

    Assert.assertEquals("王妹妹", result.get(2).get("姓名"));
    Assert.assertEquals("女", result.get(2).get("gender"));
    Assert.assertEquals("特别关注", result.get(2).get("focus"));
    Assert.assertEquals("22", result.get(2).get("age"));

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_后端_06

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_ResourceUtil_07

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getReader(java.lang.String, java.nio.charset.Charset)

方法描述

从ClassPath资源中获取{@link BufferedReader}

支持版本及以上

3.1.2

参数描述:

参数名	描述
String resource	resource ClassPath资源
Charset charset	charset 编码

返回值:

{@link InputStream}

参考案例:

CsvReader reader = new CsvReader();
    CsvData data = reader.read(ResourceUtil.getReader("test.csv", CharsetUtil.CHARSET_UTF_8));
    Assert.assertEquals("sss,sss", data.getRow(0).get(0));
    Assert.assertEquals("性别", data.getRow(0).get(2));
    Assert.assertEquals("关注\"对象\"", data.getRow(0).get(3));

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_开发语言_08

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_java_09

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getResource(java.lang.String)

方法描述

获得资源的URL<br>

路径用/分隔，例如:

config/a/db.config
 spring/xml/test.xml

支持版本及以上

参数描述:

参数名	描述
String resource	resource 资源（相对Classpath的路径）

返回值:

资源URL

参考案例:

URL url = ResourceUtil.getResource("hutool.jpg");
    System.out.println(url);

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_开发语言_10

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getResources(java.lang.String)

方法描述

获取指定路径下的资源列表<br>

路径格式必须为目录格式,用/分隔，例如:

config/a
 spring/xml

支持版本及以上

参数描述:

参数名	描述
String resource	resource 资源路径

返回值:

资源列表

参考案例:

List<URL> urls = ResourceUtil.getResources("test.xml");
    for (URL url : urls) {
      System.out.println(url);
    }

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_11

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_12

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getResourceIter(java.lang.String)

方法描述

获取指定路径下的资源Iterator<br>

路径格式必须为目录格式,用/分隔，例如:

config/a
 spring/xml

支持版本及以上

4.1.5

参数描述:

参数名	描述
String resource	resource 资源路径

返回值:

资源列表

参考案例:

EnumerationIter<URL> urls = ResourceUtil.getResourceIter("test.xml");
    for (URL url : urls) {
      System.out.println(url);
    }

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_java_13

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_12

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getResource(java.lang.String, java.lang.Class)

方法描述

获得资源相对路径对应的URL

支持版本及以上

参数描述:

参数名	描述
String resource	resource 资源相对路径
java.lang.Class baseClass	baseClass 基准Class，获得的相对路径相对于此Class所在路径，如果为{@code null}则相对ClassPath

返回值:

{@link URL}

参考案例:

URL url = ResourceUtil.getResource("FileUtil.class",FileUtil.class);
    System.out.println(url);
    System.out.println("----------------");
     url = ResourceUtil.getResource("hutool.jpg",null);
    System.out.println(url);

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_hutool_15

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.resource.ResourceUtil.getResourceObj(java.lang.String)

方法描述

获取{@link Resource} 资源对象<br>

如果提供路径为绝对路径或路径以file:开头，返回{@link FileResource}，否则返回{@link ClassPathResource}

支持版本及以上

3.2.1

参数描述:

参数名	描述
String path	path 路径，可以是绝对路径，也可以是相对路径（相对ClassPath）

返回值:

{@link Resource} 资源对象

参考案例:

Resource resource = ResourceUtil.getResourceObj("test.xml");
    System.out.println(resource.readUtf8Str());

14《hutool实战》:ResourceUtil 资源工具（JAVA 小虚竹）_ResourceUtil_16

源码解析：

链接：待补充

今天是持续写作的第 27 / 100 天。
可以关注我，点赞我、评论我、收藏我啦。

上一篇：01《JAVA从零到壹》第一讲：Java编程基础（文末有课后作业）

下一篇：13《hutool实战》:FileNameUtil 文件名工具（JAVA 小虚竹）

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯