* 회원가입 * 아이디/비밀번호 찾기   ID PW
Last Modified : 2008.11.20

서블릿 문법

JSP는 서블릿 기반 기술입니다.
그러므로 서블릿에 대한 기본적인 이해를 한 다음 JSP를 이해하는 것이 낫다고 생각합니다.
JSP는 톰캣과 같은 서블릿 엔진(또는 컨테이너)에 의해 결국 서블릿으로 변환 후에 서비스됩니다.
서블릿은 CGI 프로그래밍에 대한 자바측 기술로 등장했고, JSP는 마이크로소프트 진영의 ASP가 인기를 끌자 ASP에 대응하기 위한 자바측 기술로 나타납니다.

서블릿은 javax.servlet 과 javax.servlet.http 두개의 팩키지로 이루어져 있습니다.
javax.servlet 팩키지는 모든 서블릿이 상속하거나 구현하는 일반적인 인터페이스와 클래스로 구성되어 있습니다.
javax.servlet.http 팩키지는 HTTP 프로토콜에 맞춘 서블릿 클래스로 구성됩니다.
javax.servlet.Servlet 인터페이스는 서블릿 아키텍처의 핵심이며 모든 서블릿의 기초가 됩니다.
Servlet 인터페이스에는 5개의 메소드가 있는데 그 중 가장 중요한 3개의 메소드는 다음과 같습니다.

  • init() : 서블릿을 초기화
  • service() : 클라이언트 요청에 대한 서비스
  • destory() : 자원반납

이들 메소드는 서블릿 라이프사이클(생명주기) 메소드입니다.
모든 서블릿은 상속을 통해서든 아니면 직접적인 구현을 통해서든 반드시 Servlet 인터페이스를 구현해야 합니다.

1. 서블릿의 기본 골격인 인터페이스와 클래스

아래 그림은 서블릿의 기본 골격이 되는 인터페이스와 클래스를 보여주고 있습니다.
이어지는 설명을 쉽게 이해하기 위해서는 아래 클래스 다이어그램을 기억해야 합니다.
(GenericServlet, HttpServlet의 모든 속성과 메소드가 그림에 표시된 것은 아닙니다.)
Servlets Framework

(1) Setvlet 인터페이스

모든 서블릿은 Servlet 인터페이스를 구현해야 합니다.
서블릿의 라이프사이클 메소드를 선언하고 있는 인터페이스가 javax.servlet.Servlet 인터페이스 입니다.
라이프 사이클 메소드는 init, service, destory 메소드입니다.

init

init() 메소드는 서블릿이 그 일생을 시작하게 하는 메소드입니다.
init() 메소드는 서블릿이 인스턴스가 된 후 서블릿 컨테이너에 의해 호출되는데 한번만 호출됩니다.
서블릿은 어떤 요청을 받기 전에 반드시 반드시 init 메소드가 성공적으로 수행되어야만 합니다.
init() 메소드가 성공적으로 수행되면 비로소 서블릿은 서비스 상태가 됩니다.

init ( config : ServletConfig )

void init(ServletConfig config) throws ServletException;

init() 메소드는 파라미터로 ServletConfig 객체를 전달받습니다.
ServletConfig 객체는 서블릿의 설정과 초기화 파라미터 정보를 담고 있습니다.
init() 메소드는 ServletException 을 던질 수 있도록 선언되어 있습니다.

service

service() 메소드는 클라이언트가 서블릿을 요청하면 서블릿 컨테이너에 의해 호출되는 메소드입니다.

service ( req : ServletRequest, res : ServletResponse )

void service( ServletRequest req, ServletResponse res) throws ServletException,IOException;

