Spring Boot 로컬 환경에서 정적 리소스 리로드 하기

로컬 환경에서 정적 리소스 리로드 하기

개요

우테코 레벨 2를 진행하면서 웹 페이지, 특히 js를 많이 작성하게 됐습니다.

그러다 보니 정적 파일(특히 js)을 수정하면 Spring boot에서 실행중이던 app을 재시작해서
수정된 정적 정보를 다시 불러와야 했습니다.

Spring devtools 의존성을 추가해서 리로드 하는 방식이 있지만
빌드 속도가 느려지고 개발환경 외에 사용되지 않는 의존성을 추가하고 싶지 않았습니다.

게다가 필자는 설정해도 됐다 안됐다 하네요;;

얼마전 WebMvcConfigurer에서 resourceHandler를 다뤘는데
이를 이용하면 간단하게 해결이 된다는 것을 알게되어 공유하고자 합니다.

바라보는 정적 리소스의 위치 수정하기

아래는 이전에 작성한 classpath 아래의 자원을 바라보고 있는 설정입니다.

@Configuration
public class MvcConfiguration implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(final ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/templates/", "classpath:/static/")
                .setCacheControl(CacheControl.maxAge(10, TimeUnit.MINUTES));
    }
}

이때 classpath는 gradle로 빌드한 결과의 resources 디렉토리(ex. build/resources)를 의미합니다.

이제 file 키워드를 이용해 바라보고 있는 디렉토리를 아래와 같이 src/main/resources로 변경해 주도록 합니다.

@Configuration
public class MvcConfiguration implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(final ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("file:src/main/resources/templates/", "file:src/main/resources/static/");
    }
}

이렇게 하면 매번 Spring boot를 재시작하지 않아도 정적 자원이 즉시 수정되는 것을 확인할 수 있습니다.

프로파일을 이용해 분리하기

Spring boot는 profile 별로 다른 설정을 가지고 실행을 할 수 있습니다.

현재 코드는 언제나 file:src/main/resources/ 를 바라보고 있습니다.
실제 서비스 환경에서는 다시 classpath:를 바라보아야 합니다.

이를 위해서 profile을 이용해 환경 설정을 분리해 주도록 합시다. local 환경에서는 file: 을, prod 환경에서는 classpath: 를 바라보도록 해 보겠습니다.

Inner Class 활용하기

먼저 Inner Class 를 두개 만들어 주도록 합시다.

하나는 prod 환경에서 사용할 클래스이고 다른 하나는 local 환경에서 사용할 클래스 입니다.

@Configuration
public class MvcConfiguration {

    @Profile("prod")
    @Configuration
    public static class ProdMvcConfiguration {

    }

    @Profile("local")
    @Configuration
    public static class LocalMvcConfiguration {

    }

}

@Profile("환경이름")으로 해당 환경에 대한 이름을 정해주도록 합니다.

이어서 각각 WebMvcConfigurer 를 implements 해주고
각 환경에 알맞게 resourceHandler를 작성해 주도록 합니다.

@Configuration
public class MvcConfiguration {

    @Profile("prod")
    @Configuration
    public static class ProdMvcConfiguration implements WebMvcConfigurer {

        @Override
        public void addResourceHandlers(final ResourceHandlerRegistry registry) {
            registry.addResourceHandler("/**")
                    .addResourceLocations("classpath:/templates/", "classpath:/static/")
                    .setCacheControl(CacheControl.maxAge(10, TimeUnit.MINUTES));
        }
    }

    @Profile("local")
    @Configuration
    public static class LocalMvcConfiguration implements WebMvcConfigurer {

        @Override
        public void addResourceHandlers(final ResourceHandlerRegistry registry) {
            registry.addResourceHandler("/**")
                    .addResourceLocations("file:src/main/resources/templates/", "file:src/main/resources/static/");
        }
    }

}

위와 같이 환경에 따라 분리가 끝났다면 환경을 선택해서 Spring boot를 실행하면 됩니다.

application.properties 혹은 .yml에서 사용할 prod환경을 활성화 시켜주도록 합시다.

.properties

spring.profiles.active=prod

.yml

spring:
  profiles:
    active: prod

이렇게 했을때, JVM 옵션으로 acitve 값을 주지 않으면, Spring boot를 build 하여 생성되는 jar가 실행될 때 prod 환경으로 실행됩니다.

하지만 우리는 개발할 때 local 환경에서 실행하기를 원합니다.
아래와 같이 IntelliJ에서 JVM 옵션을 설정하고 Spring boot를 실행하도록 합시다.

이렇게 하면 jar 파일을 실행할 때 -Dspring.profiles.active=local 옵션을 주고 실행한 것과 같습니다.

맺으며

더 좋은 방법이 있으면 피드백 부탁드리겠습니다!

감사합니다.