[IntelliJ] Spring Web MVC 프로젝트 생성 및 세팅

[IntelliJ] Spring Web MVC 프로젝트 생성 및 세팅 - XML 설정 사용

💡 버전 : JDK8 / Spring MVC 5.2.6.RELEASE / Tomcat 9

1. 프로젝트 생성

새로운 Maven 프로젝트를 생성한다.

Create from archetype 체크, maven-archetype-webapp을 선택하고 Next 클릭

프로젝트 정보 입력하고 Next 클릭

사용할 Maven 선택 후 Finish 클릭

기본으로 생성되는 pom.xml

<?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>com.atoz_develop</groupId>
  <artifactId>project03</artifactId>
  <version>1.0-SNAPSHOT</version> 
  <packaging>war</packaging>

  <name>project03 Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>project03</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

maven-archetype-webapp으로 프로젝트 생성 시 기본으로 생성되는 pom.xml은 위와 같다.

2. 자바 버전 설정

먼저 자바 컴파일러 버전을 변경한다.

여기서는 8로 변경하도록 하겠다.

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>8</maven.compiler.source>
  <maven.compiler.target>8</maven.compiler.target>
</properties>

pom.xml의 <maven.compiler.source>, <maven.compiler.target>을 8로 변경한다.

IntelliJ Project Structure에서 프로젝트/모듈의 Language level을 8로 변경한다.

Preferences에서 Build, Execution, Deployment - Compiler - Java Compiler 클릭하고 프로젝트/모듈의 Target bytecode version을 8로 변경한다.

이렇게 세 가지를 설정하면 자바 버전 설정은 완료된다.

3. 의존성 설정

다음으로 Spring MVC, Servlet/JSP API, jstl 라이브러리 의존성을 추가한다.

아래와 같이 <properties>와 <dependencies>를 변경하면 된다.

이 중 Spring MVC는 필수이고 Servlet/JSP API, jstl은 선택사항이다.

JSP 외의 다른 뷰 템플릿을 사용한다면 해당 라이브러리를 추가한다.

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>8</maven.compiler.source>
  <maven.compiler.target>8</maven.compiler.target>
  <spring-webmvc-version>5.2.6.RELEASE</spring-webmvc-version>
  <javax.servlet-api-version>4.0.1</javax.servlet-api-version>
  <javax.servlet.jsp-api-version>2.3.3</javax.servlet.jsp-api-version>
  <javax.servlet.jsp.jstl-api-version>1.2.2</javax.servlet.jsp.jstl-api-version>
  <taglibs-standard-impl-version>1.2.5</taglibs-standard-impl-version>
  <junit-version>4.11</junit-version>
</properties>

<dependencies>
  <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>${spring-webmvc-version}</version>
  </dependency>

  <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
  <dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>${javax.servlet-api-version}</version>
    <scope>provided</scope>
  </dependency>

  <!-- https://mvnrepository.com/artifact/javax.servlet.jsp/javax.servlet.jsp-api -->
  <dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>javax.servlet.jsp-api</artifactId>
    <version>${javax.servlet.jsp-api-version}</version>
    <scope>provided</scope>
  </dependency>

  <!-- https://mvnrepository.com/artifact/javax.servlet.jsp.jstl/javax.servlet.jsp.jstl-api -->
  <dependency>
    <groupId>javax.servlet.jsp.jstl</groupId>
    <artifactId>javax.servlet.jsp.jstl-api</artifactId>
    <version>${javax.servlet.jsp.jstl-api-version}</version>
  </dependency>

  <!-- https://mvnrepository.com/artifact/org.apache.taglibs/taglibs-standard-impl -->
  <dependency>
    <groupId>org.apache.taglibs</groupId>
    <artifactId>taglibs-standard-impl</artifactId>
    <version>${taglibs-standard-impl-version}</version>
  </dependency>

  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>${junit-version}</version>
    <scope>test</scope>
  </dependency>
</dependencies>

4. web.xml 설정

1) web.xml 스키마 변경

maven-archetype-webapp으로 프로젝트를 생성하면 기본적으로 생성되는 web.xml은 다음과 같다.

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
</web-app>

이 상태에서는 EL과 같은 스펙이 정상적으로 동작하지 않으므로 다음과 같이 변경한다.

⬇️

<?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">

  <display-name>Archetype Created Web Application</display-name>
</web-app>

2) DispatcherServlet 설정

톰캣을 사용하는 자바 웹 어플리케이션은 기본적으로 org.apache.Catalina.servlets.defaultServlet이 클라이언트의 요청을 가장 먼저 받도록 매핑 설정이 되어있다.

이를 스프링 MVC의 DispatcherServlet으로 변경하는 설정을 해야한다.

다음 코드를 web.xml의 <web-app> 태그 내에 추가한다.

<servlet>
  <servlet-name>appServlet</servlet-name>
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>appServlet</servlet-name>
  <url-pattern>/</url-pattern>
</servlet-mapping>

3) Spring MVC Web Context Config 설정

프로젝트의 WEB-INF에 config 디렉토리와 webmvc-context.xml 파일을 생성한다.

디렉토리와 파일명은 자유롭게 해도 된다.

<servlet>
  <servlet-name>appServlet</servlet-name>
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  <init-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/config/webmvc-context.xml</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>

DispatcherServlet 서블릿 설정에 위와 같이 <init-param>을 추가한다.

