개발 공부 - web.xml

용어 뜻:

web.xml은 필터, 서블릿, DB Source 등 web container가 구동하는데 이용되는 환경설정파일이다.

서버가 처음 로딩될 때 web.xml 파일을 읽어들여 해당 환경설정에 대해 어플리케이션 배치를 하게 된다.

다른 말로 web.xml은 배치 서술자(deployment descriptor)라고도 한다.

web.xml에 들어가는 환경설정은 다음과 같은 것들이 존재한다.

1. 필터 정보(매핑 포함)

2. 서블릿 정보(매핑 포함)

3. 웹 어플리케이션 정보

4. 세션 정보

5. 세션 정보가 소멸, 생성, 수정되는 것을 알려주는 리스너 정보

6. MIME 매핑

7. welcomefile 정보

8. errorPage 정보

9. url 보호 정보

10. 엔터프라이즈 빈의 홈 레퍼런스 정보(로컬 레퍼런스 정보 포함)

1. 필터 (filter)

필터는 요청이 들어오면 url 패턴을 분석해서 해당 패턴의 요청이 들어오면 해당 요청에 담긴 정보들을 프로그래머가 원하는 형태의 데이터로 가공해서 서버로 요청을 넘길 수 있다.

 servlet과 비슷한 개념으로 계속 요청을 감시하고 있다가 url패턴에 해당하는 요청이 들어오게 되면 해당 요청을 가로채서 원하는 데이터 형태로 가공한 뒤에 다시 요청을 서버로 보내는 역할을 하게 된다.

따라서 서버내에서 사용될 데이터 또는 화면으로 다시 보낼 데이터의 형태를 프로그래머가 원하는 혀앹로 단일화 시킬 수 있다.

1 2 3 4 5 6 7 8

<filter>      <filter-name>myRequest</filter-name>      <filter-class>myFilter.util.myReqFilter</filter-class>      <init-param>           <param-name>myRequestFilter</param-name>           <param-value>filterTest</param-value>      </init-param> </filter> Colored by Color Scripter

cs

필터 이름과 클래스, 초기화 파라미터를 지정하게 된다.

myRequest 라는 필터는 myFilter.util 패키지 안에 있는 myReqFilter를 호출하며 초기화 파라미터로 myRequestFilter의 이름을 가진 filterTest 값을 가지고 filter를 호출할 것이다.

filter를 사용할 때 사용할 클래스는 반드시 filter 인터페이스를 implements 받아 doFilter 메소드를 반드시 오버라이드 해주어야 하며 

메소드 실행순서는

init() -> doFilter() -> destroy() 순으로 구성된다.

이는 Servlet의 생명 주기와 동일하게 동작한다.

1 2 3 4

<filter-mapping>      <filter-name>myRequest</filter-name>      <url-pattern>*.doFilter</url-pattern> </filter-mapping>

cs

위에서 선언한 filter 정보를 url 패턴과 매핑하는 부분이다.

어떠한 url의 확장자로 .doFilter가 함께 넘어오면 myRequest필터를 호출하게 되고 해당 필터는 myFIlter.util 패키지 안에 있는 myReqFilter를 호출하게 된다.

url-pattern 대신 servlet-name이 올 수 있다.

servlet-name이 들어오게 되면 해당 패턴에 맞는 모든 filter가 실행되고 나서 servlet을 호출하게 된다.

filter는 여러 겹으로 사용할 수 있는데 필터 체인(Filter Chain) 이라는 용어로 쓰인다.

2. 서블릿(Servlet)

필터와 비슷한 맥락의 기능이나 큰 차이가 있다.

Filter의 경우에는 Response와 Request에 대한 stream의 처리를 담당하고, 이에 대한 실질적인 Action을 담당하는 것이 Servlet이다.

web.xml에 매핑되어져 있는 서블릿들은 해당 요청을 포함하여 url 패턴을 분석하고 거기에 매핑되어져 있는 클래스를 호출하여 처리하게 된다.

1 2 3 4 5

<servlet>      <servlet-name>loginServlet</servlet-name>      <servlet-class>myServlet.util.loginServlet</servlet-class> </servlet>   Colored by Color Scripter

cs

위처럼 하나의 서블릿 클래스를 생성해두고 해당 클래스를 servlet-class 라는 element로 지정하게 된다.

나중에 loginServlet을 호출하면 myServlet.util 패키지 안에 있는 loginServlet 클래스가 호출된다.

1 2 3 4 5

<servlet-mapping>      <servlet-name>loginServlet</servlet-name>      <url-pattern>*.login</url-pattern> </servlet-mapping>   Colored by Color Scripter

cs

url 패턴과 해당 패턴에 해당하는 url로 접근시 호출될 servlet을 설정하는 부분이다.

