Part2 - 스프링 MVC설정

스프링 MVC의 기본 구조

우선 스프링MVC를 학습하는데 있어서 가장 먼저 기억해야하는 점은 스프링MVC가 스프링의 서브 프로젝트라는 것입니다. https://spring.io/projects를 보면 Spring Framework라는 메인 프로젝트 외에도 여러 종류의 서브 프로젝트가 존재하는데, 스프링 MVC 역시 이러한 프로젝트 중 일부입니다.

스프링은 하나의 기능을 위해서만 만들어진 프레임워크가 아니라 코어라고 할 수 있는 프레임워크에 여러 서브프로젝트를 결합해서 다양한 상황에 대처 할 수 있도록 개발되었습니다. Spring Legacy Project로 생성한 예제의 경우에도 servlet-context.xml 과 root-context.xml로 설정 파일이 분리된 것을 볼 수 있습니다. 스프링 MVC가 서브 프로젝트 이므로 구성 방식이나 설정 역시 조금 다르다고 볼 수 있습니다. 

우선 해당 예제에서 만드는 구조는 다음 그림과 같은 구조가 됩니다.

Spring MVC = servlet-context.xml (ServletConfig.class)

Spring Core + MyBatis = root-context.xml (RootConfig.class)

스프링 MVC 프로젝트의 내부 구조

스프링 MVC 프로젝트를 구성해서 사용한다는 의미는 내부적으로는 root-context.xml로 사용하는 일반 Java영역(흔히 POJO(Plain Old Java Object)) 과 servlet-context.xml로 설정하는 Web관련 영역을 같이 연동해서 구동하게 됩니다. 

 

파트1에서 했던것처럼 Spring Legacy Project를 이용해서 Spring MVC Project 'ex01'프로젝트 생성(패키지명은 org.zerock.controller)

또한 pom.xml에 다음과같이 설정을 변경해준다.

	<properties>
		<java-version>1.8</java-version>
		<org.springframework-version>5.0.7.RELEASE</org.springframework-version>
		<org.aspectj-version>1.6.10</org.aspectj-version>
		<org.slf4j-version>1.6.6</org.slf4j-version>
	</properties>

-자바버젼과 스프링 버젼 변경

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-test</artifactId>
			<version>${org.springframework-version}</version>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.0</version>
			<scope>provided</scope>
		</dependency>

-Lombok 기능과 테스트 코드 사용을위한 설정

<!-- Servlet -->
		<!-- <dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>servlet-api</artifactId>
			<version>2.5</version>
			<scope>provided</scope>
		</dependency> -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
		</dependency>

- servlet버젼을 2.5에서 3.1.0이상버젼으로변경(Java설정 등을 이용하려면 서블릿3.0이상을 사용해야됨)

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.5.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <compilerArgument>-Xlint:all</compilerArgument>
                    <showWarnings>true</showWarnings>
                    <showDeprecation>true</showDeprecation>
                </configuration>
            </plugin>

- Maven 버젼을 1.6에서 1.8로 변경

 

'/' 경로로 프로젝트가 실행될 수 있도록 Context Path 변경하기

*Java 설정을 이용하는 경우(xml설정에서 했던 pom.xml 그대로 복사)

pom.xml에 web.xml에 없다는 설정 추가하기

			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-war-plugin</artifactId>
				<version>3.2.0</version>
				<configuration>
					<failOnMissingWebXml>false</failOnMissingWebXml>
				</configuration>
			</plugin>

그 후 servlet-context.xml,root-context.xml,web.xml 삭제 한 후 org.zerock.config 패키지에 RootConfig.java,WebConfig.java를 생성합니다. 또한 기존의 servlet-context.xml에 설정된 모든 내용을 담아야하는데 (ServletConfig.java) 이 때는 주로 다음과 같은 방식을 사용합니다.

- @EnableWebMvc 어노테이션과 WebMvcConfigurer 인터페이스를 구현하는 방식(과거에는 WebMvcConfigurerAdapter 추상 클래스를 사용했으나, 스프링 5.0버젼 부터는 Deprecated되었으므로 주의합니다.)

- @Configuration과 WebMvcConfigurationSupport 클래스를 상속하는 방식 - 일반 @Configuration우선 순위가 구분되지 않는 경우에 사용

 

servlet-context.xml에 있는 내용을 그대로 자바설정 클래스(ServletConfig.java)에 적용하기

package org.zerock.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;

