GenericServlet을 상속하는 서블릿 작성 및 배치

GenericServlet을 상속하는 서블릿 작성 및 배치

 

지난 포스팅에서 서블릿 프로그래밍에서 가장 기본이 되는 Servlet 인터페이스 구현에 대해 알아보았다.

이번 포스팅에서는 Servlet을 구현하는 GenericServlet 추상 클래스에 대해 알아보도록 하겠다.

 

• 지난 포스팅

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

---

Servlet 인터페이스를 구현해서 서블릿 클래스를 작성하려면 다섯 개의 메소드인 init(), service(), destroy(), getServiceConfig(), getServiceInfo()를 모두 구현해야 한다. 그런데 서블릿을 구현할때 반드시 구현해야 하는 메소드는 요청할 때마다 호출되는 service() 하나 뿐이다. 나머지 메소드들은 필수적이지 않다. 그래서 나머지 메소드들에서는 딱히 할 작업이 없더라도 빈 메소드를 구현해야하는 불편함이 있다. GenericServlet은 service()를 제외한 나머지 4개 메소드인 init(), destroy(), getServiceConfig(), getServiceInfo() 가 미리 구현되어 있어 이런 불편함을 해소해준다. service()만 별도로 구현해주면 된다.

 

1. GenericServlet을 상속하는 계산기 서블릿 작성

import javax.servlet.GenericServlet;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import java.io.IOException;

public class CalculatorServlet extends GenericServlet {
    @Override
    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
        
    }
}

javax.servlet.GenericServlet을 상속하는 서블릿 클래스를 생성한다.

GenericServlet은 추상 클래스이므로 service()를 override해야 한다.

service()는 클라이언트가 요청할 때마다 호출되는 메소드로 실질적인 서비스 작업을 수행한다.

 

service()에 간단히 피연산자 2개를 받아 사칙연산과 % 연산을 수행하는 코드를 작성할 것이다.

 

@Override
public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
    int operand1 = Integer.parseInt(servletRequest.getParameter("operand1"));
    int operand2 = Integer.parseInt(servletRequest.getParameter("operand2"));
}

service()의 매개변수 중 ServletRequest 객체는 클라이언트의 요청 정보를 다룰때 사용한다.

ServletRequest의 getParameter()는 GET/POST 요청으로 들어온 매개변수 값을 꺼낼때 사용한다.

인자로 매개변수명을 넘긴다.

 

@Override
public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
    int operand1 = Integer.parseInt(servletRequest.getParameter("operand1"));
    int operand2 = Integer.parseInt(servletRequest.getParameter("operand2"));

    servletResponse.setContentType("text/plain");
    servletResponse.setCharacterEncoding("UTF-8");
}

ServletResponse 객체는 응답 관련 기능을 제공한다.

ServletResponse의 setContentType()은 클라이언트에게 출력할 데이터의 형식과 문자 집합을 지정한다. 클라이언트는 이를 보고 그 형식에 맞춰 올바르게 화면에 출력(Rendering)할 수 있다. 예를 들어 HTML 형식이면 태그 규칙에 맞춰 화면에 출력하고 XML 형식이면 각 태그를 트리 노드로 표현한다.

 

setContentType("text/plain")은 출력할 데이터가 별도의 메타정보가 없는 순수한 텍스트임을 지정한다.

 

setCharacterEncoding()은 출력할 데이터의 문자 집합을 지정한다. 이 메소드를 사용해도 되고 setContentType()에 다음과 같이 함께 넘겨도 된다.

 

setContentType("text/plain;charset=UTF-8")

 

문자 집합을 지정하지 않아 한글이 깨진 HTTP 응답 메시지(Fiddler)

기본 문자 집합은 ISO-8859-1이다. 위 코드와 같이 UTF-8로 지정하면 데이터를 출력할때 유니코드 값을 UTF-8 형식으로 변환하라는 의미이다. 문자 집합을 지정하지 않으면 한글이 깨져서 출력된다.

 

@Override
public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
    int operand1 = Integer.parseInt(servletRequest.getParameter("operand1"));
    int operand2 = Integer.parseInt(servletRequest.getParameter("operand2"));

    servletResponse.setContentType("text/plain");
    servletResponse.setCharacterEncoding("UTF-8");

    PrintWriter writer = servletResponse.getWriter();
    writer.println("operand1=" + operand1 + ", operand2" + operand2 + "의 계산 결과입니다.");
    writer.println(operand1 + " + " + operand2 + " = " + (operand1 + operand2));
    writer.println(operand1 + " - " + operand2 + " = " + (operand1 - operand2));
    writer.println(operand1 + " * " + operand2 + " = " + (operand1 * operand2));
    writer.println(operand1 + " / " + operand2 + " = " + ((double) operand1 / (double) operand2));
    writer.println(operand1 + " % " + operand2 + " = " + (operand1 % operand2));
}

ServletResponse의 getWriter()는 클라이언트로 출력할 수 있는 문자 기반 출력 스트림 객체를 반환한다.

지금은 텍스트를 출력할 것이므로 getWriter()를 사용했으며 이미지나 동영상같은 바이너리를 출력하려면 바이트 기반의 getOutputStream()을 사용한다.

 

※ 주의

setContentType()과 setCharacterEncoding()은 getWriter()를 호출하기 전에 호출해야 유니코드가 지정된 문자 집합으로 변환된다.

 

여기까지 작성한 CalculatorServlet의 전체 파일 내용은 다음과 같다. (import문 제외)

 

public class CalculatorServlet extends GenericServlet {
    @Override
    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
        int operand1 = Integer.parseInt(servletRequest.getParameter("operand1"));
        int operand2 = Integer.parseInt(servletRequest.getParameter("operand2"));
    
        servletResponse.setContentType("text/plain");
        servletResponse.setCharacterEncoding("UTF-8");
    
        PrintWriter writer = servletResponse.getWriter();
        writer.println("operand1=" + operand1 + ", operand2" + operand2 + "의 계산 결과입니다.");
        writer.println(operand1 + " + " + operand2 + " = " + (operand1 + operand2));
        writer.println(operand1 + " - " + operand2 + " = " + (operand1 - operand2));
        writer.println(operand1 + " * " + operand2 + " = " + (operand1 * operand2));
        writer.println(operand1 + " / " + operand2 + " = " + ((double) operand1 / (double) operand2));
        writer.println(operand1 + " % " + operand2 + " = " + (operand1 % operand2));
    }
}

2. 배치 및 테스트

web.xml에 CalculatorServlet의 배치 정보를 추가한다.

 

<servlet>
    <servlet-name>Calculator</servlet-name>
    <servlet-class>com.atoz_develop.servelets.CalculatorServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>Calculator</servlet-name>
    <url-pattern>/calc</url-pattern>
</servlet-mapping>

 

서버 재기동 후 URL에 operand1과 operand2의 매개변수 값을 붙여 요청한다.

 

실행 결과

 

참고 - @WebServlet 어노테이션을 이용한 서블릿 배치 정보 설정

위에서는 web.xml에 서블릿 배치 정보를 작성했지만 Servlet 3.0부터 어노테이션을 사용해서 서블릿 배치 정보를 설정할 수 있다.

 

@WebServlet("/calc")
public class CalculatorServlet extends GenericServlet {
	//...
}

위와 같이 설정하고 web.xml을 원복한 뒤 재실행하면 같은 결과가 출력된다.