service() 메소드는 ServletRequest 와 ServletResponse 2개의 파라미터를 가집니다.
ServletRequest 는 클라이언트 요청 정보를 담고 있습니다.
ServletResponse 는 요청에 대한 응답을 클라이언트에게 하기 위해 사용합니다.
service() 메소드는 클라이언트의 요청을 서블릿이 응답하도록 서블릿 컨테이너에 의해 호출됩니다.
서블릿은 멀티스레드 프로그램인 서블릿 컨테이너 속에서 동작하기 때문에 수많은 클라이언트의 요청에 대해 지체하지 않고 응답을 할 수 있습니다.
그러므로 서블릿에서 공유되는 자원(파일이나 네트워크 커넥션, 클래스 변수, 인스턴스 변수)이라면 모두 동기화되어야 합니다.
서블릿 프로그래밍에서 클래스 변수나 인스턴스 변수는 보통 만들지 않습니다.

destory

서블릿 라이프의 끝을 의미합니다.
웹 애플리케이션이 shutdown 될때, 서블릿의 destory() 메소드가 호출됩니다.

destory ()

void destroy();

(2) GenericServlet 추상클래스

GenericServlet는 Servlet를 구현한 클래스입니다.
GenericServlet 의 service() 메소드는 추상 메소드이기 때문에 GenericServlet 를 상속하는 자식 클래스에서는 이 service() 메소드를 구현해야 합니다.

<<abstract>> + service ( req : ServletRequest, res : ServletResponse )

public abstract void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;

(3) HttpServlet 클래스

HttpServlet 클래스는 GenericServlet 추상 클래스를 상속합니다.
HttpServlet 클래스는 GenericServlet 의 service() 추상 메소드를 구현하고 있습니다.
따라서 HttpServlet 클래스를 상속하는 클래스는 service() 메소드를 일반적으로 구현할 필요가 없습니다.
이 메소드는 GenericServlet 의 service () 추상 메소드를 구현한 메소드입니다.

+ service ( req : ServletRequest, res : ServletResponse )

public void service(ServletRequest req, ServletResponse res) throws ServletException,IOException {.. }

메소드의 구현 내용은 단지 클라이언트의 요청을 protected service() 메소드에 전달하는 것입니다.
아래는 proctected service () 메소드입니다.

# service ( req : HttpServletRequest, res : HttpServletResponse )

protected void service(HttpServletRequest req, HttpServletResponse res) throws ServletException,IOException {.. }

HttpServlet 의 + service() 는 단지 # service() 메소드에게 제어권을 넘기는 역할만 합니다.
HttpServlet 클래스의 # service() 메소드가 호출되면 이 메소드는 request 안에서 HTTP METHOD 타입값(POST, GET)을 읽어내고 이 값에 따라서 doGet(), doPost() 메소드를 호출합니다.
이 doGet(), doPost() 가 우리가 오버라이딩 해야 하는 메소드입니다.
HTTP METHOD 타입이 GET 이면 doGet()를, HTTP METHOD 타입이 POST 이면 doPost()를 오버라이딩 해야 합니다.
HttpServlet 클래스의 # service () 메소드에 전달되는 파라미터, HttpServletRequest 와 HttpServletResponse 는 GenericServlet 클래스에 전달되는 파라미터였던 ServletRequest, ServletResponse 각각을 상속한 인터페이스입니다.
HttpServletRequest 와 HttpServletResponse 를 구현한 클래스는 서블릿 컨테이너가 생성하여 서블릿의 + service () 메소드에 아규먼트로 전달됩니다.
이렇듯 HttpServletRequest, HttpServletResponse 를 구현한 클래스는 서블릿 컨테이너를 제작하는 벤더의 몫입니다.

2. 간단한 서블릿 예제와 설명

지금까지 서블릿이 무엇이고 어떻게 작동하는에 관한 내용이었습니다.
이제 간단한 서블릿 예제를 만들어 보겠습니다.

SimpleServlet.java

package example;

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.*;
import java.util.*;

public class SimpleServlet extends HttpServlet {
  public void doGet( HttpServletRequest req, HttpServletResponse res ) 
    throws ServletException, IOException {
    doPost(req,res);
  }

  public void doPost( HttpServletRequest req, HttpServletResponse res ) 
    throws ServletException, IOException {
    res.setContentType( "text/html;charset=euc-kr" );
    PrintWriter out = res.getWriter();
    
    out.println("<html>");
    out.println("<body>");
    
    //요청한 클라이언트의 IP를 출력합니다.
    out.println("당신의 IP 는 " + req.getRemoteAddr() + "입니다.\n");
    out.println("</body></html>");
    out.close();
  }
}

SimpleServlet 가 init() 과 destory() 메소드를 구현하고 있지 않습니다.
이 메소드들은 GenericServlet 이 구현하고 있기에 구현하지 않아도 되는 것입니다.

(1) SimpleServlet을 컴파일, 실행

(a) ROOT 웹 애플리케이션의 WEB-INF/web.xml 파일을 열고 web-app 엘리먼트의 자식 엘리먼트로 아래를 추가합니다.

web.xml

.. 중간 생략 ..

    <servlet>
      <servlet-name>SimpleServlet</servlet-name>
      <servlet-class>example.SimpleServlet</servlet-class>
    </servlet>

    <servlet-mapping>
      <servlet-name>SimpleServlet</servlet-name>
      <url-pattern>/servlet/SimpleServlet</url-pattern>
    </servlet-mapping>

.. 중간 생략 ..

(b) SimpleServlet.java 를 소스가 있는 폴더에서 아래와 같이 컴파일합니다.
javac -d C:/www/myproject/WEB-INF/classes -classpath C:/apps/tomcat/common/lib/servlet-api.jar SimpleServlet.java

package javax.servlet.http does not exist

SimpleServlet.java 를 컴파일할 때 위와 같은 컴파일 에러가 나온다는 것은 자바 컴파일러가 javax.servlet.http 팩키지를 찾지 못한다는 의미로, classpath 옵션의 값으로 servlet-api.jar 파일의 풀패스를 잘못 적었기 때문입니다.
만약 C:/apps/tomcat 와 달리 중간에 공백이 있는 디렉로리(예를 들면, C:/apps/Tomcat 5.5 )에 Tomcat 을 설치했다면 classpath 옵션에 값을 줄 때 "" 으로 묶어주면 됩니다.
다른 방법으로는 CLASSPATH 란 환경변수에 TOMCAT_HOME/common/lib/servlet-api.jar 를 추가해주면 아래와 같이 classpath 옵션을 사용하지 않고도 컴파일을 할 수 있습니다.
javac -d C:/www/myproject/WEB-INF/classes SimpleServlet.java

