Servlet 인터페이스를 구현하는 기본 서블릿 작성 및 배치

Servlet 인터페이스를 구현하는 기본 서블릿 작성 및 배치

 

1. 서블릿 작성

자바 서블릿 클래스는 javax.servlet.Servlet 인터페이스를 구현해야 한다. Servlet은 서블릿 컨테이너가 서블릿에 대해 호출하는 메소드 init(), service(), destroy(), getServiceConfig(), getServiceInfo()를 정의한 인터페이스이다.

public class FirstServlet implements Servlet {
	ServletConfig config;

	@Override
	public void init(ServletConfig config) throws ServletException {
		System.out.println("init() called");
		this.config = config;
	}
	
	@Override
	public void destroy() {
		System.out.println("destroy() called");
	}
	
	@Override
	public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {
		System.out.println("service() called");
	}

	@Override
	public ServletConfig getServletConfig() {
		System.out.println("getServiceConfig() called");
		return this.config;
	}

	@Override
	public String getServletInfo() {
		System.out.println("getServletInfo() called");
		return "version=1.0;author=butterfield;copyright=butterfield 2020";
	}
}

 

메소드	구분	설명
init()	Lifecycle 관련	서블릿 컨테이너가 서블릿을 생성하고 초기화 작업을 수행하기 위해 호출하는 메소드 요청을 처리하기 전에 해야할 준비 작업을 작성한다. 예: DB 연결, 원격 서버 연결, 프로퍼티 로딩 등
service()		클라이언트가 요청할 때마다 호출되는 메소드 실질적인 서비스 작업을 수행
destroy()		서블릿 컨테이너가 종료되거나 웹 어플리케이션이 종료되거나 해당 서블릿을 비활성화 시킬때 호출되는 메소드 자원 해제, 데이터 저장 등의 마무리 작업을 작성한다.
getServiceConfig()	보조 메소드	서블릿 설정 정보를 다루는 ServletConfig 객체 반환 ServletConfig를 통해 서블릿 이름, 서블릿 초기 매개변수 값, 서블릿 환경 정보 등을 얻을 수 있다.
getServiceInfo()		서블릿 작성자, 버전, 저작권 등의 정보를 담은 문자열 반환

 

2. 서블릿 배치 정보 작성

※ Servlet 3.0부터는 @WebServlet 어노테이션을 이용해서 배치 정보를 설정한다.

 

Deployment descriptor 파일(web.xml)에 서블릿 배치 정보를 작성한다.

 

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" id="WebApp_ID" version="4.0">
  <display-name>web03</display-name>
  
  <!-- 서블릿 선언 -->
  <servlet>
  	<servlet-name>FirstServlet</servlet-name>
  	<servlet-class>atoz_develop.com.FirstServlet</servlet-class>
  </servlet>
  
  <!-- 서블릿을 URI과 연결 -->
  <servlet-mapping>
  	<servlet-name>FirstServlet</servlet-name>
  	<url-pattern>/FirstServlet</url-pattern>
  </servlet-mapping>
  
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
</web-app>

 

web.xml은 웹 어플리케이션의 배치 정보를 갖는다. web.xml에 서블릿 배치 정보를 작성하지 않으면 서블릿 컨테이너가 해당 서블릿을 찾을 수 없다. 클라이언트에서 실행을 요청하려면 반드시 배치 정보를 작성해야 한다.

 

서블릿 선언

<!-- 서블릿 선언 -->
<servlet>
	<servlet-name>FirstServlet</servlet-name>
	<servlet-class>atoz_develop.com.FirstServlet</servlet-class>
</servlet>

<servlet>에 서블릿 name과 class를 지정한다.

서블릿 name은 클래스 이름과 동일하지 않아도 되며 공백을 포함할 수 있다.

서블릿 class는 패키지 이름을 포함한 QName(Fully qualified name)을 작성한다.

 

서블릿 URL 매핑

<!-- 서블릿을 URI과 연결 -->
<servlet-mapping>
	<servlet-name>FirstServlet</servlet-name>
	<url-pattern>/FirstServlet</url-pattern>
</servlet-mapping>

클라이언트에서는 URL로 서블릿의 실행을 요청한다.

<servlet-mapping>에 서블릿 URL 매핑 정보를 작성한다.

<servlet-name>에 위에서 정의한 서블릿 name을 지정한다.

<url-pattern>에 URL을 지정하는데 /FirstServlet과 같이 작성했다면 '/'는 context root, 즉 웹 어플리케이션 루트를 의미한다.

 

이클립스 Project Explorer의 프로젝트 Deployment Descriptor 노드에 web.xml에 작성한 배치 정보가 보기 좋게 시각화되어 표시된다.

 

서블릿 실행

위와 같이 서블릿과 배치 정보를 작성했으면

웹 브라우저 주소창에 http://localhost:포트번호/컨텍스트 루트/FirstServlet 을 입력하여 서버에 요청한다.

 

실행 결과

 

3. 서블릿 구동 절차

1) 클라이언트 요청이 들어오면 서블릿 컨테이너는 서블릿을 찾는다.

2) 서블릿이 없으면 클래스를 로딩하고 인스턴스를 생성하고 서블릿 초기화 메소드인 init()을 호출한다.

3) 클라이언트 요청을 처리하는 service() 메소드를 호출한다.

4) service() 결과를 HTTP에 맞춰 클라이언트에게 응답하여 요청 처리를 완료한다.

5) 서블릿 컨테이너가 종료되거나 웹 어플리케이션이 종료되면 서블릿 컨테이너는 종료되기 전에 서블릿이 마무리 작업을 할 수 있도록 생성된 모든 서블릿에 대해 destroy() 메소드를 호출한다.

 

서블릿을 최초로 요청한 후 웹 브라우저에서 3번 새로고침을 클릭하면 위와 같이 service()만 호출된다. 이미 FirstServlet 인스턴스가 존재하므로 init()은 호출되지 않는것이다.

 

서블릿 객체는 단 하나만 생성되며 한 번 생성되면 웹 어플리케이션이 종료될때까지 유지되며 사용된다.

 

톰캣을 종료하면 destroy()가 호출된다.