Swagger와 Tomcat에게 괴롭힘당한 썰

주노·2021년 10월 21일

2021 국방해커톤

목록 보기

3/3

서론

TMI👀
SpringBoot를 이용해서 Swagger 2.9.2를 적용한 프로젝트를 만들었고, 이를 빌드해서 Tomcat으로 배포를 하려고했다.
SpringBoot를 처음 써보고 모든 프로젝트를 IntelliJ에 의존하던 지난 날의 경험들로 군대 사지방 개발을 진행하기에는 너무 나약했다.
배포과정은 어렵지 않았지만 결과가 대참사였고 인생 첫 해커톤에서 가장 많은 시간을 들인게 Swagger 설정이 되었다...

mvn clean spring-boot:run으로 spring-boot 내장 서버로 구동할 때는 문제가 없었다.
하지만 빌드를 하고 Tomcat을 이용해 배포하려고 하니 아래와 같은 문제가 발생했다.

잘못된 원인을 모르니 아무리 검색을 해봐도 명확한 답이 나오질 않았다.

혹시몰라 지인들에게 질문찬스를 요청했지만... 답은 나오지 않았다

문제 인식

구글링

우선 모든 문제는 구글링으로 시작한다.

Config Class에 @EnableSwagger2 설정, 버전을 3.0.0으로 높이기, SpringSecurity와 설정 충돌 문제 등등 많은 해결방안이 있었지만 모두 나에게 해당되지 않는 해결방안이였다.

군대에서 약 3일간 개인정비시간을 소모해서 찾아봤지만 프로젝트 내 설정을 바꿔서 해결할 수 없었다.

Spring Boot에 대한 이해 부족이 화근이였다.

배포할때마다 mvn spring-boot:run을 계속 돌려주면 되긴 하겠지만 말도안되기 때문에 이 방법은 시도하고싶지도 않았다.

머리를 쥐어싸고 있는데 문득 눈에 보이는게 있었다.

Tomcat에 관련된 문제가있는게 아닐까??

해결과정

혹시 SpringBoot를 Tomcat에 배포하려면 뭔가 추가적인 설정이 필요한게 아닐까??

구글 검색 문구를 바꿨다.

Spring Boot Tomcat 배포

SpringApplicationBuilder 설정하기

Spiring Boot 는 기본적으로 jar 배포형태를 가지고 있다.
tomcat 같은 웹서버도, db 도 다 내장으로 가질 수 있는 형태이기 때문에, 독립적인 프로그램이다 라는 의미를 가지고 있다고 볼 수 있다.
war 파일은 웹 프로젝트, 즉 tomcat 과 같은 웹 서버 위에서 돌아가는 프로젝트라고 볼 수 있다.
참고 사이트

SpringApplicationBuilder를 상속하여 Tomcat같은 Servlet Container 환경에서 SpringBoot 로 작성한 애플리케이션이 작동 가능 하도록 구성할 수 있다.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class Application extends SpringBootServletInitializer {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

}

추가로 설정해줘야하는 것이 있다면 pom.xml에서 package를 war로 설정하고 dependency를 추가하는 것이 있다.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
                             http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>CSK</groupId>
    <artifactId>ROOT</artifactId>
    <version>1</version>
    <packaging>war</packaging>
    <name>API</name>
    <description>2021 Army Hacker Thon ArMeal</description>
  ...

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-tomcat</artifactId>
	<scope>provided</scope>
</dependency>
  ...

요약

SpringBoot에서 Tomcat과 같은 Container로 배포할 파일을 빌드하려면 SpringApplicationBuilder 설정을 해줘야한다.
설정할 때 pom.xml에서 packaging과 dependency도 추가해줘야한다.
해당 Swagger 오류는 복합적인 원인으로 설정이 꼬일 경우 발생하는 것 같다.
마치 공부 초기에 마주했던 NullpointerException 같은놈이다...

후기

Swagger와 Tomcat에게 괴롭힘당했다고했지만 정작 SpringBoot가 범인이였다.
~~사실 기본기가 없는 내가 잘못이지~~😂

기존에 Spring 3로 개발할때 web.xml을 포함한 초기설정을 맞추는데만 시간을 많이 소모했었는데 SpringBoot에서는 이러한 설정들이 많이 생략되었다.

TMI👀
Servlet 3.0이상의 버전에서 web.xml없이 배포가 가능해졌고, Tomcat 7.0 이상의 버전부터 Servlet 3.0을 지원한다고 한다.
web.xml 역할을 WebApplicationInitializer 인터페이스를 구현하여 프로그래밍적으로 ServletContext에 Spring IoC 컨테이너를 생성하여 추가할 수 있다고 한다.
참고 사이트

Spring 3로만 개발을 시도해왔던 나로서는 이거 너무 편리한거같다...