[springboot] 2.0 을 사용하면서 패키징과 관련된 문제가 발생한다면

스프링 부트 2.0 을 사용하면서 패키징과 관련된 찝찝한 느낌을 받고 있는 요즘이다.

그 주요 원인은 스프링 부트 그레이들 플러그인 2.0 때문이다. 스프링 부트 그레이들 플러그인 2.0이 되면서 기존에 있던 bootRepackage가 bootJar와 bootWar 으로 변경(Spring Boot’s new Gradle plugin)되면서 부터다.

실행가능한 jar와 war를 만드는데 사용했던 bootRepackage를 배포파일에 따라서 각각 Jar는 bootJar와 War는 bootWar로 확장하는 과정에서 이런 상황이 발생했다.

핵심요점만 이야기하자면 bootJar와 bootWar를 비활성화하면 패키징 태스크가 실행되지 않는다.

//bootJar 비활성화시
bootJar.enabled = false
jar.enabled = true

//bootWar 비활성화시
bootWar.enabled = false
war.enabled = true

위와 같은 형태로 상위 태스크를 활성화시켜줘야지만 패키징 태스크가 실행된다. 이러한 사실을 알게된 것은

가 있었고, 오늘은 EBS(AWS Elastic Beanstalk)에서 "구성 파일(.ebextensions)을 사용하여 고급 환경 사용자 지정" 기능을 사용하기 위해서 프로젝트 내에 .ebextensions 디렉터리를 war 파일 패키징시 이동하기 위해 그레이들내에서 다음과 같이 선언했는데 .ebextensions 디렉터리가 패키징에서 누락된 것을 발견했다.

build.gradle
project(":api-module") {
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'
    apply plugin: 'war'

    war {
        from('./src/main/ebextensions') {
            into('.ebextensions')
        }
    }

    dependencies {
        compile project(":core-module")

        compile('org.springframework.boot:spring-boot-starter-data-rest')
        compile('org.springframework.boot:spring-boot-starter-hateoas')
        compile('org.springframework.boot:spring-boot-starter-web-services')
        compile('org.springframework.boot:spring-boot-starter-webflux')
        compile('org.springframework.data:spring-data-rest-hal-browser')

        compileOnly "org.springframework.boot:spring-boot-configuration-processor"

        testCompile('org.springframework.boot:spring-boot-starter-test')
        testCompile('io.projectreactor:reactor-test')
    }
}

위와 같이 모듈을 정의했는데, war 태스크를 정의한 부분이 무시됐다. (이런!!)

하지만 그렇다고 분노하거나 노여워하지 말자(그건 내가 다 했으니…​).

여기서 대응할 수 있는 방법은 크게 2가지가 있다.

  • 새로추가된 booWar 태스크를 사용하는 경우

  • 기존 war 태스크를 유지하는 경우

Note

스프링 부트를 기반으로 할 때는 실행가능하게 패키징(Repackaging)을 하는 bootJar와 bootWar를 사용한다고 생각하면 마음의 평화가 찾아올 듯 하다.

추천방법: 새로 추가된 booWar 태스크를 사용하는 경우

project(":api-module") {
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'
    apply plugin: 'war'

    bootWar {
        from('./src/main/ebextensions') {
            into('.ebextensions')
        }
    }

    dependencies {
        compile project(":core-module")

        compile('org.springframework.boot:spring-boot-starter-data-rest')
        compile('org.springframework.boot:spring-boot-starter-hateoas')
        compile('org.springframework.boot:spring-boot-starter-web-services')
        compile('org.springframework.boot:spring-boot-starter-webflux')
        compile('org.springframework.data:spring-data-rest-hal-browser')

        compileOnly "org.springframework.boot:spring-boot-configuration-processor"

        testCompile('org.springframework.boot:spring-boot-starter-test')
        testCompile('io.projectreactor:reactor-test')
    }
}

기존 war 태스크를 유지하는 경우

Note