메타 문자로 *가 올 수 있고 확장자를 설정하게 된다.

나중에 *.login 이라는 url을 서버로 요청하게 되면 loginServlet의 이름을 가진 서블릿을 호출하게 된다.

해당 서블릿은 위에서 myServlet.util.loginServlet 클래스를 매핑했으므로 해당 클래스가 호출되는 형태가 될 것이다.

Spring은 이 곳에 DispatcherServlet이라는 Spring에서 제공하는 Servlet을 이용해서 Spring MVC에서 Request를 처리한다.

예를 들어 Naver의 경우에는 *.nhn이라는 url-pattern에 DispatcherServlet을 연결시켜두는 것이 일반적이다.

인터넷 서핑을 주로 하다 보면 *.do url을 간간히 보게 되는데 이것은 Spring의 2.5대 버전에서 추천하던 url-pattern이다.

web.xml의 경우에는 개발자들이 복사 붙여넣기를 하는 경우게 많기 때문에 계속 이용하는 경우도 많다.

3. 웹 어플리케이션 정보(Web Application)

1 2

<display-name>webApplication</display-name> <description>desc for webApplication</description>

cs

웹 어플리케이션 정보를 설정하는 부분으로 Web Application의 정보와 표시 이름을 적을 수 있다.

4. 세션 정보(Session)

세션의 timeout 및 공유 방법을 결정할 수 있다.

1 2 3 4

<session-config>     <timeout>20</timeout>     <shared>true</shared> </session-config>

cs

5. 세션 리스너 정보(Session Listener)

Session이 연결되고 제거되는 각각의 event에 연결되는 Listener에 대한 정보를 기술할 수 있다.

아래는 Servlet에서 기본으로 제공하는 Listener이다.

javax.servlet.ServletContextAttributeListener

이 리스너는 컨텍스트에 저장된 애트리뷰트의 변화가 있었을 때 설정된 이벤트를 엔진이 자동으로 발생시키도록 한다.

이벤트 감지를 얻어내기 위해서는 개발자가 직접 작성한 리스너의 implemention 클래스를 통해야 하는 것은 물론이고 아래의 리스너 모두 동일하게 설정된다.

javax.servlet.ServletContextListener

작성한 웹 어플리케이션에서 컨텍스트를 이용하여 무언가를 저장하고 이용할 수 있는데, 이 리스너의 작동은 그러한 컨텍스트에 대한 변경이 이루어졌을 때 자동으로 엔진이 감지하고 작성한 클래스의 이벤트를 발생시킨다.

javax.servlet.http.HttpSessionActivationListener

request.getSession(true) 같은 경우처럼 Session에 대한 내용이 새로 생성되어 activate 되어졌을 때 발생하는 이벤트를 감지하는 리스너이다.

javax.servlet.http.HttpSessionAttributeListener

HttpSession에 대한 애트리뷰트의 변경시 연결되어지는 리스너이다.

javax.servlet.http.HttpSessionBindingListener

HttpSession에 대하여 클라이언트 세션정보에 대한 바인딩이 이루어졌을 경우 감지되는 리스너이다.

이 SessionListener를 상속받아 구현된 class에 대한 정보를 web.xml에 사용 가능하다.

1 2 3 4

<listener>     <listener-class>SessionListener</listener-class> </listener>    Colored by Color Scripter

cs

6. MIME 매핑(MIME Mapping)

web server에서 보내지는 각각의 파일 리소스에 대한 정보를 mapping 하는 영역이다.

예를 들어 JSON의 경우 application/json 형태임을 web browser 에게 알리는 등의 일을 수행한다.

이것이 정상적으로 설정되어있지 않으면 hwp와 같은 파일 포맷을 다운받지 못하고 browser에서 직접 열게 되는 식의 오동작을 발생시키게 된다.

1 2 3 4 5 6 7 8

<mime-mapping>         <extension>zip</extension>         <mime-type>application/zip</mime-type>     </mime-mapping>     <mime-mapping>         <extension>hwp</extension>         <mime-type>application/unknown</mime-type>     </mime-mapping> Colored by Color Scripter

cs

7. welcomefile 정보(welcomFile)

welcomeFile은 서버에 접속하면 가장 최초로 보여줄 파일을 지정하는 부분이다.

1 2 3 4

<welcome-file-list>     <welcome-file>index.html</welcome-file>     <welcome-file>index.jsp</welcome-file>   </welcome-file-list>

cs

서버를 구동한 후 http://localhost:8080/myWeb/으로 접속을 하게 되면 index.html이 실행된다.

html 파일이 없으면 index.jsp가 실행된다.

8. errorPage 정보(ErrorPage)

특정 요청에 대해 error가 반환될 때 해당 페이지를 보여주도록 설정이 가능하다.

1 2 3 4 5 6 7 8 9

