Java 中怎么读取类路径下的配置文件

风萱同学_7472

风萱同学_7472

2026-10-27

642人浏览

原创

推荐使用 ClassLoader.getResourceAsStream() 或 Class.getResourceAsStream() 读取 classpath 下配置文件,前者适用于根路径资源如 config.properties,后者支持同包或绝对路径;务必判空并用 try-with-resources 关闭流,避免转 File 或误用 new File。

java 中怎么读取类路径下的配置文件

Java 中读取类路径(classpath)下的配置文件,最常用且推荐的方式是使用 ClassLoader.getResourceAsStream() 或 Class.getResourceAsStream(),它们能正确处理打包在 JAR/WAR 中的资源,避免路径硬编码和平台差异问题。

用 ClassLoader 读取 classpath 根目录下的文件

适用于配置文件(如 config.properties、logback.xml)放在 src/main/resources 下的情况:

  • 确保文件已编译/打包到 classpath 根路径(即最终出现在 target/classes/ 或 JAR 包顶层)
  • 使用 Thread.currentThread().getContextClassLoader().getResourceAsStream("config.properties")
  • 返回的是 InputStream,可直接传给 Properties.load() 或 XMLInputFactory 等解析器

示例:

sc-java-to-ts-interface
sc-java-to-ts-interface

将后端 Java 接口文档转换为前端 TypeScript 类型定义(interface / type)。输入:飞书文档、Spring Boot 接口文档、Swagger/OpenAPI、手写 API 文档等。输出:包含请求参数与响应结果的 .md 文件,含完整 JSDoc 注释。触发关键词:Java 转 TS、接口转换、生成前端类型、接口文档转 TypeScript、DTO/VO/BO 转 interface、后端文档转前端类型、生成接口类型、类型定义生成。

下载
InputStream is = Thread.currentThread().getContextClassLoader()
    .getResourceAsStream("application.yml");
if (is != null) {
    // 使用 Jackson / SnakeYAML 解析...
}

用 Class 读取同包或相对路径下的文件

当配置文件与某个类在相同包下,或想用相对路径定位时:

  • MyClass.class.getResourceAsStream("config.json"):查找同包下的 config.json
  • MyClass.class.getResourceAsStream("/conf/db.properties"):从 classpath 根开始查(开头斜杠表示绝对路径)
  • 注意:getClass().getResourceAsStream("") 返回当前类所在包的 URL,末尾带斜杠

读取后如何安全使用 InputStream

务必检查流是否为 null,并用 try-with-resources 自动关闭:

  • classpath 资源在 JAR 中时,InputStream 不支持 mark/reset 和 skip,避免调用这些方法
  • 不要尝试转成 File 对象(JAR 内资源没有真实文件路径),否则会抛 NullPointerException 或 IllegalArgumentException
  • 若需转为字符串,可用 new String(is.readAllBytes(), StandardCharsets.UTF_8)(Java 9+)

常见错误与规避方式

  • 错用 new File("xxx.properties"):工作目录不等于 classpath,本地可能偶然成功,上线必失败
  • 路径写成 "src/main/resources/config.properties":编译后该路径不存在,应只写运行时路径(如 "config.properties")
  • 忽略空流判断:文件名拼错或未放入 resources 目录时,getResourceAsStream 返回 null,直接使用会 NPE
  • 用 Class.getResource() 返回 URL 再转 File:对 JAR 包内资源无效,URL 协议可能是 jar:,无法构造合法 File

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java 配置文件

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

相关专题

更多
java
java

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

2023.06.15

11317

6

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

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

2023.07.05

8422

9

java自学难吗
java自学难吗

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

2023.07.31

7272

8

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

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

2023.08.01

1204

3

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

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

2023.08.02

988

3

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

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

2023.08.02

1456

5

java有什么用
java有什么用

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

2023.08.02

2989

5

java在线网站
java在线网站

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

2023.08.03

20231

3

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

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

2023.08.03

1315

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习