【Spring】Resource接口：ClassPathResource

最新推荐文章于 2025-03-31 11:08:20 发布

sayyy

最新推荐文章于 2025-03-31 11:08:20 发布

阅读量3.9k

点赞数

分类专栏： spring 文章标签： spring spring boot java

本文链接：https://blog.csdn.net/sayyy/article/details/120028877

版权

spring 专栏收录该内容

35 篇文章

订阅专栏

本文详细介绍了如何在Spring Boot应用中使用ClassPathResource读取classpath中的文件，并通过示例展示了正确操作和常见错误案例。重点讲解了三种构造器的使用以及类路径资源的定位原理。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

java 1.8
springboot 2.5.4

ClassPathResource读取文件

ClassPathResource 表示从类路径获取资源，它使用线程上下文类加载器、给定的类加载器来加载资源。classpath 资源存在于类路径中的文件系统中或 jar 包里。

ClassPathResource 常用构造器

public ClassPathResource(String path);
public ClassPathResource(String path, @Nullable ClassLoader classLoader);
public ClassPathResource(String path, @Nullable Class<?> clazz);

public ClassPathResource(String path)：使用默认的类加载器记载 path 类路径下的资源
public ClassPathResource(String path, @Nullable ClassLoader classLoader)：使用指定的类加载器加载 path 类路径下的资源
public ClassPathResource(String path, @Nullable Class clazz)：只用指定的类加载 path 类路径下的资源

示例1：读取 classpath 中的文件（`1.txt`）

@SpringBootApplication
public class Demo1Application {

	public static void main(String[] args) {
		SpringApplication.run(Demo1Application.class, args);
	}
	
	@Bean
    public CommandLineRunner checkImage() {
    	return (args)->{
    		ClassPathResource cpr = new ClassPathResource("1.txt");
    		System.out.println("1.txt is exists : " + cpr.getFile().exists());
    	};
    }

}

项目目录结构

项目
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─example
│  │  │          └─demo
│  │  │              └─Demo1Application.java
│  │  └─resources
│  │     ├─application.properties
│  │     └─1.txt
│  └─test
└─pom.xml

执行结果

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.5.4)

2021-08-31 23:02:31.892  INFO 109456 --- [           main] com.example.demo.Demo1Application        : Starting Demo1Application using Java 1.8.0_144 on LAPTOP-F1O81IBU with PID 109456 (D:\sde\eclipse-workspace\demo-1\target\classes started by lhg in D:\sde\eclipse-workspace\demo-1)
2021-08-31 23:02:31.895  INFO 109456 --- [           main] com.example.demo.Demo1Application        : No active profile set, falling back to default profiles: default
2021-08-31 23:02:32.265  INFO 109456 --- [           main] com.example.demo.Demo1Application        : Started Demo1Application in 0.635 seconds (JVM running for 1.554)
1.txt is exists : true

示例2：找不到文件

代码与示例1一样。改变1.txt的位置（将文件移动到项目根目录）后，执行结果为：

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.5.4)

2021-08-31 22:54:57.996  INFO 113616 --- [           main] com.example.demo.Demo1Application        : Starting Demo1Application using Java 1.8.0_144 on LAPTOP-F1O81IBU with PID 113616 (D:\sde\eclipse-workspace\demo-1\target\classes started by lhg in D:\sde\eclipse-workspace\demo-1)
2021-08-31 22:54:57.997  INFO 113616 --- [           main] com.example.demo.Demo1Application        : No active profile set, falling back to default profiles: default
2021-08-31 22:54:58.372  INFO 113616 --- [           main] com.example.demo.Demo1Application        : Started Demo1Application in 0.616 seconds (JVM running for 1.517)
2021-08-31 22:54:58.375  INFO 113616 --- [           main] ConditionEvaluationReportLoggingListener : 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2021-08-31 22:54:58.391 ERROR 113616 --- [           main] o.s.boot.SpringApplication               : Application run failed

java.lang.IllegalStateException: Failed to execute CommandLineRunner
	at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:794) [spring-boot-2.5.4.jar:2.5.4]
	at org.springframework.boot.SpringApplication.callRunners(SpringApplication.java:775) [spring-boot-2.5.4.jar:2.5.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:345) [spring-boot-2.5.4.jar:2.5.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1343) [spring-boot-2.5.4.jar:2.5.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1332) [spring-boot-2.5.4.jar:2.5.4]
	at com.example.demo.Demo1Application.main(Demo1Application.java:13) [classes/:na]
Caused by: java.io.FileNotFoundException: class path resource [1.txt] cannot be resolved to URL because it does not exist
	at org.springframework.core.io.ClassPathResource.getURL(ClassPathResource.java:202) ~[spring-core-5.3.9.jar:5.3.9]
	at org.springframework.core.io.AbstractFileResolvingResource.getFile(AbstractFileResolvingResource.java:150) ~[spring-core-5.3.9.jar:5.3.9]
	at com.example.demo.Demo1Application.lambda$0(Demo1Application.java:20) [classes/:na]
	at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:791) [spring-boot-2.5.4.jar:2.5.4]
	... 5 common frames omitted