[Spring] web.xml 이란? / 예제 및 코드분석

안녕하세요.
https://blog.naver.com/sysysy0302 여니입니다 :)

yeonee 블로그 : 네이버 블로그

 

 

* web.xml이란?

web.xml : 서버가 가장 먼저 읽어들이는 파일로 그 안에 root-context.xml이 존재함.

[개념]
web.xml은 DD (Deployment Descriptor : 배포 설명자)라고 불리며, Web Application의 설정파일이다.
DD는 Web Application 실행 시 메모리에 로드된다.
즉, web.xml이란 웹 어플리케이션을 실행시킬 때 함께 올라가야할 설정(설명)들을 정의해놓은 것이다.
그렇다면 web.xml에는 어떤 설정을 할까?
(web.xml에 대한 예제는 MVC 패턴 기준으로 작성하였습니다.)

[설정]
Web.xml 에서는 크게 DispatcherServlet, ContextLoaderListener, Filter 설정을 한다.

1) 클라이언트의 요청을 처리하는 DispatcherServlet.
2) 웹 어플리케이션 컨텍스트 단위의 설정을 로드하는 ContextLoaderListener.
3) 이건 꼭 거쳤으면 좋겠다 하는 것은 Filter.

 

 

1)  DispatcherServlet

DispatcherServlet은 클라이언트의 요청을 전달받는 객체이다. 클라이언트의 요청을 처리하는 역할을 한다.
클라이언트의 요청을 처리하려면 크게 4가지 일이 진행되어야 한다.

첫째, 클라이언트의 요청을 처리해줄 컨트롤러를 찾는다. (Handler Mapping 객체가 처리함)
둘째, 컨트롤러를 실행시킨다. (비지니스 로직 처리) (Handler Adapter 객체가 처리함)
셋째, 클라이언트에게 보여질 View를 찾는다. 
넷째, 응답 데이터와 View를 클라이언트에게 전달한다.

요청을 처리할 컨트롤러를 찾는 일은 Handler Mapping이라는 객체가 처리한다. 이 객체는 클라이언트의 요청 경로를 이용해서 컨트롤러를 검색하고, 검색된 객체를 DispatcherServlet에게 리턴한다.

컨트롤러를 실행시키는 일은 Handler Adapter라는 객체가 처리한다. 이 객체는 @Controller 어노테이션을 이용해 구현한 컨트롤러 뿐만 아니라, Controller 인터페이스를 구현한 컨트롤러, 특수 목적으로 사용되는 HttpRequestHandler 인터페이스를 구현한 클래스를 동일한 방식으로 실행할 수 있도록 만들어졌다. (출처 : 스프링5 입문. 최범균)
즉, 컨트롤러 실행 업무에 특화된 객체로 Controller를 실행하는 것이다.
Controller가 실행되면 개발자가 구현한 비지니스 로직을 거쳐 응답 데이터가 추출된다. 실행된 Controller는 리턴할 데이터와 View를 Handler Adapter에게 리턴한다.
Handler Adapter는 데이터와 view를 ModelAndView 형태로 DispatcherServlet에게 리턴한다.

여기서 view는 단순히 view의 이름이다. 이게 무슨말이냐면 이 이름에 해당하는 실제 view를 찾아야한다는 것이다.

위는 viewResolver 객체를 설정하는 부분인데 설정된 prefix(접두사), suffix(접미사)를 참조하여 처리한다.
ex) Controller에서 리턴한 view 이름이 hello였다면 /WEB-INF/view/hello.jsp를 찾아 dispatcher Servlet에게 리턴한다.
최종적으로 viewResolver가 리턴한 View 객체에 응답 데이터를 넣어 클라이언트에게 리턴한다.

이처럼 클라이언트의 요청은 DispatcherServlet라는 감독관(?)이 처리한다. 다만 직접 처리하지 않고 적절한 객체들에게 일을 위임하여 처리하고 있다.

<!-- DispatcherServlet : 요청 / 응답을 나눠주는 서블릿
		
    [Front Controller]
    모든 요청을 앞에서 받아들여 알맞은 Controller로 연결을 해주고
    Controller의 반환결과에 따라서 알맞은 View를 선택해 클라이언트에게 요청하는 역할
 -->
 <!-- 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>

여기서 <init-param> 부분은 생략이 가능하다.
<servlet-name> 에 '설정한 이름 + -servlet.xml' 형식으로 설정 파일 이름을 만들고, web.xml과 같은 위치(/WEB-INF 하위)에 있어야 contextLoader가 해당 파일을 찾아서 읽을 수 있다.
위와 같이 설정하면 init-param으로 dispatcher xml 파일의 이름 설정하지 않아도 자동으로 로드된다.

 

2) ContextLoaderListener

앞서 Dispatcher Servlet은 클라이언트의 요청을 처리하는 객체라고 설명했다. 웹 어플리케이션의 규모가 커진다면, 클라이언트의 요청또한 다양해질 것이고, 이를 처리할 Dispatcher Servlet도 늘어날 가능성이 있다. 다른 성격을 가진 서블릿이 생성될 것이고, 설정 또한 서블릿의 성격에 맞게 각각 적용시켜야 한다.

