개발을 통한 자기수양 - benelog

2008/05/23   Java에서 Checked Exception은 언제 써야 하는가?
2008/05/16   Digester를 이용한 Naver Open API Java Client 모듈 [3]
2008/04/17   Effective Java에 대한 서평에 재미있는 댓글 [4]

  Java 의 Exception 처리는 C++에서 도입되었지만 checked exception은 Java만의 독특한 특징입니다. 아시다시비, 컴파일러가 exception을 꼭 처리해라고 강요하는 것이죠.  이것은  java 이후에 설계된 언어인 C#이나 루비에도 채택되지 않았습니다. 즉 Java 이외의 다른 언어들의 Exception 처리 방식은 Java의 unchecked exception과 동일한 방식입니다.

  Java의 초기에 checked Exception의 사용을 권장하던 것에 대해서 지금은 많은 반론이 제기되고 있습니다. 극단적으로 Java언어의 Checked Exception 도입 자체가 실패라고 주장하는 사람도 많습니다. Thinking in Java의 저자인 Bruce Eckel도 그 중 한 사람입니다.  Spring framework의 아버지 Rod Johnson도 Checked Exception이 쓰여야 할 때도 있지만 그 것이 과도하게 선호되어 온 것은 지적하고 있습니다.

  어쨓든 Exception 부분은 Java로 API 설계와 코딩를 할 때 가장 어려운 부분이라고 느껴집니다. Java 아키텍트와 개발팀의 실력을 측정하는 좋은 방법은 그들이 만든 Exception 처리 코드를 보라는 말까지 있으니까요.

 

 Exception 처리 방식 참고자료

• Effective Java  중 Chapter 8 (Item 39~47)

  • 8장 예외처리 페이지에 정리해 놓았습니다.

 

• Expert One-on-One J2EE Design and Development 중 Chapter 4 Design Techniques and Coding Standards for J2EE Projects, Exception Handling 부분

  • alternative return value가 있는 경우에는 Checked exception
  • data connection 생성 실패와 같이 뭔가 크게 잘못 되고 있어서 호출한 쪽에서 아무도 이를 처리할 수 없을 때는 Runtime exception.
  • 소수의 호출자만이 Exception을 받아서 처리해야 할 때도 Runtime exception.
  • 불명확하면 Runtime exception.
  • checked Exception과 Runtime exception 페이지에서 일부 내용이 번역되어 있습니다.
  • Spring 프레임웍크 워크북 (박재성 저) 88쪽에도 인용되어 있는 원칙입니다.

 

• Barry Ruzek의  EFFECTIVE JAVA EXCEPTIONS

  • Fault Handling(Unplanned condition)에는 RuntimeException, Contingency(Expected condition, alternative method result)에는 return type, exception, error code 등의 전략을 사용
  • Fault를 한곳에서 잡아서 처리하는 Fault barrier pattern 사용 권장. Struts라면 org.apache.struts.action.ExceptionHandler, SpringMVC라면 SimpleMappingExceptionResolver
  • AOP 적용이 도움이 될 수도 있음.
  • 황상철님의 블로그 Effective Java Exceptions 발표자료 페이지에서 이 내용이 요약된 pdf 파일을 받을 수 있습니다. (effective java exceptions.pdf )

 

• Jim Cushing  Three Rules for Effective Exception Handling

  •  Be specific, Throw Early, Catch Late의 3가지 원칙을 제시하고 있습니다.

 

• 13 Exceptional Exception Handling Techniques

  • Checked Exception을 RuntimeException으로 감싸기, throws 절에 RuntimeException이라도 선언해주기 등의 기법을 추천하고 있습니다.

 

• Gunjan Doshi의 Best Practices for Exception Handling

  • Client code가 할 일이 있을 때는 checked, 없을 때는 unchecked. progamming error에는 unchecked exception.
  • 적절한 캡슐화. 비지니스 layer에서 SqlException을 던지지 말것.

 

• Rob Walling의 Exception Handling에 관한 글 The Two Fundamental, No Frills, Square One Rules of Exception Handling

  1. 에러메시지에 도움이 되는 정보를 더할 수 없다면, Exception을 잡지마라, 2. Exception을 잡았으면 기록하라." 두가지 원칙을 말하고제시하고 있습니다.

 

