Spring – Read file from resources folder

By mkyong | Updated: April 10, 2019

Viewed: 34,986 (+190 pv/w)

Tags: resources spring

In Spring, we can use ClassPathResource or ResourceLoader to get files from classpath easily.

P.S Tested with Spring 5.1.4.RELEASE

1. src/main/resources/

For example, an image file in the src/main/resources/ folder

2. ClassPathResource

import org.springframework.core.io.Resource;
import org.springframework.core.io.ClassPathResource;

import java.io.File;
import java.io.InputStream;

	Resource resource = new ClassPathResource("android.png");

	InputStream input = resource.getInputStream();

	File file = resource.getFile();

3. ResourceLoader

import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;

import java.io.File;
import java.io.InputStream;


	@Autowired
    ResourceLoader resourceLoader;
	
	Resource resource = resourceLoader.getResource("classpath:android.png");

	InputStream input = resource.getInputStream();

	File file = resource.getFile();

4. ResourceUtils

Please DO NOT use this ResourceUtils even it works, this class is mainly for internal use within the framework. Read the ResourceUtils JavaDocs

import org.springframework.util.ResourceUtils;

	File file = ResourceUtils.getFile("classpath:android.png");

References

• ClassPathResource JavaDocs
• ResourceLoader JavaDocs
• ResourceUtils JavaDocs
• Java – Read a file from resources folder