(c) C:/apps/Apache2/conf/httpd.conf 파일을 열고
JkMount /*.jsp tomcat1 다음에 JkMount /servlet/* tomcat1 를 추가합니다.

httpd.conf

.. 중간 생략 ..

JkMount /*.jsp tomcat1
JkMount /servlet/* tomcat1

.. 중간 생략 ..

(d) 아파치, Tomcat 을 재시작한 후 http://localhost/servlet/SimpleServlet 로 방문합니다.

(2) SimpleServlet 코드 설명

SimpleServlet 에서 doGet()과 doPost() 이 두 메소드는 HttpServlet 의 doGet(), doPost() 메소드를 오버라이드 한 메소드입니다.
모든 비즈니스 로직이 이 메소드에 존재합니다.
예제에서 doGet() 메소드는 단순히 doPost() 메소드를 호출합니다.

아래 코드는 응답(HttpServletResponse)의 컨텐츠타입을 셋팅하는 작업을 합니다.
이 코드는 서블릿에서 단 한번만 사용이 가능합니다.
또한 OutputStream 으로서 PrintWriter 를 코딩하기에 앞서 위 코딩 작업이 이루어져 있어야 합니다.
PrintWriter 의 획득은 HttpServletResponse 의 getWriter() 을 호출함으로써 이루어집니다.

res.setContentType( "text/html;charset=euc-kr" );
PrintWriter out = res.getWriter();

PrintWrtier는 클라이언트로의 응답으로 보내는 스트림에 글을 쓸 수 있게 합니다.
그러면 클라이언트의 브라우저에서 이 글을 볼 수 있게 됩니다.
클라이언트에 텍스트를 보낼 수 있는 객체에 대한 레퍼런스(out)를 얻었으므로,
이 객체를 사용하여 클라이언트에게 메시지를 전달할 수 있는 것입니다.
이 메시지는 HTML를 포함하고 있습니다.
이는 메시지가 클라이언트의 웹브라우저에 보이게 하기 위함입니다.
다음 몇 라인은 이것이 어떻게 행해지는지 보여주고 있습니다.

out.println( "<html>" );
out.println( "<body>" );
//요청한 클라이언트의 IP를 출력합니다.
out.println( "당신의 IP 는 " + req.getRemoteAddr() + "입니다.\n" );

위에서 보듯이 SimpleServlet는 클라이언트에게 HTML을 보내기 위해 PrintWriter의 println()메소드를 사용하고 있습니다.
req.getRemoteAddr() 부분은 클라이언트에서 보내온 정보를 이용합니다.
즉, HttpServletRequest 의 getRemoteAddr() 메소드를 호출하여 클라이언트의 주소를 반환받고 있습니다. 이렇게, HttpServeltRequest 는 클라이언트가 보내거나, 클라이언트에 관한 정보를 담고 있습니다.

다음은 기본적으로 한번은 읽어 봐야 할 서블릿 클래스와 메소드를 정리해 놓은 것입니다.

3. 서블릿 클래스, 인터페이스 요약

Servlet 인터페이스
init (config:ServletConfig)
service(req:ServletRequest, res:ServletResponse)
destroy()
getServletConfig() : ServletConfig
서블릿 초기화에 관련된 변수를 가지고 있는 ServletConfig 객체를 리턴
getServletInfo() : String
서블릿에 대한 간단한 정보를 리턴
ServletConfig 인터페이스
getInitParameter(name:String) : String
name에 해당하는 초기화 파라미터 값을 리턴
getInitParameterNames() : Enumeration
서블릿의 초기화 파라미터 이름들을 Enumeration 타입으로 리턴
getServletContext() : ServletContext
ServletContext 를 리턴
getServletName() : String
서블릿 인스턴스의 이름 리턴
+ GenericServlet 추상 클래스
프로토콜에 무관한 기본적인 서비스 기능을 제공하는 클래스로 Servlet, ServletConfig 인터페이스를 구현
+ init()
서블릿 초기화 메소드로, GenericServlet의 init(config:ServletConfig) 메소드의 의해 호출됨
<<abstract>> + service (req:ServletRequest, res:ServletResponse)
Servlet 인터페이스의 service() 메소드를 추상 메소드로 남겨둠.
HttpServlet 추상 클래스
GenericServlet 추상 클래스 상속
# doGet (req:HttpServletRequest, res:HttpServletResponse)
HTTP의 GET 요청을 처리하기 위한 메소드
# doPost (req:HttpServletRequest, res:HttpServletResponse)
HTTP의 POST 요청을 처리하기 위한 메소드
+ service (req:ServletRequest, res:ServletResponse)
GenericServlet 추상클래스의 추상 메소드 service() 구현, 아래 service() 메소드에 호출
# service (req:HttpServletRequest, res:HttpServletResponse)
클라이어트의 요청에 따라 doGet(), doPost() 메소드 호출
ServletContext 인터페이스
서블릿이 서블릿/JSP 컨테이너와 통신하기 위해서 사용하는 메소드 제공( 예를 들면 파일의 MIME 타입을 얻거나 RequestDispatcher를 얻거나 로그파일에 기록하기 등등..) 웹 애플리케이션마다 하나의 ServletContext 객체가 존재하고 ServletContext 는 ServletConfig의 getServletContext() 메소드를 이용해서 얻을 수 있음.
웹 애플리케이션 전체의 공동 저장소를 역할을 하는데 ServletContext 에 저장된 데이터는 ServletContext 를 공유하는 서블릿이나 JSP에서 자유롭게 접근할 수 있음.
setAttribute (name:Strng, value:Object)
데이터를 이름과 값의 쌍으로 저장한다.
getAttribute (name:String) : Object
이름을 이용해서 저장된 데이터를 리턴
removeAttribute(name:String)
name에 해당하는 데이터를 삭제
getInitParameter(name:String) : String
웹 애플리케이션 전영역에 대한 초기화 파라미터 이름에 해당하는 값 반환
getRequestDispatcher(path:String) : RequestDispatcher
주어진 Path 를 위한 RequestDispatcher 를 리턴
getRealPath(path:String) : String
주어진 가상 Path의 실제 Path를 리턴
getResource(path:String) : URL
주어진 Path 에 해당되는 자원의 URL을 리턴
log(msg:String)
로그에 기록
log(String message, Throwable throwable)
로그에 기록
RequestDispatcher 인터페이스
클라이언트의 요청을 다른 자원(서블릿,JSP 등)으로 전달하기 위해서 사용
forward(req:ServletRequest, res:ServletResponse)
클라이언트의 요청을 다른 자원으로 전달
include(req:ServletRequest, res:ServletResponse)
다른 자원의 내용을 응답에 포함
ServletRequest 인터페이스
서블릿에 대한 클라이언트의 요청 정보을 담고 있음.
setAttribute(name:String,o:Object)
객체를 주어진 이름으로 저장
getAttribute(name:String) : Object
주어진 이름의 저장된 데이터를 리턴
removeAttribute(name:String)
주어진 이름의 데이터를 삭제
getInputStream() : ServletInputStream
클라이언트 요청의 바디에 있는 바이너리 테이터를 읽기 위한 입력 스트림 리턴
getParameter(name:String) : String
클라이언트의 요청에 포함되어 있는 파라미터 이름에 해당하는 값 리턴
getParameterNames() : Enumeration
클라이언트의 요청에 포함되어 있는 모든 파라미터 이름을 Enumeration 타입으로 리턴
getParameterValues(name:String) : String[]
주어진 이름의 파라미터 값을 String 배열로 리턴, 동일한 이름으로 값이 여러 개 있을 경우 사용
getServletPath() : String
"/" 로 시작하는 경로를 리턴. 경로에 쿼리스트링은 포함되지 않음.
HttpServletRequest 인터페이스
ServletReqeust 상속
getCookies() : Cookie[]
브라우저가 전달한 쿠키 배열을 리턴
getSession() : HttpSession
현재 세션(HttpSession)을 리턴
getSession(created:boolean) : HttpSession
현재 세션을 리턴, 만약 세션이 없는 경우 created 가 true 이면 세션을 생성후 리턴
ServletResponse 인터페이스
클라이언트에 응답을 보내기 위해 사용
getOutputStream() : ServletOutputStream
응답에 바이너리 데이터를 전송하기 위한 출력 스트림 리턴
getWriter() : PrintWriter
응답에 문자 데이터를 전송하기 위한 출력 스트림 리턴
setContentType(type:String)
클라이언트로 전달되는 내용의 MIME 타입을 설정
HttpServletResponse 인터페이스
ServletResponse 인터페이스를 상속, HTTP 응답을 클라이언트에 전송하는 역할
addCookie(cookie:Cookie)
응답에 쿠키를 전송
sendRedirect(location:String)
주어진 URL로 리다이렉트
HttpSession 인터페이스
getAttribute(name:String) : Object
setAttribute(name:String, value:Object)
removeAttribute(name:String)
invalidate()
Cookie
+ Cookie(name:String, value:String)
+ getDomain() : String
+ getMaxAge() : int
+ getName() : String
+ getPath() : String
+ getSecure() : boolean
+ getValue() : String
+ setDomain(pattern:String)
+ setMaxAge(expiry:int)
+ setPath(uri:String)
+ setSecure(flag:boolean)
+ setValue(newValue:String)

참고

http://java.sun.com/javaee/5/docs/api/