<error-page>   <error-code>404</error-code>   <location>/errors/404.jsp</location> </error-page> <error-page>   <error-code>java.lang.NullPointerException</error-code>   <location>/errors/badcode.jsp</location> </error-page>   Colored by Color Scripter

cs

9. url 보호 정보 (URL Security)

로그인 및 각 url에 대한 접근 정책을 결정할 수 있다.

이 때 사용되는 Security 정책은 servlet-container의 정책에 따르게 되기 때문에 Web Application에서 사용하기에는 조금 힘들다.

tomcat 에서는 conf/tomcat-user.xml에 사용자가 정의되어 있다.

tomcat manager에 등록되어 있는 default security 정책은 다음과 같다.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

<security-constraint>   <display-name>Name String</display-name>   <web-resource-collection>     <web-resource-name>GETServlet</web-resource-name>     <description>some description</description>     <url-pattern>/servlet/*</url-pattern>     <http-method>GET</http-method>   </web-resource-collection>   <auth-constraint>     <description>some description</description>     <role-name>*</role-name>   </auth-constraint>   <user-data-constraint>      <description>some description</description>      <transport-guarantee>INTEGRAL</transport-guarantee>   </user-data-constraint> </security-constraint> <login-config>   <auth-method>FORM</auth-method>   <realm-name>MemoryRealm</realm-name>    <form-login-config>     <form-login-page>login.jsp</form-login-page>     <form-error-page>notAuthenticated.jsp</form-error-page>   </form-login-config> </login-config> <security-role>   <description> some description</description>   <role-name>administrator</role-name> </security-role>   Colored by Color Scripter

cs

10. 엔터프라이즈 빈의 홈 레퍼런스 정보 (로컬 레퍼런스 정보 포함) (Enterprise Bean's Home Reference(Local Reference))

EJB에 대한 설정 정보가 위치하는 곳이다.

1 2 3 4 5 6 7 8 9 10 11 12 13

<env-entry>   <description>some description</description>   <env-entry-name>MinimumValue</env-entry-name>   <env-entry-value>5</env-entry-value>   <env-entry-type>java.lang.Integer</env-entry-value> </env-entry> <ejb-ref>   <description>some description</description>   <ejb-ref-name>Employee Bean</ejb-ref-name>   <ejb-ref-type>EmployeeBean</ejb-ref-type>   <home>com.foobar.employee.EmployeeHome</home>   <remote>com.foobar.employee.Employee</remote> </ejb-ref> Colored by Color Scripter

cs

web.xml 등록법

servlet의 변화에 따라 web.xml은 많은 확장이 있었다.

web.xml의 정보는 3가지 방법으로 표현될 수 있다.

1. WEB-INF/web.xml을 이용해서 등록하는 방법

가장 많이 사용되고 있으며, Servlet 1.0부터 지금까지 구현된 방법이다.

가장 대중적이다.

2. META-INF/web-fragment.xml을 이용하는 방법

servlet 3.0부터 지원되는 방법이다.

web.xml은 web application에 종속되는 방법이다.

web application 뿐 아니라 jar로 개발된 project에서 가지고 있는 META-INF 폴더 안의 web-fragment.xml을 이용해서 web을 구동하는 방법을 지원하고 있다.

web-fragment.xml은 web.xml과 내용이 동일하다.

이 방법이 나오게 된 이유는 Servlet 3.0에서부터 web container를 포함한 설치형 war가 배포가 가능하기 때문이다.

지금까지는 web application을 tomcat과 같은 web container에 배포하는 것이 일반적이었지만

web container를 포함한 하나의 web application으로 구동하는 방법을 Servlet 3.0에서 이제는 지원하고 있다.

3. javax.servlet.ServletContainerInitializer interface를 구현한 객체를 이용하는 방법

Servlet 3.0 부터 지원하는 방법이다.

web.xml이 없이 application에서 작성한 ServletContainerInitializer를 구현하는 것으로 web.xml 대신 페이지를 작성할 수 있도록 지원하고 있다.

3가지 방법 중에 3번인 ServletContainerInitializer를 구현한 객체를 이용하게 되면 다음과 같은 설정들만 사용 가능하다.

Listener 구성

filter 구성

Session Listener 구성

EJB 구성

web.xml의 핵심이 구현되기는 하지만 자주 사용되는 항목들이 제공되지 않는다.

session-config

error-page

이 두 항목을 사용하기 위해서는 web.xml과 ServletContainerInitializer를 구현한 객체를 같이 사용해주면 된다.

그러면 ServletContainer는 web.xml을 먼저 로딩 후 객체를 로드해서 사용하게 된다.

출처:

Programming is Fun, 2016-10-31, http://netframework.tistory.com/entry/18-Java-Web-Application-webxml