SpringBoot: 리소스 관리하기 (resource)

 

 

스프링 부트는 내부적으로 리소스를 어떻게 로딩할까?

📌 서론

길을 걸어가던 도중 스프링, 스프링부트에서는 어떻게 application.yml이나 js, css 같은 파일들을 읽어 들여서 사용하는지에 대한 궁금증이 생겼다. 그래서 당장 조사를 했고 이를 정리해 봤다. 지금부터 그 내용을 공유한다.

 

1. 리소스 로딩의 중요성과 기본 개념

스프링 어플리케이션의 성능과 개발 효율성 향상을 위해서는 다양한 외부 리소스(파일, 이미지 등)를 효율적으로 로딩하는 것이 중요하다. Resource 인터페이스는 다양한 리소스 유형에 대해 일관된 API를 제공하며, 리소스 존재 여부 확인, 파일/URL 접근 등 다양한 기능을 제공한다.

 

리소스 로딩의 중요성

• 스프링 어플리케이션에서 리소스 로딩은 핵심적인 부분이다. 외부 리소스(텍스트 파일, XML 파일, 프로퍼티 파일, 이미지 파일 등)를 효율적으로 읽어 들이는 것은 스프링 애플리케이션의 성능과 개발 효율성에 큰 영향을 미친다. 이러한 리소스들은 파일 시스템, 클래스패스, URL 등 다양한 위치에 존재할 수 있으며, 이들을 적절히 관리하는 것이 중요하다.
  
  

스프링의 Resource 인터페이스

• Resource 인터페이스는 외부 리소스를 추상화하고 일관된 API를 제공한다. 이 인터페이스는 InputStreamSource를 확장하며, 리소스가 실제로 존재하는지(exists()), 열려 있는 상태인지(isOpen()), URL이나 파일로의 접근(getURL(), getFile()), 상대 경로 리소스 생성(createRelative()) 등 다양한 기능을 제공한다.
  
  

리소스 유형

• 스프링은 여러 구현체를 통해 다양한 리소스 유형을 지원한다. URLResource는 URL에서 로드된 리소스, ClassPathResource는 클래스패스에서 로드된 리소스, FileSystemResource는 파일 시스템에서 로드된 리소스, ServletContextResource는 ServletContext 리소스(웹 애플리케이션의 루트 디렉터리 내 상대 경로) 등을 나타낸다.

 

2. 스프링 부트는 리소스 로딩을 어떻게 사용하는가?

스프링 부트는 application.properties, 정적 리소스 서빙, 내장 서블릿 컨테이너와 클래스패스 리소스 관리 등을 통해 리소스 로딩을 자동화하고 개발자의 편의성을 극대화한다.

 

자동화된 설정 파일 로딩

• 스프링 부트는 application.properties와 application.yml 파일을 자동으로 로드하여 어플리케이션 구성을 용이하게 한다. 이 파일들에 설정 값을 정의하기만 하면, 스프링 부트가 어플리케이션을 알맞게 구성한다.
  
  

정적 리소스 자동 서빙

• /static, /public, /resources, /META-INF/resources 디렉터리에 배치된 정적 리소스들은 스프링 부트에 의해 자동으로 서빙된다. 웹 어플리케이션 개발 시, 이러한 리소스들은 클라이언트에게 자동으로 제공된다.
  
  

내장 서블릿 컨테이너와의 리소스 관리

• 스프링 부트는 내장 서블릿 컨테이너를 사용하여 웹 리소스를 자동으로 관리한다. Tomcat, Jetty, Undertow 등이 제공하는 복잡한 설정 없이도 웹 리소스를 쉽게 관리할 수 있다.
  
  

클래스패스 리소스 자동 감지

• 스프링 부트는 클래스패스 상의 리소스를 자동으로 감지하고 로드한다. 복잡한 리소스 로드 메커니즘을 직접 구현할 필요 없이, 스프링 부트가 필요한 리소스를 적절히 로드한다.
  
  

실무에서의 적용 사례

리소스 템플릿 로딩

• 이메일 템플릿, PDF 템플릿 등을 ClassPathResource나 FileSystemResource를 통해 로드한다. 이는 사용자에게 동적 컨텐츠를 제공하는데 활용된다.
  
  

API 데이터 로드