• Alan Griffiths의 Exceptional Java

  • 이 주제에 대해 비교적 초기에 나온 글로써, 다른 글에도 많이 인용되고 있습니다.
  • Exception 처리에 대한 전통적인 원칙이 캡슐화 저해, 정보손실, 정보 과적의 문제를 일으킨다고 이야기합니다.
  • public 메소드에서 던지는 Exception은 해당 패키지에 소속된 클래스일것, 다른 패키지에서는 이를 부를 때를 Exception을 전파시키지 말고 그 패키지의 Exception으로 감쌀 것을 추천하고 있습니다.

 

• An Exception Handling Framework for J2EE Applications

  •  J2EE application에서의 Exception처리 전략에 대해서 설명하고 있습니다.

 

Checked Exception에 대한 부정적 견해를 정리한 글

• Brian Goetz의 글: Java theory and practice: The exceptions debate

  • Bruce Eckel, Rod Johnson, Joshua Bloch등의 주장을 정리해 놓은 글입니다. Checked Exception이 상세한 구현을 부적절하게 노출함,불안정한 메소드 시그너처,읽기힘든 코드,Exception 삼키기,너무 많은 Exception wrapping의 문제점 있는 것을 나열하고 있습니다. unchecked exception은 Documentation이 더욱 중요하다고 강조하고 있습니다.

 

• Rod Waldhoff의 글 : Java's checked exceptions were a mistake

  • Java의 Exception Handling은 실패한 실험이라고 주장하는 내용입니다. Checked Exception방식은 일부 low level에서만 의미가 있다고 말합니다.

 

• Bruce Eckel의 견해(Thinking in Java의 저자): Does Java need Checked Exceptions?

  • Error report 방식을 통일했다는 점에서는 의미가 있지만, 오히려 개발자들이 Exception을 그냥 삼키는 코드를 많이 짜게 하는 결과가 생겼다고 지적합니다.

 