@EnableWebMvc
@ComponentScan(basePackages = { "org.zerock.controller" })
public class ServletConfig implements WebMvcConfigurer {

	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {

		InternalResourceViewResolver bean = new InternalResourceViewResolver();
		bean.setViewClass(JstlView.class);
		bean.setPrefix("/WEB-INF/views/");
		bean.setSuffix(".jsp");
		registry.viewResolver(bean);
	}

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {

		registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
	}

}

WebConfig.java 도 다음과 같이 설정을 바꿔준다.

package org.zerock.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class WebConfig extends AbstractAnnotationConfigDispatcherServletInitializer {

	// 프로젝트에서 사용할 Bean들을 정의하기 위한 클래스를 지정한다.
	@Override
	protected Class<?>[] getRootConfigClasses() {

		return new Class[] { RootConfig.class };
	}

	// Spring MVC 프로젝트 설정을 위한 클래스를 지정한다.
	@Override
	protected Class<?>[] getServletConfigClasses() {
		return new Class[] { ServletConfig.class };
	}

	// DispatcherServlet에 매핑할 요청 주소를 셋팅한다.
	@Override
	protected String[] getServletMappings() {
		return new String[] { "/" };
	}

}

프로젝트의 로딩 구조

-web.xml의 일부

<!-- The definition of the Root Spring Container shared by all Servlets and Filters -->
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>/WEB-INF/spring/root-context.xml</param-value>
	</context-param>
	
	<!-- Creates the Spring Container shared by all Servlets and Filters -->
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

	<!-- Processes application requests -->
	<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/spring/appServlet/servlet-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>

</web-app>

*web.xml에서 구동을 시작합니다. web.xml 상단에는 가장 먼저 구동되는 Context Listener가 등록되어 있습니다. <context-param>에는 root-context.xml의 경로가 설정되어 있고, <listener>에는 스프링 MVC의 ContextLoaderListener가 등록되어 있는 것을 볼 수있습니다. ContextLoaderListener는 해당 웹 애플리케이션 구동 시 같이 동작하므로 해당 프로젝트를 실행하면 가장 먼저 로그를 출력하면서 기록하는 것을 볼 수 있습니다. root-context.xml이 처리되면 파일에 있는 빈설정들이 동작하게 됩니다. 이렇게 root-context.xml이 처리된 후에는 스프링 MVC에서 사용하는 DispatcherServlet이라는 서블릿과 관련된 설정이 동작합니다. DispatcherServlet클래스는 스프링MVC의 구조에서 가장 핵심적인 역할을 하는 클래스입니다. 내부적으로 웹 관련 처리의 준비작업을 진행하는데 이때 사용하는 파일이 servlet-context.xml입니다. DispatcherServlet에서 XmlWebApplicationContext를 이용해서 servlet-context.xml을 로딩하고 해석하기 시작합니다. 이과정에서 등록된 객체들은 기존에 만들어진 객체들과 같이 연동되게 됩니다.

 

스프링MVC 데이터 처리 구조

*더욱 자세하게 표현한다면 다음과 같이 표현 할 수 있습니다.

*1. 사용자의 Request는 Front-Controller인 DispatcherServlet을 통해서 처리합니다. 생성된 프로젝트의 web.xml을 보면 아래와 같이 모든 Request를(url-pattern = "/") DispatcherServlet이 받도록 처리하고 있습니다.

*2,3. HandlerMapping은 Request의 처리를 담당하는 컨트롤러를 찾기 위해서 존재합니다. HandlerMapping인터페이스를 구현한 여러 객체들 중 RequestMappingHandlerMapping같은 경우는 개발자가 @RequestMapping어노테이션이 적용된 것을 기준으로 판단하게 됩니다. 적절한 컨트롤러가 찾아 졌다면 HandlerAdapter를 이용해서 해당 컨트롤러를 동작시킵니다.

*4 Controller는 개발자가 작성하는 클래스로 실제 Request를 처리하는 로직을 작성하게 됩니다. 이때 View에 전달해야하는 데이터는 주로 Model이라는 객체에 담아서 전달합니다. Controller는 다양한 타입의 결과를 반환하는데 이에 대한 처리는 ViewResolver를 이용하게 됩니다.

*5. ViewResolver는 Controller가 반환한 결과를 어떤 View를 통해서 처리하는 것이 좋을지 해석하는 역할입니다. 가장 흔하게 사용하는 설정은 Servlet-context.xml에 정의된 internalResourceViewResolver입니다.

*6,7. View는 실제로 응답 보내야 하는 데이터를 Jsp 등을 이용해서 생성하는 역할을 하게 됩니다. 만들어진 응답은 DispatcherServlet을 통해서 전송됩니다.

 

- 모든 Request는 DispatcherServlet을 통하도록 설계되는데 이런 방식을 Front-Controller 패턴이라고 합니다.