• URLResource를 통해 외부 API로부터 JSON이나 XML 데이터를 가져오고 처리한다. 실시간으로 외부 데이터를 통합하는데 유용하다.
  

 

3. ResourceLoader와 ClassPathResource 로딩 알아보기

ResourceLoader는 다양한 리소스 타입에 일관된 접근을 제공하고, ClassPathResource는 클래스패스 상의 리소스 로딩에 특화되어 있다.

 

리소스 로더 (ResourceLoader)

• ResourceLoader는 스프링과 스프링 부트에서 리소스 로딩을 단순화하는 핵심 도구다. 이 인터페이스는 어플리케이션의 다양한 리소스 유형과 위치에 대한 일관된 접근 방식을 제공한다. 예를 들어, 스프링 부트 어플리케이션에서 설정 파일, 로그 파일, 그리고 다른 외부 리소스를 로드할 때 특히 유용하다.
  
  

ResourceLoader 사용 예시 - 리소스 로딩

• ResourceLoader는 리소스의 실제 유형과 상관없이 리소스를 로드할 수 있게 해주기 때문에 개발자의 작업을 간소화한다. 이 인터페이스를 사용하면, 파일 시스템 리소스, 클래스패스 리소스, URL 리소스 등을 쉽게 처리할 수 있다.

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

@RequiredArgsConstructor
@Component
public class ResourceLoaderExample {

    private final ResourceLoader resourceLoader;

    public void loadResource(String path) {
    
        Resource resource = resourceLoader.getResource(path);
        // 리소스와 관련된 작업 수행
    }
    
}

• 이 코드에서 ResourceLoader는 주입되어 주어진 경로의 리소스를 로드하는데 사용된다. getResource() 메소드는 다양한 유형의 리소스를 처리할 수 있는 다형성을 제공한다.
  

 

ResourceLoader 사용 예시 - 동적 리소스 로딩

• 사용자의 요청에 따라 다양한 이미지나 설정 파일을 동적으로 로드하는 경우. 예를 들어, 사용자 프로필에 따라 다른 이미지를 보여주는 기능을 구현할 수 있다.
• 이 서비스는 주어진 경로의 리소스(이미지, 설정 파일 등)를 바이트 배열로 로드하여 반환한다.

@RequiredArgsConstructor
@Service
public class DynamicResourceLoaderService {

    private final ResourceLoader resourceLoader;

    public byte[] loadResourceAsBytes(String path) throws IOException {
    
        Resource resource = resourceLoader.getResource(path);
        return Files.readAllBytes(resource.getFile().toPath());
    }
    
}

 

클래스패스 리소스 로딩 (ClassPathResource)

• ClassPathResource는 스프링 부트에서 특히 중요한 클래스로, 클래스패스 상에 있는 리소스를 로딩하는 데 사용된다. 이는 설정 파일, XML 구성 파일, 프로퍼티 파일과 같은 리소스를 로드하는 데 유용하다.

 

ClassPathResource 사용 방법1 - 어플리케이션 설정 로드

• 클래스패스 리소스 로딩은 스프링 부트 어플리케이션에서 자주 사용되는 작업이다. 예를 들어, 어플리케이션의 설정 파일이나 프로퍼티를 로드하는 경우에 매우 효과적이다.
• 이 코드는 ClassPathResource를 사용하여 클래스패스 상의 리소스를 찾고 로드하는 방법을 보여준다. 스프링 부트 어플리케이션 개발에서 이런 방식으로 클래스패스 리소스를 쉽게 처리할 수 있다.

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

public class ClassPathResourceExample {

    public void loadClassPathResource(String path) {
    
        Resource resource = new ClassPathResource(path);
        // 클래스패스 리소스와 관련된 작업 수행
    }
}

 

ClassPathResource 사용 방법2 - 초기화 데이터 및 설정 로딩

• 어플리케이션 시작 시 필요한 초기화 데이터나 설정을 로드하는 경우. 예를 들어, 어플리케이션 구동에 필요한 기본 설정 파일이나 데이터를 로드하는 기능을 구현할 수 있다.
• 이 메서드는 클래스패스 상의 initial-data.json 파일을 로드하여 문자열로 변환한다. 이 데이터는 어플리케이션 초기화 시 사용될 수 있다.

public class InitializationDataService {

    public void loadInitializationData() throws IOException {
    
        Resource resource = new ClassPathResource("config/initial-data.json");
        String data = new String(Files.readAllBytes(resource.getFile().toPath()));
        // 이후 데이터 처리 로직
    }
    
}

 

 

4. 파일 시스템과 웹 환경에서의 리소스 로딩 알아보기

FileSystemResource는 로컬 파일 시스템 리소스에 접근하는 데 사용되며, ServletContextResource는 웹 환경의 리소스 관리에 적합하다.

 

파일 시스템 리소스 로딩 (FileSystemResource)

• FileSystemResource는 로컬 파일 시스템에서 데이터 파일, 로그 파일, 설정 파일 등에 접근할 때 사용된다. 개발 또는 테스트 환경에서 특히 유용하다.

 

1. FileSystemResource - 실무 예시

• 로그 파일 관리: 어플리케이션 로그 파일을 로드하고 분석하는 경우에 FileSystemResource를 사용할 수 있다.
• 구성 파일 로드: 테스트 환경에서 특정 구성 파일을 로드하는 데 사용된다.
• 이 코드는 로컬 파일 시스템에 위치한 리소스를 찾고 로드하는 방법을 보여준다. 이를 통해 스프링 부트 어플리케이션에서 로컬 리소스를 효과적으로 활용할 수 있다.

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

public class FileSystemResourceExample {

    public void loadFileSystemResource(String path) {
    
        Resource resource = new FileSystemResource(path);
        // 파일 시스템 리소스와 관련된 작업 수행
    }
    
}

2. FileSystemResource - 파일 처리 예시

• 사용자가 업로드한 파일을 서버의 특정 디렉토리에 저장하고, 이를 나중에 읽어 들이는 경우.
• 이 클래스는 파일 경로를 받아 해당 파일의 내용을 읽어오거나, 파일에 내용을 저장하는 메서드를 제공한다.

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

import java.io.IOException;
import java.nio.file.Files;

public class UserFileService {

    public String readFileContent(String filePath) throws IOException {
        Resource resource = new FileSystemResource(filePath);
        return new String(Files.readAllBytes(resource.getFile().toPath()));
    }

    public void saveFileContent(String filePath, byte[] content) throws IOException {
        Files.write(new FileSystemResource(filePath).getFile().toPath(), content);
    }
    
}

 

웹 환경에서의 리소스 로딩 (ServletContextResource)

• ServletContextResource는 웹 애플리케이션의 컨텍스트 경로에 있는 리소스에 접근할 때 사용된다. HTML, CSS, JavaScript 파일과 같은 정적 리소스 관리에 적합하다.

 

1. ServletContextResource 사용 방법

• 웹 애플리케이션 리소스 관리: 웹 페이지에 필요한 이미지, 스타일 시트, 스크립트 파일을 로드하는 데 사용된다.
• 템플릿 리소스 로드: 프론트엔드 템플릿 파일을 로드하고 렌더링 하는 데 사용된다.
• 이 코드는 웹 애플리케이션의 컨텍스트 경로에 있는 리소스를 찾고 로드하는 방법을 보여준다. 웹 애플리케이션에서 정적 리소스를 관리하는 데 이 방법이 매우 유용하다.

import org.springframework.web.context.support.ServletContextResource;
import javax.servlet.ServletContext;

@RequiredArgsConstructor
@Component
public class ServletContextResourceExample {

    private final ServletContext servletContext;

    public void loadServletContextResource(String path) {
    
        ServletContextResource resource = new ServletContextResource(servletContext, path);
        // 웹 환경 리소스와 관련된 작업 수행
    }
    
}

2. ServletContextResource를 사용한 웹 리소스 관리

• 웹 애플리케이션에서 정적 리소스(예: 이미지, CSS 파일)를 관리하는 경우.

import org.springframework.web.context.support.ServletContextResource;
import javax.servlet.ServletContext;

@RequiredArgsConstructor
@Component
public class WebResourceService {

    private final ServletContext servletContext;

    public byte[] loadResource(String resourcePath) throws IOException {
        ServletContextResource resource = new ServletContextResource(servletContext, resourcePath);
        return Files.readAllBytes(resource.getFile().toPath());
    }
    
}

 

 

5. 리소스 패턴 해석 및 캐싱 전략 알아보기

PathMatchingResourcePatternResolver는 리소스 패턴 해석에 유용하며, 리소스 캐싱 전략은 성능 향상을 위해 중요하다.

 

리소스 패턴 해석 (PathMatchingResourcePatternResolver)

• athMatchingResourcePatternResolver는 스프링 부트에서 리소스 패턴을 해석하고, 여러 리소스에 대한 접근을 단순화하는 데 사용되는 도구다. 와일드카드(*)를 사용하여 정의된 패턴에 맞는 모든 리소스를 로드할 수 있다. 이 기능은 어플리케이션의 구성 파일이나 리소스 집합을 다룰 때 특히 유용하다.
  
  

1. PathMatchingResourcePatternResolver 사용 예시 - 구성 파일 일괄 로드

• 개발자는 PathMatchingResourcePatternResolver를 사용하여 리소스의 위치나 유형에 구애받지 않고 유연하게 리소스를 로드할 수 있다. 
• 이 코드는 config 디렉토리 내의 모든 .properties 파일을 로드한다.

import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import java.io.IOException;

public class ConfigurationLoader {

    public void loadAllProperties() throws IOException {
    
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        Resource[] resources = resolver.getResources("classpath*:config/*.properties");

        for (Resource resource : resources) {
            // 각 리소스에 대한 처리, 예: Properties 객체로 로드
        }
        
    }
    
}

2. PathMatchingResourcePatternResolver 사용 예시 - 템플릿 파일 로드 예시

• 이 코드는 templates/email 디렉토리 내의 모든 .html 이메일 템플릿 파일을 로드한다.

import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import java.io.IOException;

public class TemplateLoader {

    public void loadEmailTemplates() throws IOException {
    
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        Resource[] resources = resolver.getResources("classpath*:templates/email/*.html");

        for (Resource resource : resources) {
            // 각 템플릿 리소스 처리, 예: 템플릿 엔진으로 렌더링
        }
    }
    
}

 

리소스 캐싱 전략

• 리소스 로딩 시 캐싱은 성능을 향상시키는 중요한 전략이다. 특히 스프링 부트 어플리케이션에서 자주 사용되는 리소스를 캐싱함으로써 응답 시간을 줄이고 성능을 개선할 수 있다.
  

 

1. 리소스 캐싱 전략 사용 예시 - 이미지 캐싱

• 이 클래스는 이미지 파일을 캐시에 저장하고, 필요할 때 캐시된 이미지를 반환한다.

import org.springframework.core.io.Resource;

import java.util.HashMap;
import java.util.Map;

public class ImageCache {

    private Map<String, Resource> cache = new HashMap<>();

    public Resource getImage(String path) {
    
        if (!cache.containsKey(path)) {
            // 이미지 리소스 로드 및 캐시에 저장
            // 예: new FileSystemResource(path)
        }
        
        return cache.get(path);
    }
    
}

 

2. 리소스 캐싱 전략 사용 예시 - 구성 데이터 캐싱

• 이 클래스는 구성 데이터 파일을 캐시에 저장하고, 필요할 때 캐시된 데이터를 반환한다.

import org.springframework.core.io.Resource;
import java.util.HashMap;
import java.util.Map;

public class ConfigurationCache {

    private Map<String, Resource> cache = new HashMap<>();

    public Resource getConfiguration(String path) {
    
        if (!cache.containsKey(path)) {
            // 구성 데이터 리소스 로드 및 캐시에 저장
            // 예: new FileSystemResource(path)
        }
        
        return cache.get(path);
    }
    
}

 

 

📌 서론

스프링에서 리소스 로딩을 어떻게 사용하는지 알아봤다. 이렇게 정리하면서 공부하니 더 확실하게 리소스 로딩에 대해 알게 되었으며 내부적으로도 다양하게 사용할 수 있는 방법이 있다는 것을 배웠다.

 

 

자바 리플렉션이 궁금하다면?👇🏻👇🏻

자바 리플렉션(Java Reflection)이란?

 

출처

Working with Resources in Spring - Spring Framework Guru

Spring Boot loading resources

시간이 괜찮다면 팀원 '평양냉면7'님의 블로그도 한번 봐주세요 :)

하다보니 재미있는 개발