param-name은 contextConfigLocation을 지켜야 하며 param-value는 위에서 만든 xml 경로를 설정해준다.

webmvc-context.xml의 내용을 다음과 같이 변경한다.

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

이 기본 스키마에 필요한 설정을 추가할 것이다.

4) Root Context Config 설정

Root context config는 스프링 IoC 컨테이너(ApplicationContext) 설정 파일이다.

config 디렉토리에 root-context.xml 파일을 생성한다.

역시 디렉토리와 파일명은 자유롭게 해도 된다.

web.xml에 다음 코드를 추가한다.

<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>/WEB-INF/config/root-context.xml</param-value>
</context-param>

<listener>
  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

ContextLoaderListener는 서버가 기동되면 context config를 읽어 빈 구성 등의 초기 작업을 수행하는 역할을 한다.

root-context.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"
	   xsi:schemaLocation="http://www.springframework.org/schema/beans
	   					   http://www.springframework.org/schema/beans/spring-beans.xsd">
	   					   
</beans>

여기에 프로젝트에서 필요한 빈을 설정하면 된다.

5) Filter 설정

파라미터로 넘어오는 한글이 깨지지 않도록 필터를 통해 인코딩을 설정한다.

web.xml에 다음 코드를 추가한다.

<filter>
  <filter-name>encodingFilter</filter-name>
  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  <init-param>
    <param-name>encoding</param-name>
    <param-value>UTF-8</param-value>
  </init-param>
  <init-param>
    <param-name>forceEncoding</param-name>
    <param-value>true</param-value>
  </init-param>
</filter>

<filter-mapping>
  <filter-name>encodingFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

여기까지가 web.xml에 해주어야 할 설정이다.

최종 web.xml 내용은 다음과 같다.

<?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">

  <display-name>Archetype Created Web Application</display-name>

  <servlet>
    <servlet-name>appServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>/WEB-INF/config/webmvc-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>appServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/config/root-context.xml</param-value>
  </context-param>

  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

  <filter>
    <filter-name>encodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
      <param-name>forceEncoding</param-name>
      <param-value>true</param-value>
    </init-param>
  </filter>

  <filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

</web-app>

5. webmvc-context.xml 설정

1) Controller 설정

controller 패키지를 생성한다.

webmvc-context.xml에 다음 코드를 추가한다.

<!-- @Controller 애노테이션 사용 -->
<annotation-driven/>

<!-- Component Scan 패키지 설정 -->
<context:component-scan base-package="com.atoz_develop.project03.controller"/>

이렇게 설정하면 com.atoz_develop.project03.controller 패키지에 있는 클래스에 @Controller를 붙여 컨트롤러로 사용할 수 있게 된다.

2) ViewResolver 설정

webmvc-context.xml에 다음 코드를 추가한다.

<!-- 뷰 prefix, suffix 설정 -->
<beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="prefix" value="/WEB-INF/views/"/>
    <beans:property name="suffix" value=".jsp"/>
</beans:bean>

3) Static Resources 설정

webmvc-context.xml에 다음 코드를 추가한다.

<!-- 정적 리소스 경로 설정 -->
<resources mapping="/**" location="/resources/"/>

설정이 완료된 최종 webmvc-context.xml 내용은 다음과 같다.

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

    <!-- @Controller 애노테이션 사용 -->
    <annotation-driven/>

    <!-- Component Scan 패키지 설정 -->
    <context:component-scan base-package="com.atoz_develop.project03.controller"/>

    <!-- 뷰 prefix, suffix 설정 -->
    <beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <beans:property name="prefix" value="/WEB-INF/views/"/>
        <beans:property name="suffix" value=".jsp"/>
    </beans:bean>

    <!-- 정적 리소스 경로 설정 -->
    <resources mapping="/**" location="/resources/"/>

</beans:beans>

6. 테스트

설정이 제대로 됐는지 테스트해보자.

위 그림에서 선택되어 있는 파일과 디렉토리를 새로 생성한다.

resources 안에는 테스트용 이미지를 아무거나 하나 넣어둔다.

HelloController

package com.atoz_develop.project03.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "hello";
    }
}

hello.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Hello Spring Web MVC</title>
</head>
<body>
<h1>Hello Spring Web MVC</h1>
<img src="spring.png"/>
</body>
</html>

🖥 실행 결과

위와 같이 /hello로 요청했을 때 실행이 잘 되고 이미지가 잘 뜨면 모든 설정이 정상적으로 완료된 것이다.

- [IntelliJ] Spring Web MVC 프로젝트 생성 및 세팅 - 자바 설정 사용

'Spring' 카테고리의 다른 글

Spring MVC - @PropertySource 사용 중 FileNotFoundException: Could not open ServletContext resource 에러 (0)	2020.05.06
[IntelliJ] Spring Web MVC 프로젝트 생성 및 세팅 - 자바 설정 사용 (0)	2020.05.01
스프링 JDBC 프로그래밍 - MyBatis 연동 (0)	2020.04.28
스프링 JDBC 프로그래밍 - JdbcTemplate (0)	2020.04.27
AspectJ Weaver를 사용한 애노테이션 기반의 스프링 AOP 구현 방법 (0)	2020.04.27

💾 Knowledge Repository

[IntelliJ] Spring Web MVC 프로젝트 생성 및 세팅 - XML 설정 사용