Intellij 에서 Spring MVC + Gradle 프로젝트 생성

 

Spring Boot 만 사용하다, Spring MVC 구조를 더 파악하고자 Spring MVC 프로젝트를 생성해서 개발해보도록 하겠습니다.

 

Spring Boot 는 Spring MVC 를 이용하기 위한 설정들을 자동으로 구성해주어 개발자들의 편의를 높여주는 프레임워크입니다. 처음에 Spring 이라는 프레임워크를 접하기엔 좋지만, 내부 구조를 파악하기 위해서는 직접 Spring MVC 를 구성해보는 것이 도움이 될 것이라고 생각합니다.

 

 

저의 개발 환경은 다음과 같습니다.

개발 환경

• Windows 10
• java 12
• tomcat 9
• IDE: intellij IDEA ultimate

 

 

프로젝트 생성부터 Spring MVC 개발 환경 구축 후,

간단한 Controller 를 작성해 웹페이지를 띄워보는 것까지 진행해보도록 하겠습니다.

 

1) Gradle - Java 프로젝트 생성

Intellij 를 열고 새 프로젝트를 생성합니다.

Gradle - Java 와 Web 을 선택 후, 원하는 JDK 로 프로젝트를 생성합니다.

 

Gradle-Java

 

초기 생성 시, 프로젝트 구조는 아래와 같습니다.

 

프로젝트 초기 구조

 

 

2) Spring MVC 추가

먼저 프로젝트 이름-우클릭 시 나오는 Add Framework Support 를 눌러서 Spring MVC 를 추가해줍니다.

 

Add Framework Support

 

spring mvc 를 검색하면 나오면 해당 framework 가 나옵니다.

Spring, Spring MVC 를 선택한 상태에서 OK 를 눌러주면 됩니다.

 

Spring MVC 추가

 

그리고 gradle 에도 spring-context, spring-webmvc, spring-test 를 추가해줍니다.

(위에서 추가한 버전과 동일하게)

 

 

그러면 다음과 같이 applicationContext.xml, dispatcher-servlet.xml, web.xml 파일이 생성됩니다.

 

추가된 파일들

 

Intellij 기준으로,

• applicationContext.xml: Bean 설정
• dispatcher-servlet.xml: 내부 웹 관련 처리 설정
• web.xml: Tomcat 구동 관련 설정

입니다.

 

 

 

3) 폴더 구조 변경

현재 폴더 구조는 src/main/java 와 web/WEB-INF 가 분리되어 있습니다.

Intellij 가 Gradle 빌드 기준이 아닌, 기본 Java 빌드 기준으로 폴더 구조를 만들어주기 때문입니다.

하지만, Gradle 를 빌드 툴로 사용할 것이므로 이런 폴더 구조로는 설정 파일과 함께 정상적으로 빌드할 수 없습니다.

(여기에서 계속 오류가 떴었는데, 폴더 구조와 설정 파일을 잘 위치시켜주어야 합니다!)

 

따라서, webapp (초기 프로젝트 생성 시 web 을 선택한 경우에 생기는) 폴더에 WEB-INF 를 통째로 옮겨줍니다.

 

webapp 으로 옮기기

 

그 후 설정 파일들을 context 로 등록해주면 됩니다.

 

 

 

4) 프로젝트 설정 (Artifacts, Facets)

이제 File->Project Structure 로 들어갑니다.

 

Project Structure

 

Artifacts 에 들어가면, 우측에 가능한 요소들이 위치해 있습니다.

그 중에서 Spring-5.2.3.RELEASE 를 두 번 눌러서 추가해줍니다.

(gradle 빌드 전에는 Spring-MVC-5.2.3.RELEASE 도 떳는데 빌드 후 없어졌습니다)

 

Artifacts 추가

 

그리고 Facets 를 설정해줍니다.

설정 파일을 프로젝트에서 인식할 수 있도록 만들어주는 것입니다.

 

Web Gradle: spring-mvc~ 를 눌러서 Deployment Descriptors 에 web.xml 을 추가해줄 것입니다.

 

web.xml 추가

 

webapp/WEB-INF/web.xml 을 등록해서, Tomcat 구동 관련 설정을 프로젝트에서 인식하게 하는 것입니다.

그러니 web.xml 의 경로를 잘 보고 등록해주어야 합니다. (아마 자동으로 경로가 잘 지정되었을 것입니다.)

 

경로 확인

 

아래와 같이 나오면 잘 된 것입니다! (autodetected!)

 

 

이렇게 폴더 구조를 바꾸고 web.xml 을 등록해주면,

기존에 아래와 같이 오류가 나던 web.xml 에서 springframework 를 잘 인식해서 빨간줄이 없어집니다!

 

 

(아무리 해도 저 spring framework 를 인식하질 못해서 web.xml 자체를 인식하지 못한 게 아닌가 하고 찾아보니 intellij 가 구성해주는 폴더 구조와 프로젝트의 구성의 불일치 때문이었습니다 ㅎㅎ)

(facets 관련 참고: https://www.jetbrains.com/help/idea/adding-support-for-frameworks-and-technologies.html)

Add frameworks (facets) | IntelliJ IDEA

 

 

 

5) 설정 파일(.xml) 수정

이제 프로젝트 구조와 필요한 모듈들을 다 등록했으므로, Spring 설정을 해줍니다.

필수적이진 않고 프로젝트 요구사항에 따라 다른 것이 '설정 파일'이므로, 자신에게 맞는 옵션을 선택하면 됩니다.

 

그럼 일반적으로 많이 하는 설정에 대해 다뤄보겠습니다.

 

web.xml 의 경우 Intellij ultimate 이면 자동으로 작성해줍니다.

다만, 한 가지 부분을 수정합니다.

• 맨 아래 servlet-mapping 의 url-pattern 을 / 로 바꿔줍니다. (URL을 / 기반으로 인식할 것이므로)

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

 

 

applicationContext.xml 은 아직 수정할 사항이 없어서 생략합니다.

 

 

dispatcherServlet.xml 은 다음과 같이 내용을 추가해줍니다.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- Annotation 활성화 -->
    <mvc:annotation-driven/>
    <!-- Component 패키지 지정 -->
    <context:component-scan base-package="com.simple"/>

    <!-- view object 이름 결정 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/views/"/> <!-- view file 경로 -->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

• <mvc:annotation-driven/>: annotation 활성화
• <context:component-scan base-package="com.simple.web.controller"/>: component-scan 의 기본 package 지정.
  (저의 경우 com.simple 라는 패키지를 생성하고 그 안에 Controller 를 위치시킬 것이므로 위와 같이 작성했습니다.)
• <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">: view resolver 로 view 파일에 대한 설정을 합니다.
  • <property name="prefix" value="/WEB-INF/views/"/>: view 파일의 접두사 설정
  • <property name="suffix" value=".jsp"/>: view 파일의 접미사 설정
  • ex) view 파일 이름이 home 이라면, "home" 만 반환해도 view resolver 를 통해 "/WEB-INF/views/home.jsp" 로 반환해주는 것입니다.

 

 

 

6) Controller 작성

이제 프로젝트 설정이 거의 마무리되었습니다.

남은 것은 Tomcat 을 실행해보는 것인데, 이를 위해 간단한 Controller 를 작성해서 요청을 잘 처리하는지 확인해보도록 하겠습니다.

 

먼저, com.simple.web.controller 라는 패키지 아래에 SimpleController.java 라는 파일을 생성해주었습니다.

(경로/파일 이름은 자유이나 변경 사항은 dispatcherServlet.xml 에 반영해주어야 합니다.)

 

이 Controller 는 다음의 하나의 요청만 처리합니다.

• "/" 요청이 들어오면 "hello" 라는 View 를 리턴
  이는 앞서 설정한 것처럼 view resolver 에 의해 "/WEB-INF/views/home.jsp" 파일을 반환하게 됩니다.

SimpleController.java

 

dispatcherServlet.xml 에 등록한 view resolver 의 접두사에 맞게,

WEB-INF/views 폴더 안에 hello.jsp 라는 파일을 생성해서, 다음과 같이 작성해주었습니다.

 

hello.jsp

 

한 가지 주의할 점은 WEB-INF/index.jsp 파일은 이제 사용하지 않으니 삭제해주어야 합니다.

(이걸 삭제하지 않으면 index.jsp 를 기본적으로 반환)

 

index.jsp 파일 삭제

 

 

7) Tomcat 등록 및 연동

Tomcat 은 동적 요청을 처리해주는 웹 애플리케이션 서버입니다.

 

이제 Tomcat 을 등록해주고 연동해서 서버를 실행시킬 것입니다.

(Tomcat 이 다운받아져 있어야 합니다. Apache-Tomcat-자신의 OS 에 맞는 파일 다운 (저는 zip 파일을 다운받아서 압축을 풀어 사용하고 있습니다.))

 

 

IDE 우측 상단에 보면 Add Configuration 이 있습니다.

 

Add Configuration

 

다음과 같이 Run/Debug Configurations 가 뜹니다.

+ 버튼을 눌러서 Tomcat Server 를 추가해줍니다.

 

 

이때 처음 Tomcat 을 사용하는 것이면, Tomcat 실행 파일이 있는 경로를 통해 Tomcat 을 등록해주어야 합니다.

이 경우, 아래의 Application Server에 아무런 선택지가 없을 것입니다.

우측의 Configure 을 눌러서 Tomcat 이 있는 폴더 경로를 선택해줍니다.

 

 

성공적으로 Tomcat 을 인식하고 등록해준 것을 볼 수 있습니다.

 

 

아래에 Warning 이 뜨는데, Fix 를 눌러주면 됩니다.

단, artifact 는 (exploded) 가 붙지 않은 것을 골라줍니다.

 

 

그리고 Deployment 의 경로를 / 로 바꿔줍니다.

 

 

이러면 Tomcat 설정이 끝나게 됩니다!

 

 

 

* Tomcat 한글 깨짐 해결

 

이렇게 Tomcat 의 Log 에 한글이 깨져서, 그냥 영어로 바꿨습니다.

 

-Dfile.encoding=UTF-8 -Duser.language=en -Duser.region=us

 

이 옵션을 Tomcat 의 VM options 에 넣어주면 됩니다.

 

 

설정한 Optinos 와 함께 Tomcat 이 실행되었고, 한글 깨짐도 없어졌습니다.

 

 

 

 

8) Tomcat 실행

우측 상단에서 등록한 Tomcat 을 선택해주고, 초록색 Run 버튼을 눌러주면 Tomcat 이 실행됩니다.

 

 

Tomcat 이 성공적으로 실행되면, 자동으로 Deployment 에서 설정한 경로로 웹페이지를 띄워줍니다.

 

다음과 같이 localhost:8080/ 에 hello.jsp 가 잘 뜨는 것을 확인할 수 있습니다!

 

localhost:8080

 

 

 

이렇게 하면 Spring MVC 프로젝트 설정이 끝납니다.

 

시행착오가 많았으나, 역시 직접 해보니 내부 구조를 더 잘 이해할 수 있는 것 같습니다. 👍