• Bill Venners(C#의 아키텍트)와 Bruce Eckel의 인터뷰 : The Trouble with Checked Exceptions

  • versioning, scalability의 문제 때문에 C#에  Checked Exception이 도입되지 않았다고 밝히고 있습니다.

Checked Exception에 대한 논의가 진행된 페이지

• Java Exceptions Are Particularly Evil
• Checked Exceptions Are Of Dubious Value
• Exception Tunneling
• Opinion: The Eternal Debate on Checked Exceptions : theserverside에서 벌어진 논쟁

 

이클립스 Exception처리 코드 템플릿 관련 자료

• Exception Handling
• 이클립스의 기본 try-catch 탬플릿 비추

네이버 Open API Cafe에서 검색 API의 Java Client 모듈을 보게 되었습니다.

http://cafe.naver.com/ArticleRead.nhn?clubid=11906219&page=1&menuid=3&boardtype=L&articleid=1372

http://insford.tistory.com/116

위의 모듈을 참고해서 같은 역할을 하는 모듈을 다르게 구현해봤습니다.

특징은 아래와 같습니다.

•  RSS를 파싱하는 부분을 XML parsing API로 널리 알려진 Digester(http://commons.apache.org/digester/)를 사용했습니다. Digester의 예제 코드로 제공되는 RSS파싱모듈을 그대로 써서 짧은 코드로 파싱이 가능했습니다. 사용한 모듈의 API문서는 다음의 링크에서 볼 수 있습니다.

      (RSSDigester , Channel , Item)

• 요 청 파라미터를 담는 클래스를 따로 뺐습니다.  (RequestParameter.java) 이중 Target 값은 (blog, news 등 검색할 컨텐츠 유형을 선택하는 파라미터입니다.) enum으로 해서 정해진 값이 아닐 경우 compile이 안 되게 했습니다.

• open API key값은 필수값이므로 OpenApiClient클래스의 생성자의 파라미터로 받았습니다. 대신 키 값이 없이 이 객체가 생성될 수 없도록 default 생성자는 private으로 돌려놨습니다.

첨 부한 파일은 이클립스에서 Dynamic Web Project로 생성한 폴더를 압축한 것입니다. 테스트 실행 서버는 Tomcat 5.5를 사용했습니다. Eclipse WTP가 설치되어 있는 환경이면 실행이 가능합니다. 그리고 enum을 썼기에 Java5이상이어야 합니다.

Open API에 대한 자세한 사용법은 http://openapi.naver.com/index.nhn 를 참조하시면 됩니다.

소스코드

전체 소스와 라이브러리 다운받기 : open-api-test.zip

package openapiclient;

import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLEncoder;

import org.apache.commons.digester.rss.Channel;
import org.apache.commons.digester.rss.RSSDigester;

public class NaverSearchClient {
 
 private static final String OPEN_API_URL = "http://openapi.naver.com/search";
 private String key;
 
 @SuppressWarnings("unused")
 private NaverSearchClient(){};
 
 public NaverSearchClient(String key){
  this.key = key;
 }
 public Channel search(RequestParameter param) throws Exception{
  RSSDigester digester = new RSSDigester();
  URL requestUrl = getRequestUrl(param);
  InputStream is = requestUrl.openConnection().getInputStream();
  return (Channel) digester.parse(is);
 }

 private URL getRequestUrl(RequestParameter param) throws UnsupportedEncodingException, MalformedURLException {
  StringBuffer serverUrl = new StringBuffer(OPEN_API_URL);
  serverUrl.append("?target=" + param.getTarget());
  serverUrl.append("&key=" + key);
  serverUrl.append("&start=" + param.getStart());
  serverUrl.append("&display=" + param.getDisplay());
  serverUrl.append("&query=" + URLEncoder.encode(param.getQuery(), "UTF-8"));
  if(param.getSort()!=null) serverUrl.append("&sort=" + param.getSort());
  return new URL(serverUrl.toString());
 }
}

 package openapiclient;

public class RequestParameter {
 
 public enum Category{
  KIN,BLOG,CAFE,DOC,WEBKR,BOOK, SHOP, ENCYC,
  KRDIC, JPDIC, ENDIC, NEWS, LOCAL, VIDEO,IMAGE;  
  public String toString(){
   return super.toString().toLowerCase();
  }
 }

 private Category target;
 private String sort;
 private int start;
 private int display;
 private String query;

 // getter and setters 생략
 }

JSP에서 사용한 예제

JSTL을 함께 사용해서 찍어본 예제입니다. http://openapi.naver.com/index.nhn 에 가셔서 API key를 발급 받으시고 소스 중간에 밑줄로 표시된 부분에 그 값을 넣으시고 돌려주시면 됩니다.

<%@ page language="java" contentType="text/html; charset=EUC-KR"   pageEncoding="EUC-KR"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page import="openapiclient.RequestParameter" %>
<%@ page import="openapiclient.NaverSearchClient" %>
<%@ page import="org.apache.commons.digester.rss.Channel" %>
<%
 String KEY = "????"; // Open API key값을 넣으세요
 NaverSearchClient client = new NaverSearchClient(KEY);
 RequestParameter param = new RequestParameter();
 param.setDisplay(10);
 param.setStart(1);
 param.setQuery("미역국");
 param.setTarget(RequestParameter.Category.NEWS);
 Channel result = client.search(param);
 result.render(System.out); // 콘솔에 받아온 내용을 확인삼아 찍어봄
 request.setAttribute("result", result);
%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=EUC-KR">
<title>Naver Open API를 이용한 검색</title>
</head>
<body>
<c:forEach var='item' items='${result.items}'>
  <p>
  <a href="${item.link}"> ${item.title} </a> <br/>
  ${item.description}
  </p>
</c:forEach>
</body>
</html>

실행결과화면

 

Effective Java의 Second Edition이 나올 때가 되지 않았나 싶어서 아마존에 가봤더니 아직이군요. 5월28일로 발매가 예정되어 있습니다. (http://www.amazon.com/Effective-Java-Second-2nd/dp/0321356683/ref=pd_bbs_sr_1?ie=UTF8&s=books&qid=1208402810&sr=8-1)

대신 Effective Java의 서평 중에서 재밌는 내용을 발견했습니다.

http://www.amazon.com/review/R296QBPY6ZC2LB/ref=cm_cr_pr_cmt?_encoding=UTF8&ASIN=0201310058#wasThisHelpful


This book can't really seem to find a target audience. It jumps around giving advice about how to comment in one section, and then talks about cache coherency in multiple processor environments in other sections. So after being a recent Computer Science graduate, I found that about 35% of the material was useful or interesting.


E. Richardson says: