로컬에서 Smart Tomcat으로 Spring 프로젝트 띄우는 방법

개요

• 회사에서 사용하는 Spring 서버를 개발하면서 테스트를 하기위해 로컬에서 웹서버를 띄워야 하는데, Spring Boot가 아니기 때문에 Tomcat이 내장되어 있지 않음
• 외부에서 개발한 후 도입한 프로그램인데, 개발 당시에는 IntelliJ Ultimate 버전을 사용했는지 내장된 Tomcat을 활용한 구축 방법이 안내 되어있음
• 개발 서버에서도 IntelliJ Ultiamte 버전이 존재하긴 하지만, 너무 오래된 버전인 탓에 Kotlin에 대한 지원이 미흡할 것이라고 판단해서 외부에서 최신 커뮤니티 버전을 들여와서 개발을 진행
• 로컬에서 테스트를 하기 위해 Smart Tomcat이란 플러그인을 사용해서 서버를 띄우는 작업을 진행

진행 방법

준비물

• IntelliJ CE 아무 버전
• Smart Tomcat Plugin
• Tomcat ≤ 8.5

Tomcat 설치

아래의 링크로 Tomcat 클라이언트 다운로드

https://tomcat.apache.org/download-80.cgi

Apache Tomcat® - Apache Tomcat 8 Software Downloads

Smart Tomcat 설치

인터넷 환경에서는 IntelliJ의 Settings - Plugins에서 Smart Tomcat 플러그인 설치

Smart Tomcat 플러그인 Run Configuration

세 가지 Run Configuration(구성)이 필요

1. Maven을 통해 프로젝트를 패키징을 하는 구성 (Install)
2. Maven을 통해 프로젝트를 패키징한 후, 생성되는 war 파일을 Tomcat 서버로 띄우는 구성 (Install then Run)
3. 이미 생성이 완료된 war 파일을 Tomcat 서버로 띄우는 구성 (Run)
   1. 2가 가끔 실패할 때 다시 컴파일 하는 시간을 절약하기 위해 사용하는 구성

새로운 구성을 만드는 방법

만들기 위해 Run - Edit Configuration - +를 클릭해서 새로운 구성을 생성 가능

구성 설정

1. Maven Install
   1. 새로운 구성을 만들 때 Maven을 클릭
   2. Name에 Install 기입
   3. Run에 clean install -DskipTests기입
      1. clean → target폴더 삭제
      2. installMaven 설정 값을 기반으로 프로젝트 패키징
      3. -DskipTests테스트를 하지않고 명령을 수행
2. Install then Run
   1. Tomcat server에 사용할 버전의 Tomcat 실행 파일이 있는 폴더를 지정
   2. Deployment directory에 webapps혹은 WebContent이름의 폴더를 지정
      1. 해당 폴더들은 일반적으로 java/main/경로 하위에 있지만, 이번에 적용할 프로젝트의 경우 프로젝트 최상단에 위치
   3. Context path에 /입력
   4. Server port 및 Admin port는 임의의 포트 번호를 기입
   5. VM options에 -Dspring.profiles.active=local -Dfile.encoding=UTF-8을 기입
      1. spring.profiles.active 값을 local로 지정해주는 이유는, 본 프로젝트는 해당 값에 따라서 처음 Spring Context를 구성할 때 참고할 config.properties를 읽어올 폴더를 정하기 때문
   6. Before launch 탭을 확장해서 + - Run Mavel Goal을 클릭한 후, clean install -DskipTests추가
3. Run
   1. a ~ e까지 구성 2와 동일하게 진행

서버 참조 폴더 위치

$HOME/.SmartTomcat/프로젝트_이름 하위에 프로젝트_이름 Tomcat Container에 대한 설정 폴더가 위치하고 있다. 우리가 Smart Tomcat을 Run하면 해당 경로에 있는 server.xml파일부터 시작해서 점진적으로 하위 설정 파일에 접근해서 최종적으로 서버가 띄워진다.

참고

Tomcat 구동 원리

https://github.com/zengkid/SmartTomcat

intelliJ - 웹어플리케이션 Tomcat 에 띄우기