如何使用Class.getResourceAsStream从类路径下读取配置文件输入流

陌磊君_9536

陌磊君_9536

2026-04-10

371人浏览

原创

Class.getResourceAsStream路径以/开头才从classpath根查找,否则按当前类包路径相对查找;文件需在src/main/resources下且构建后存在于jar顶层;返回null主因是路径错误、资源未进classpath或IDE缓存未刷新。

如何使用class.getresourceasstream从类路径下读取配置文件输入流

Class.getResourceAsStream 读取配置文件的路径规则

路径必须以 / 开头才表示从 classpath 根目录开始查找;不加 / 则按当前类所在包路径相对查找。比如 MyClass.class.getResourceAsStream("config.yml") 实际查的是 com/example/MyClass.class 同级的 config.yml,而非 classpath 根下的。

绝大多数场景下你想要的是根路径,所以应写成:MyClass.class.getResourceAsStream("/config.yml")

  • 路径中不能含盘符、file:// 或绝对文件系统路径
  • 路径区分大小写(尤其在 Linux 环境或 jar 包中)
  • 若文件在 src/main/resources 下(Maven 结构),它会被复制到 classpath 根,"/config.yml" 就能命中

返回 null 的常见原因和排查方式

getResourceAsStream 返回 null 不抛异常,容易静默失败。最常因为路径错、文件没进 classpath、IDE 缓存未刷新。

Livestream Script Generator
Livestream Script Generator

直播带货脚本:话术、节奏、互动、促单。适用于主播、电商运营、MCN机构。

下载
  • 确认文件确实在最终 classpath 中:解压生成的 jar,看 config.yml 是否在顶层目录
  • IntelliJ 用户注意:修改 resources 后需手动触发 Build → Rebuild Project,否则资源不会更新到 out/ 或 target/classes/
  • 用 MyClass.class.getResource("/config.yml") 先测试 URL 是否非 null,比直接拿流更易调试
  • Maven 多模块项目中,确保配置文件所在模块被正确依赖,且未被 过滤掉

配合 Properties 或 YAML 解析的典型用法

拿到 InputStream 后别忘了关流——但若用 try-with-resources,需注意流生命周期与解析逻辑是否匹配。

try (InputStream is = MyClass.class.getResourceAsStream("/app.properties")) {
    if (is == null) {
        throw new IllegalStateException("Missing resource: /app.properties");
    }
    Properties props = new Properties();
    props.load(is); // Properties.load() 内部不关闭流,由你负责
}
  • Spring Boot 中推荐用 @Value 或 ResourceLoader,而非手写 getResourceAsStream
  • 解析 YAML 时(如 SnakeYAML),传入 is 即可,但注意其 Yaml.load() 方法内部不消费完流,后续若重复读会失败
  • 流只能读一次,反复调用 getResourceAsStream 才能获取新流实例

ClassLoader.getResourceAsStream 和 Class.getResourceAsStream 的区别

二者行为高度相似,但默认类加载器策略不同:Class.getResourceAsStream(path) 相当于 Class.getClassLoader().getResourceAsStream(path),只是前者对不带 / 的路径做了包前缀拼接。

  • 显式使用 Thread.currentThread().getContextClassLoader().getResourceAsStream("/config.yml") 更适合框架代码(如 Servlet、Spring),避免因类加载器隔离导致找不到资源
  • 普通工具类中用 MyClass.class.getResourceAsStream 更直观、不易误用
  • 不要混用两者去“绕过”路径问题——根源还是路径写法和资源部署位置不一致

实际出问题时,90% 是路径写错了,或者以为文件在 classpath 却漏掉了构建步骤。先验证 getResource 返回的 URL 是否有效,再谈解析逻辑。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

stream 配置文件

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11917

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9002

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7712

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1264

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1008

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1516

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3109

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20371

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1375

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CentOS 官方文档
CentOS 官方文档

共0课时 | 0人学习

极客学院Java8新特性视频教程
极客学院Java8新特性视频教程

共17课时 | 4.3万人学习

Starlette官方配置指南
Starlette官方配置指南

共0课时 | 0人学习