반면에, 모든 서블릿이 공통으로 가져야할 설정들도 있다. 즉 Servlet Context 단위가 아닌 Application Context 단위의 설정이 필요한데 이를 ContextLoaderListener 객체가 처리한다.
이 객체는 Application Context 단위의 설정을 생성한다.
참고로 Application Context 는 Web Application 의 Context이며, 모든 Servlet들이 참조가 가능한 부모 Context이다.

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

 

 

3) encodingFilter

인코딩을 UTF-8로 설정하여 필터링하겠다는 설정이다.
모든 요청 처리 전 공통적으로 필요로 하는 기능들을 클라이언트의 요청을 controller가 받기 전에 먼저 수행하게한다.
클라이언트에서 온 요청을 Dispatcher Servlet이 받기 전 거치는 부분이 있다. 바로 이 Filter 객체이다.
만약 스프링 시큐리티 필터가 적용되어 있다면, 인가 및 인증 처리를 먼저 처리하고, 인코딩 필터가 적용되어 있다면
클라이언트의 요청데이터를 인코딩하는 작업이 선 처리된 후 Dispatcher Servlet에게 필터링 된 데이터가 전달된다.

* 스프링에서 제공해주는 인코딩 필터 등록
- class : org.springframework.web.filter.CharacterEncodingFilter
- 필터 등록시 filter태그와 filter-mapping태그를 같이 사용
- filter-name태그로 filter이름으로 지정

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

필터 등록시에는 filter태그와 filter-mapping태그를 같이 사용하며, forceEncoding은 충돌시 강제인코딩 설정 역할을 한다.

 

---

예제)

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee https://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

	<!-- 서버가 가장 먼저 읽어들이는 파일로 그 안에 root-context.xml이 존재함. -->

	<!-- web application context -->
	<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>

	 <!-- Dispatcher Servlet 생성 -->
	<!-- DispatcherServlet : 요청 / 응답을 나눠주는 서블릿
		
		[Front Controller]
		모든 요청을 앞에서 받아들여 알맞은 Controller로 연결을 해주고
		Controller의 반환결과에 따라서 알맞은 View를 선택해 클라이언트에게 요청하는 역할
	 -->
	<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>


	<!-- 
		* 필터
		모든 요청 처리 전 공통적으로 필요로 하는 기능들을 클라이언트의 요청을 controller가 받기 전에 먼저 수행하게함
		
		* 스프링에서 제공해주는 인코딩 필터 등록
		- class : org.springframework.web.filter.CharacterEncodingFilter
		- 필터 등록시 filter태그와 filter-mapping태그를 같이 사용
		- filter-name태그로 filter이름으로 지정
	 -->
	 
     <!-- Encoding Filter 생성 -->
	 <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>

분석 전 위의 내용을 다시 되새겨보자.
첫째, web.xml은 DD(Deploy Descriptor, 배포 설명자)이다.
둘째, DD는 Web Application 실행 시 메모리에 로드된다.
셋째, web.xml에는 크게 dispatcherServlet, contextLoaderListener, filter 를 설정한다.

만약 tomcat이라는 WAS(Web Application Server)를 통해 이 web Application을 실행시킨다고 가정하면, web.xml 파일에 설정한 내용들이 메모리에 로드될 것이다.

코드를 분석해보면,

1. <servlet> 부분을 살펴보면, 클라이언트의 요청을 처리하는 Dispatcher Servlet을 appServlet이란 이름으로 생성하고, 이 서블릿에 대한 설정파일로 servlet-config.xml을 지정한다. (controller 스캔용)

2. <servlet-mapping> 부분에 설정한 Dispatcher Servlet이 처리할 url-pattern을 설정한다. '/' 경로로 들어오는 모든 요청에 대해서 appServlet이 처리를 담당한다. (view-resolver 설정용)

3. web application context 단위의 설정파일로 root-context.xml을 설정한다. 이 설정은 servelt으로 생성한 appServlet에게 공유된다.

4. <filter> 부분에서 스프링에서 지원하는 encoding Filter를 filter에 추가한다.

5. <filter-mapping> 부분에서 encoding Filter가 처리할 url-pattern을 설정한다. '/*' 모든 경로에 대해 인코딩 필터를 적용한다.

 

정리하면 이 예제 web.xml은 클라이언트의 요청을 처리할 인코딩 필터와 Dispatcher Servelt을 생성하고, view Resolver를 web application context 단위로 설정하였다.

 

+ Spring MVC 에 대한 이해가 필요하신 분들은 아래 링크 내용을 참고해주세요.

https://gmlwjd9405.github.io/2018/12/20/spring-mvc-framework.html

 

https://gmlwjd9405.github.io/2018/10/29/web-application-structure.html + 참고포스팅

https://tlatmsrud.tistory.com/35 + 참고포스팅

해당 포스팅을 참고하여 공부하기 위해 작성하였습니다.