톰캣과 같은 WAS에 war 파일을 배포한다면 실행가능하게 패키징을 필요로 하지 않으니 bootWar를 비활성화 하자.

 
project(":api-module") {
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'
    apply plugin: 'war'

    bootWar.enabled = false // (1)
    war.enabled = true  // (2)

    war {
        from('./src/main/ebextensions') {
            into('.ebextensions')
        }
    }

    dependencies {
        compile project(":core-module")

        compile('org.springframework.boot:spring-boot-starter-data-rest')
        compile('org.springframework.boot:spring-boot-starter-hateoas')
        compile('org.springframework.boot:spring-boot-starter-web-services')
        compile('org.springframework.boot:spring-boot-starter-webflux')
        compile('org.springframework.data:spring-data-rest-hal-browser')

        compileOnly "org.springframework.boot:spring-boot-configuration-processor"

        testCompile('org.springframework.boot:spring-boot-starter-test')
        testCompile('io.projectreactor:reactor-test')
    }
}

  1. bootWar를 비활성화한다.

  2. war를 활성화한다.

정리

  • 기술을 사용할 때는 참고문서를 보자.

참고문헌

view raw 20180712_spring_boot_gradle_plugin.asc hosted with ❤ by GitHub
저작자표시 (새창열림)

'Java > SpringBoot' 카테고리의 다른 글

[springboot] T Acacemy 교육자료 1/3:: 스프링 부트 소개 Boot Spring Boot  (0) 2018.09.27
[springboot] Boot Spring Boot! 북콘서트  (0) 2018.08.17
Boot Spring Boot: 스프링 부트 참고서  (0) 2018.07.09
[springboot] 그레이들 플러그인 bootJar.enabled=false 처리 후 jar 파일 생성이 안된다면!  (0) 2018.07.02
Spring Boot 1.5.15, 2.0.3 출시, 롬복(lombok) 1.16.22 관련 내용  (0) 2018.06.15

스프링부트만 믿고 개발에 정진해왔다. 그러다가 시연해야할 떄가 되어 젠킨스를 통해서 개발서버에 빌드-배포된 war 파일을 실행하여 테스트하려고 하니 Thymeleaf template engine에서 template file 을 찾지못하는 문제가 발생했다.

이 문제가 왜 생기는지를 고민하고 검색해봐도 별다른 내용을 찾을 수가 없었다.

스프링부트 튜토리얼을 살펴보다가, 컨트롤러 영역에서 조금 다른 차이점을 찾아냈다.

@Controller
public class TestController {

    @RequestMapping("/test")
    public String test() {
        return "test";
    }
}

문제가 발생하는 화면의 컨트롤러에서는

@Controller
public class TestController {

    @RequestMapping("/test")
    public String test() {
        return "/test";
    }
}

와 같은 형태로 정의가 되어 있는 것이다.

차이를 발견했는가???

저 문제를 찾지 못해서 헤매였다. 1시간여를…. 흙… Orz…

해결방법

return "/test"; 을 return "test"; 으로 정의하면 된다.
bootRepackage로 빌드된 애플리케이션 배포본은 경로에 민감하게 반응하는 것으로 보인다.

저 ‘/‘ 때문에 ‘/test’ 에 대한 접근이 아니라 ‘//test’로 처리하기 때문에 나타나는 문제가 아닐까 추측해본다.

저작자표시 (새창열림)

'Java > SpringBoot' 카테고리의 다른 글

SpringBoot(v1.2.3): FlywayDB 관련 설정 오류(레퍼런스 가이드와 다름)  (0) 2015.04.22
SpringBoot: JavaMailSender를 이용한 메일발송기능 구현  (0) 2015.04.13
배너banner 변경하기  (0) 2015.03.12
스프링부트 1.2.0 새로운 애노테이션, @SpringBootApplication  (0) 2015.01.20
Sevlert 3.x, Spring MVC MultipartFile를 이용한 업로드가 되지 않는 경우  (4) 2015.01.19

+ Recent posts

티스토리툴바