쿠키는 웹 어플리케이션에서 클라이언트의 정보를 임시로 저장하기 위해 많이 사용된다. 또한, 클라이언트의 상태를 유지할 때 사용되는 세션을 구현하기 위해 쿠키를 사용하기도 한다. 쿠키는 약방의 감초와 같은 존재로서, 쿠키를 사용함으로써 좀더 쉽고 간결한 방법으로 웹 어플리케이션을 구현할 수 있게 되는 경우가 많다.
쿠키가 사용되는 부분은 많은데, 서블릿 API의 쿠키 지원 클래스는 2.4 버전이 나올 때 까지 여전히 빈약하다. 서블릿 API의 javax.servlet.http.HttpServletRequest 인터페이스가 제공하는 쿠키 관련 메소드는 아래에 표시한 한개뿐이다.
public Cookie[] getCookies()
HttpServletRequest 인터페이스가 쿠키 관련된 메소드를 빈약하게 제공하기 때문에(진짜 심하게 빈약함이 느껴진다!!), JSP나 서블릿 등에서 쿠키를 사용할 때에는 쿠키를 다루기 위한 보조 클래스를 작성해서 작업하는 것이 좋다. 본 글에서는 편리하게 쿠키를 처리할 수 있도록 해 주는 CookieBox 라는 클래스를 작성해볼 것이다.
CookieBox 클래스의 소스 코드
말보다는 소스 코드를 직접 보면서 설명하는 것이 이해가 빠를 것 같으므로, CookieBox 클래스의 소스 코드부터 살펴보도록 하자.
package jsp.util;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Cookie;
import java.util.Map;
import java.net.URLEncoder;
import java.net.URLDecoder;
import java.io.IOException;
public class CookieUtil {
private Map cookieMap = new java.util.HashMap();
public CookieUtil (HttpServletRequest request) {
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (int i = 0 ; i < cookies.length ; i++) {
cookieMap.put(cookies[i].getName(), cookies[i]);
}
}
}
public static Cookie createCookie(String name, String value)
throws IOException {
return new Cookie(name, URLEncoder.encode(value, "euc-kr"));
}
public static Cookie createCookie(
String name, String value, String path, int maxAge)
throws IOException {
Cookie cookie = new Cookie(name,
URLEncoder.encode(value, "euc-kr"));
cookie.setPath(path);
cookie.setMaxAge(maxAge);
return cookie;
}
public static Cookie createCookie(
String name, String value,
String domain, String path, int maxAge)
throws IOException {
Cookie cookie = new Cookie(name,
URLEncoder.encode(value, "euc-kr"));
cookie.setDomain(domain);
cookie.setPath(path);
cookie.setMaxAge(maxAge);
return cookie;
}
public Cookie getCookie(String name) {
return (Cookie)cookieMap.get(name);
}
public String getValue(String name) throws IOException {
Cookie cookie = (Cookie)cookieMap.get(name);
if (cookie == null) return null;
return URLDecoder.decode(cookie.getValue(), "euc-kr");
}
public boolean exists(String name) {
return cookieMap.get(name) != null;
}
}
CookieBox 클래스는 다음과 같이 두 가지 종류의 메소드를 제공한다.
- Cookie 객체를 생성할 때 사용할 수 있는 static 메소드인 createCookie()
- HttpServletRequest의 Cookie 객체 및 쿠키값을 읽어올 수 있는 메소드
CookieUtil 클래스를 이용한 쿠키값 읽기
먼저, CookieUtil 클래스를 사용하면 손쉽게 쿠키를 사용할 수 있다. CookieUtil 는 다음과 같은 형태로 사용할 수 있다.
// CookieUtil 클래스의 생성자는 request로부터 쿠키 정보를 추출
CookieUtil cookie = new CookieUtil(request);
Cookie idCookie = cookie.getCookie("id"); // 쿠키가 존재하지 않으면 null 리턴
// 지정한 이름의 쿠키가 존재하는지의 여부
if (cookieBox.exists("name")) {
...
}
// 지정한 이름의 쿠키가 존재하지 않으면 값으로 null 리턴
String value = cookie.getValue("ROLE");
일단 CookieBox 객체를 생성한 이후에는 세 개의 메소드(getCookie(), exists(), getValue())를 사용해서 손쉽게 Cookie 객체 및 쿠키값을 사용할 수 있게 된다. 별도의 유틸리티 클래스를 사용하지 않고 쿠키를 사용할 때는 다음과 같은 방식을 사용하게 되는데, 아래 코드와 비교하면 얼마나 위 코드가 간단한 형태인지를 알 수 있을 것이다.
Cookie[] cookies = request.getCookies();
Cookie idCookie = null;
if (cookies != null) {
for (int i = 0 ; i < cookies.length ; i++) {
if (cookies[i].getName().compareTo("id") == 0) {
idCookie = cookies[i];
}
}
}
CookieUtil 클래스를 이용한 Cookie 생성
javax.servlet.http.Cookie 클래스가 제공하는 생성자는 다음과 같이 한개 뿐이기 때문에,
Cookie(java.lang.String name, java.lang.String value)
쿠키에 대한 도메인, 경로, 유효시간 등을 설정하기 위해서는 다음과 같은 코드를 사용해야 한다.
Cookie cookie = new Cookie(name, URLEncoder.encode(value, "euc-kr"));
cookie.setDomain(domain);
cookie.setPath(path);
cookie.setMaxAge(maxAge);
CookieBox 클래스는 static 메소드인 createCookie() 메소드를 통해서 적은 코딩량으로 손쉽게 Cookie 객체를 생성할 수 있도록 지원한다. 예를 들어, CookieBox.createCookie() 메소드를 사용하면 위 코드를 다음과 같이 한줄로 변경할 수 있다.
Cookie cookie = CookieUtil.createCookie(name, value, domain, path, maxAge);
CookieUtil.createCookie() 메소드가 세 가지 형태로 존재하기 때문에, 그때 그때 알맞은 메소드를 사용해서 Cookie 객체를 생성할 수 있을 것이다.
)
)
)
)
)
