web.xml 파일이란? 그리고 web.xml 파일의 역할

web.xml 파일이란?

• 자바 웹 애플리케이션을 위한 배포 디스크립터 (deployment descriptor) 이다.
  • WEB-INF 디렉토리 내부에 위치한다.
  • 배포 디스크립터란 구성 정보 파일을 말한다.
  • 애플리케이션에 의해 사용되어 배포 도구 혹은 런타임에 정보를 제공한다.
  • 애플리케이션의 servlets, filters 그리고 그 외 컴포넌트들을 구성하는 것을 도와준다.
• 정리하자면, 웹 컨테이너(Tomcat)에 구성 정보 (configuration information)를 제공해준다.

web.xml 을 통해 제공할 수 있는 구성 정보들

• 자바 웹 애플리케이션에 대표적으로 아래와 같은 구성정보를 제공해줄 수 있다.
  • 서블릿 매핑
  • 보안 제약
  • 에러 페이지
  • 초기화 파라미터
  • 필터
  • 세션 구성
  • 마임 타입 매핑

서블릿 매핑 (Servlet mappings)

• 요청 URL 을 보고 어떠한 서블릿이 해당 요청을 처리할지 설정한다.
• 이 정보를 통해 웹 애플리케이션은 특정한 URL 을 처리할 수 있다.

<servlet>
    <servlet-name>MyServlet1</servlet-name>
    <servlet-class>com.example.MyServlet1</servlet-class>
</servlet>

<servlet>
    <servlet-name>MyServlet2</servlet-name>
    <servlet-class>com.example.MyServlet2</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>MyServlet1</servlet-name>
    <url-pattern>/myservlet</url-pattern>
</servlet-mapping>

<servlet-mapping>
    <servlet-name>MyServlet2</servlet-name>
    <url-pattern>/anotherservlet</url-pattern>
</servlet-mapping>

보안 제약 (Security constraints)

• 특정한 리소스에 접근할 때 인증 혹은 인가를 요구하도록 설정한다.
• 사용자에 대한 역할 및 어떤 사용자를 허가할 것인지도 포함할 수 있다.

<security-constraint>
    <web-resource-collection>
        <web-resource-name>Protected Resource</web-resource-name>
        <url-pattern>/protected/*</url-pattern>
        <http-method>GET</http-method>
        <http-method>POST</http-method>
    </web-resource-collection>
    <auth-constraint>
        <role-name>admin</role-name>
        <role-name>user</role-name>
    </auth-constraint>
</security-constraint>

<security-role>
    <role-name>admin</role-name>
</security-role>

<security-role>
    <role-name>user</role-name>
</security-role>

<login-config>
    <auth-method>BASIC</auth-method>
    <realm-name>MyRealm</realm-name>
</login-config>

에러 페이지 (Error pages)

• 404나 500 응답 시 노출되는 에러 페이지를 설정한다.

<error-page>
    <error-code>404</error-code>
    <location>/error404.html</location>
</error-page>

<error-page>
    <error-code>500</error-code>
    <location>/error500.jsp</location>
</error-page>

초기화 파라미터 (Initialization parameter)

• 자바 웹 앱이 초기화될 때 전달할 정보를 정의한다.

<context-param>
    <param-name>databaseUrl</param-name>
    <param-value>jdbc:mysql://localhost:3306/mydatabase</param-value>
</context-param>

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:/egovframework/spring/com/**/context-*.xml</param-value>
</context-param>

필터 (Filters)

• 요청과 응답을 가로채 공통 로직을 적용하는 필터를 정의한다.
• 인증, 로깅, 입력값 검증 등에 사용된다.

<filter>
    <filter-name>LoggingFilter</filter-name>
    <filter-class>com.example.LoggingFilter</filter-class>
</filter>

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

<filter>
    <filter-name>AuthenticationFilter</filter-name>
    <filter-class>com.example.AuthenticationFilter</filter-class>
    <init-param>
        <param-name>loginPage</param-name>
        <param-value>/login.jsp</param-value>
    </init-param>
</filter>

<filter-mapping>
    <filter-name>AuthenticationFilter</filter-name>
    <url-pattern>/protected/*</url-pattern>
</filter-mapping>

세션 구성 (Session configuration)

• HTTP 세션에 대한 옵션을 구성한다.
• 세션 타임아웃이나 쿠키 타임아웃 같은 것을 설정한다.

<session-config>
    <session-timeout>30</session-timeout>
    <cookie-config>
        <name>MYSESSIONID</name>
        <http-only>true</http-only>
    </cookie-config>
</session-config>

마임 타입 매핑 (MIME type mapping)

• 파일 확장자와 마임 타입 사이 매핑을 구성한다.

<mime-mapping>
    <extension>html</extension>
    <mime-type>text/html</mime-type>
</mime-mapping>

<mime-mapping>
    <extension>jpg</extension>
    <mime-type>image/jpeg</mime-type>
</mime-mapping>

<mime-mapping>
    <extension>pdf</extension>
    <mime-type>application/pdf</mime-type>
</mime-mapping>