devMomo

[findbugs] FileWriter, FileReader DM_DEFAULT_ENCODING 처리하기

ASH84 — Sun, 15 Apr 2012 00:01:14 +0900

findbugs를 통해서 잠재적 위험 검사를 할때, 일반적으로 텍스트 파일을 읽거나 쓰는 코드에서 DM_DEFAULT_ENCODING 경고가 뜬다.

 
FileReader logReader = new FileReader(log);

FileWriter logReader = new FileWriter(log);

해당 잠재적 위험에 대한 내용을 살펴보면,

Bug:

Found reliance on default encoding in com.logamg.analysis.LogAnalysis.analysisLog(String): new java.io.FileReader(File) Found a call to a method which will perform a byte to String (or String to byte) conversion, and will assume that the default platform encoding is suitable. This will cause the application behaviour to vary between platforms. Use an alternative API and specify a charset name or Charset object explicitly.

Confidence: High, Rank: Of Concern (19)
Pattern: DM_DEFAULT_ENCODING
Type: Dm, Category: I18N (Internationalization

즉, 인코딩 지정에 대한 문제이다. 사실 위의 코드의 부분에서의 문제가 아니라, FileReader 나 FileWriter 를 BufferedReader, BufferedWriter 쓸때 문제가 생긴다. 즉, 이런식으로 말이다.

FileReader logReader = new FileReader(logPath);
BufferedReader bufReader = new BufferedReader(logReader);

인코딩 문제라는것은 알았는데, 대안 API(Alternative API)를 쓰라고만 나와서 약간 막막했는데,

다음과 같이 수정하면 된다.

BufferedReader brd = new BufferedReader(new InputStreamReader(new FileInputStream(logPath), "EUCKR"));

shop.github.com

ASH84 — Sun, 08 Apr 2012 10:02:49 +0900

좋아라 하는 github에는 다양한 github 관련 상품이 파는데,

특히 그 중에서 스티커랑 머그컵이 가장 갖고 싶다.

아래의 머그컵인데, 넘흐 갖고 싶다 @.@ 현재 일시 매진 상태인데, 얼른 풀렸으면 좋겠당. ㅠ

온라인 일정관리 툴, trello.com 사용 후기

ASH84 — Sun, 08 Apr 2012 09:05:22 +0900

이전 부터 알고 있는 서비스이긴 했지만, 같이 자바 스터디를 는 분 중에 상급 개발자분께서 추천해준 툴인 trello.com. 일단 구글 계정을 기반으로 로그인을 할수 있다는게 편하고, 만약 회사에서 사용한다면 따로 이메일을 넣어서 가입을 하던지 해서 사용해야 겠지만.

일단 저는 아래와 같이 여러가지 카테고리를 두고 사용하고 있습니다. 회사, 하고 싶은일, 블로그 등등. 기본적인 일정 자체는 구글 캘린더로 관리를 하지만, 프로젝트성이나, 뭔가 시간을 투자해서 해야하는 일은 trello.com을 통해서 현재는 관리하고 있는 실정입니다.

그리고 그 안으로 들어가 보면 아래의 화면처럼 나옵니다.

보시는 것과 같이 기본적으로 To Do, Doing, Done 리스트가 기본적으로 생성 되어 있지만, 저 부분의 이름은 바꿀수가 있습니다. 그리고 리스트는 계속 늘릴수가 있습니다. 각 일정의 상태를 구분해 놓고 진행되는 상태에 따라 해당 일정을 이동시켜주면 아주 편하더라구요. 스크럼에서 포스트잍을 통해서 태스크보드 구성을 하는데, 여기서는 그것이 온라인화되어 있다고 보면 될것 같습니다.

세부 사항으로 들어가보면 화면은 아래와 같습니다.

일단 이 화면에서 제가 생각하는 가장큰 장점은 나 혼자 사용하더라도, 일정 관리는 물론이고 각 일정 각각에 대해서 코멘트, 링크는 물론이고 이미지, 파일까지 첨부할 수 있다는 것 입니다. 이렇게 되면 현재 단계에서 내가 한 일에 대해서 기록할 수 있어서 다음에 다시 진행할때 이력이나 정보를 다시 꺼내 볼수 있어서 유용합니다.

여러사람과 함께 사용한다면, 정말 좋겠죠?

그리고 만약 다른 사용자, 회사에서 팀내 다른 팀원들과 함께 사용한다면, 내가 만든 태스크를 다른 사람에게 할당할 수도 있다. 또한 다른 사람의 태스크에도 댓글을 달수도 있고, 그 태스크에 대해서 vote(일종의 like)를 할수도 있습니다. 그리고 색깔별로 label을 줄수도 있습니다.

아래의 동영상을 보시면, 좀더 자세한 사용법을 보실수가 있습니다.

[DesignPattern] 데코레이터 패턴

ASH84 — Tue, 03 Apr 2012 11:50:33 +0900

디자인 패턴 데코레이터 패턴

View more presentations from SeonyHyun Ahn.

데코레이터 패턴에 대한 나름의 견해.

- 쓰기 참 난해하기도 하고 애매하기도 한 패턴.

- 굳이 추상클래스로 저렇게 해도 결국에 추상 클래스의 내용이 추가 되거나, 하게 되면 종속성이 생겨서 다시 인터페이스로 빼게 되는 현상이 생길것이 뻔한 과정이 될듯.

[C#] 실행시간/동작시간 측정하기

ASH84 — Thu, 22 Mar 2012 20:00:42 +0900

매일매일 개발하는 소스코드를 올리고 있습니다. 원래는 프로젝트가 끝나고 올리려고 했으나, 그러다 보니 까먹는 경우가 있어서 이렇게 매일매일 올리는 소스코드 입니다. 제가 쓴 소스코드의 문제 혹은 개선점이 있으면 언제든지 댓글 달아 주세요

최근에 C#으로 만든 프로그램이 문제가 있어서 테스트 하던 중에, 실행 시간 즉, 속도에 대한 부분을 측정해야할 일이 있었는데, 구글검색을 통해서 한 프로그래머의 블로그에서 실행 시간을 측정하는 자료를 보고 내 나름대로 함수화해서 테스트에 이용했다. 별거 없는 C# 언어에서의 시간측정 함수임.

 
 DateTime startDateTime = new DateTime();
 startDateTime = DateTime.Now; //현재 시간 저장

  
Console.WriteLine("Elasped Time[seconds] = {0}", MeasureRunTime(startDateTime));

  
static string MeasureRunTime(DateTime startDateTime)
{
     DateTime endDateTime = new DateTime();
     endDateTime = DateTime.Now;
     return endDateTime.Subtract(startDateTime).TotalSeconds.ToString("#.##");
}

자바나 다른 언어의 실행시간 측정 코드를 트랙백으로 받고 있습니다. 원츄.

[CleanCode] 조건문의 캡슐화를 하자.

ASH84 — Sun, 18 Mar 2012 06:01:12 +0900

CleanCode의 신봉자로서 맨 처음 여러분께 소개해드릴 내용을 그리 거창한 것도, 특별한 디자인패턴을 요하는 기술도 아니지만 개인적으로 CleanCode라는 책을 읽고 가장 많이 사용하는 부분을 가장 먼저 소개해 드릴려고 합니다.

조건문의 캡슐화를 하자.

CleanCode의 "냄새와 발견법" 부분에서 G28에 해당하는 부분입니다. 일단 말이 좀 어려울수도 있는데, 쉽게 풀어서 이야기 하면 if 조건절에 들어가는 문을 함수화하자는 이야기 입니다. 일단 아래의 코드를 보시죠.

 
 if(para_text_buffer == "\0")
 {
   return 0; 
 }

if(para_text_buffer == NULL)
 {
   return 0; 
 }

최근에 분석하고 있는 회사내 특정 코드에 대한 부분인데요, 일반적으로 문자열 변수에 대한 널유무를 체크하는 부분입니다. 그렇다면 위의 조건문을 캡슐화를 한다면 어떻게 하는게 좋을까요? 저는 이렇게 했습니다.

 
if(IsTextBufferNull(para_text_buffer))
{
     return 0;
}  

int IsTextBufferNull(chat* text_buffer)
{ 
      int rc = 0;
      if(text_buffer =="\0" || text_buffer == NULL)

      {    
          rc = 1;   
      }
     
     return rc;
  }

일단 위의 코드를 보시면 그 전에는 지저분해있던 문자열의 널을 체크하는 두개의 조건문을 하나로 합치면서 이 부분이 확실하게 문자열의 널 유무를 체크하는 것이라는 점에서 IsTextBufferNull 이라는 이름을 통해서 확실하게 제공하고 있습니다. 이런 경우에는 개발자가 굳이 저 함수를 들어가보지 않아도 이름만 잘 짓는다면, 함수의 역할에 대해서 쉽게 유추할 수 있는 부분을 줄수 있어서 매우 좋다고 생각합니다. 또 다른 예를 볼까요?

 
if(m_kern->m_cfg_use_pattern_exception == 1)
{ ….}

if(m_kern->m_cfg_use_text_exception == 1)
{ ….}

if(m_kern->m_cfg_use_special_char_exception == 1)
{ ….}

위의 코드는 설정 클래스에 있는 값을 가져와서 다른 클래스에서 조건문에서 검사해서 특정 수행을 하는 코드입니다. 실제 제가 손을 대기전의 모습입니다. 일단 문제를 파악해 보면, m_로 시작하는 문구가 많아서 쉽게 조건문에서 무엇을 하는지 눈에 들어오지가 않습니다. 물론 Clean Code 책을 읽어보면 저러한 접두어에 대한 부분 역시 최근에는 IDE의 지원으로 인해서 굳이 할 필요 없다고 합니다. (이 부분에는 언어적 사견이 있음.) 그래서 일단 이렇게 바꿔보았습니다.

 
if(UsePatternException())
{…}

if(UseTextException())
{…}

if(UseSpecialCharException())
{…}

일단 함수화하기전의 문제점은 조건문이 길어지게 되면 당연히 조건문 자체에 대한 가독성이 떨어지게 됩니다. 위의 코드의 경우에는 조건문 자체가 그리 복잡하지는 않지만 대부분의 소스에서는 &&, || 과 각종 연산자를 사용하면서 조건문이 복잡해지고, 지역변수 혹은 멤버변수가 아닌 외부 클래스의 변수를 끌어다쓰게 되면 조건문이 더러워질수 밖에 없습니다.

위의 고친 코드가 주는 효과는 2가지 입니다. 일단 첫 사례와 같이 함수화 해서 의미있는 이름을 제공함에 따라 개발자는 당연히 함수 내부를 보지 않아도 대략적인 기능을 함수이름을 통해서 제공받을수 있습니다. 개발자는 UsePatternException()이라는 함수명을 보고, "아, 몬지는 모르겠는데 패턴제외 라는 것을 사용하는지 여부를 체크하는거구나" 라고 인식 할 수가 있습니다.

두번째 효과는 함수화한 조건문의 이름의 일관성으로 인해서 생기는 학습의 효과입니다. 일단 함수명 역시 클린코드에서는 비슷한 역할을 할때에는 일관성 있는 이름을 제공하라고 이야기하고 있습니다. 즉, UsePatternException()이라는 함수를 개발자가 내부를 들여다 보면, "아 , 설정 클래스의 특정 변수의 값을 체크해서 판별하는 구나" 라고 생각하게 되고, 비슷한 이름의 UseTextException(), UseSpecialCharException() 함수 역시 대략적인 세부 기능에 대해서 유추 할수 있게 됩니다.

이번 시간에는 조건의 캡슐화에 대해서 알아 보았습니다. 첫 시간에 이 주제를 잡은 가장 큰 이유는 특별한 패턴이나 지식이 없더라도 이름만 지을줄 안다면 소스코드 상에서 CleanCode의 사례를 구현해 볼수 있는 가장 작은 단위이기 때문에 소개하게 되었습니다.

저 역시 새로만드는 코드보다는 유지보수하고 남이 짜 놓은 소스를 고치는 경우가 많기 때문에 당연히 이런 사례들을 많이 보게 되는데 소스코드를 싹 바꾸겠다라고 하면 한도 끝도 없기 떄문에 그때 그때 자신이 고치거나 유지보수한 부분에서 위와 같은 부분이 있다면 바꾸는것 부터 시작하는것이 쉬운 Clean Code 실천의 첫 걸음이라고 생각합니다.

[C#] WMI를 이용한 현재 메모리 사용량 구하기

ASH84 — Sat, 03 Mar 2012 15:34:00 +0900

최근에 메모리 사용량을 측정해서 특정 메모리 사용량 이상 혹은 몇 퍼센트(%)이상이 되면 특정 기능을 수행하도록 하는 코드를 C#으로 작성을 했습니다. 그런데 처음에 가장 어려웠던 부분이 메모리의 사용량 즉, 작업 관리자를 눌러서 성능란에서 원래 물리적인 메모리가 얼마인데, 현재 사용량, 남은 사용량, 그리고 퍼센트를 구하는 방법이었습니다.

일단 코드를 보시면 아래와 같습니다.

ManagementClass cls = new ManagementClass("Win32_OperatingSystem");          
ManagementObjectCollection instances = cls.GetInstances();
         


foreach (ManagementObject info in instances)
{
  Console.WriteLine("Memory Information ================================");
  Console.WriteLine("Total Physical Memory :{0:#,###} KB", info["TotalVisibleMemorySize"]);
  Console.WriteLine("Free Physical Memory :{0:#,###} MB", info["FreePhysicalMemory"]);
                    
  int total_physical_memeory = int.Parse(info["TotalVisibleMemorySize"].ToString());
  int free_physical_memeory = int.Parse(info["FreePhysicalMemory"].ToString());
  int remmain_physical_memory = total_physical_memeory - free_physical_memeory;


  Console.WriteLine("Memory Usage Percent = {0} %",100 * remmain_physical_memory / total_physical_memeory);


}

위에 코드를 보시면 일단 ManagementClass 인스턴스를 만드는데 여기에서 String 형식의 인자로 WMI(Windows Management Instrumentation) 클래스 경로를 넘겨주게 되어 있습니다. 그래서 찾아 보니 다양한 클래스 형식이 있는데 여기서는 OS 관련된 부분에 대해서 일단 선택을 했습니다.

그리고 ManagementObjectCollection 객체를 가져와서 하나씩 ManagementObject 의 객체인 info 에서 item 속성을 통해서 지정해서 필요한 속성을 가지고 올 수 있다. 위에 코드에서는 필자가 전체 메모리 사이즈와 현재 남아있는 물리적인 메모리 사이즈를 가져와서, 남아있는 사이즈를 구해내고 그리고 그것을 바탕으로 현재 메모리 사용량을 계산하고 있다.

본 소스코드에서 중요하게 볼 부분은 사실 어떻게 메모리를 구하느냐가 아니다. 가장 중요하게 생각하는 부분은 WMI라는 것을 통해서 마이크로소프트가 윈도우 운영체제에 대한 정보를 제공하고 있다는 사실이다. 우리는 작업관리자를 통해서 해당 내용들을 쉽게 확인 할 수 있지만, 특정 어플리케이션에서 그러한 내용들을 가지고와서 이용하던지 하려면 윈도우 운영체제 내에서는 WMI를 이용하는것이 가장 적절하다는 생각이 든다.

필자가 올린 코드에서 보여주는 것은 C#을 통해서 특정 클래스로 윈도우에서 정한 스키마로 자원 정보에 대해서 접근하고 있다는 사실이다. 기본적으로 WMI가 무엇인지에 대한 이해도 필요하겠지만, 우선적으로 써 보는것이 가장 좋을듯 하다. 다른 여타의 정보에 대해서 쓰려면, WMI Class에 대해서 알아야 한다. 그 부분은 여기를 참고하시길.

[JAVA] Gson 라이브러리로 JSon 이용하기

ASH84 — Sat, 18 Feb 2012 23:27:15 +0900

최근에 회사에서 프로젝트를 하면서 쓴 것은 아니고 프로토타입핑을 하는 도중에 쓴것이 있어서 소개하려고 한다. 목적은 그랬다. 데이터 양이 엄청 많았는데 서버에서 가져오기 벅차니까 결과를 캐쉬하자는 목적이었다. 그런데 메모리에 올려져 있는 캐쉬를 사용하자니 서버에 부담도 되고, 그 사용량 역시 만만치 않다는 결론에 이르렀다.

그래서 생각한 것이 파일에 저장하는 것이었다. 문제는 딱 2가지 였다.

1. 각각의 쿼리에 대해서 어떻게 저장되어 있는 파일을 고유하게 구별할 것인가?

2. 효율적인 파일 구조는 무엇일까?

1번에 대한 답은 MD5 키 변환을 통해서 해결하고자 했다. 즉, 어떤 사용자가 어떤 데이터를 요청할때, (데이터는 사용자에 종속된다.) 서버에 특정 쿼리를 전달하면 그 때의 시간 혹은 테이블 명 사용자ID 등의 고유한 문자열을 MD5키로 뽑아서 파일로 만들고, 나중에 사용자가 쿼리를 전달할때 서버가 아닌 파일에서 찾게 만들게 하는 설계였다.

2번에 대한 답은 여러가지가 있을수가 있었다. 자체적인 구조를 만들수도 있고, 아니면 전형적인 XML의 형태를 가지고 갈 수도 있었다. 하지만 개인적으로 XML의 경우 태그명이 명확한 이름짓기로 인해서 길어질 경우, 지나치게 데이터의 양을 차지할것 같고, 무거운 느낌이 들었다.

그래서 생각해 낸것이 바로 JSON이었다.

원래 웹 서비스의 전송 포맷으로 많이 사용하는데 이번에는 서버에 데이터 저장용으로 써 보는것은 어떨까? 하는 생각을 하게 되었다. 물론 추후에 그 데이터를 외부 혹은 내부의 다른 서비스에 네트워크를 통해서 전달해야 한다면 바로 그 파일을 쓸 수도 있지 않을까 하는 막연한 기대감도 있었다.

자바에서 어떻게 하면 쉽게 클래스에 저장한 데이터를 MD5이름을 가진 JSon형식의 파일로 저장할수 있을까? 그리고 저장된 파일에서 어떻게 하면 쉽게 클래스로 옮겨올 수 있을까? 하는 생각이 들었다. 다들 아시다시피 프로토타입핑은 간결해야 하고, 프로젝트 기간중에 우리에게 JSon 파서를 만들도록 나둘 프로젝트 매니저나 팀장은 적어도 대한민국엔 존재하지 않는다.

때문에 오픈소스 JSon 관련 파서를 찾기 시작했고(자바용), 그래두 역시 구글님이 만들어 놓으신 Gson 이라는 라이브러리를 찾을 수 가 있었다. Gson에서는 다양한 기능을 제공하지만 위에서 정의한 요구사항에 부합하는 기능을 쓰는 것은 매우 간단하다. 아래의 코드를 보자.

public class Person
{

    String name = new String();
    int age;
    String currentjob = new String();
    ArrayList jobs = new ArrayList();
    boolean isExistGirlFriend = false;
    
}

먼저 데이터를 넣고 뺴고 할때 담을 그릇, 클래스를 만들자. Person 이라는 예제 클래스를 만들었다. 다음과 같이 간단하게 사람의 여러가지 특징에 대해서 설명 할 수 있는 변수들을 지정했다. 그리고 나서 JSon 파일을 읽어오는 readJsonFile() 함수와 Person 객체에서 JSon파일로 데이터를 넣을수 있는 writeJsonFile을 작성하였다.

   public static void readJsonFile(String path) throws IOException
    {
      StringBuffer sb = readTextInFile(path);
      System.out.println(sb.toString());
      Gson gson = new Gson();

      Person person = gson.fromJson(sb.toString(), Person.class); 
    }
   
    public static StringBuffer readTextInFile(String file_path) throws IOException
    {
      int i;
      StringBuffer full_text = new StringBuffer();
      
      try
      {
          FileReader in = new FileReader(file_path);
          while ((i = in.read()) != -1)
          {
            char ch = (char) i;
            full_text.append(ch);
          }
      }
      catch (IOException e)
      {
          e.printStackTrace();
      }
      
      return full_text;
    }
 
    public static void writeJsonFile(String path, Object obj) throws IOException
    {
      Gson gson = new Gson();

      String json = gson.toJson(obj);

      FileWriter writer = new FileWriter(path);
      writer.write(json);
      writer.close();

    }

readTextInFile() 함수는 단순히 지정한 파일에서 텍스트를 읽어오는 역할을 한다. 위의 코드를 보라. 미칠듯이 간단하다. readJsonFile() 함수에서는 텍스트파일에서 읽어온 텍스트 내용을 Gson 객체의 fromJson()함수에 어떤 클래스의 형식으로 받을것 인지를 함께 전달해 주면 된다. 그리고 리턴 값으로 Person 객체를 이용해서 받으면 된다. writeJsonFile() 함수를 보면, 더 간단하다. gson.toJson에 Person객체를 전달해 주고 FileWriter의 write 함수에 전달해 주기만 하면 된다.

이제 main에서 호출해 준다.

  public static void main(String[] args) throws IOException
    {

      Person person = new Person();
      person.name = "안성현";
      person.age = 29;
      person.isExistGirlFriend = true;
      person.currentjob ="Programmer";
      person.jobs.add("Student");
      person.jobs.add("Programmer");
      person.jobs.add("Dancer");
       
      writeJsonFile("C:\\ash84.json", person);

      readJsonFile("C:\\ash84.json");

    }

사용후기를 말씀드리면, Gson 라이브러리가 제공하는 기능으로 인해서 JSon에 대해서 쉽게 접근 할 수 있어서 좋은 것 같다. 그리고 위에서 소개한 기능은 Gson 라이브러리의 기능 중 극히 일부분이기 때문에 네트워크와 맞물렸을 경우, 사용하기 편한 여러가지 기능을 Gson에서 제공하고 있을 것 같다. 필요하면 해당 사이트에 가서 찾아서 쓰면 좋을것 같다. 가장 마음에 드는 것은 JSon 구조 자체가 깔끔하다는 것이다. XML처럼 특정 태그명과 포함관계를 지정하기 위해서 애쓸 필요가 없다. 내가 정한 클래스의 구조 그대로 들어가기 때문에 좀더 클래스 디자인에만 집중할수 있게 하는것도 하나의 장점이라는 생각이 든다.

구글 사이트를 이용해서 위키 만들기.

ASH84 — Wed, 18 Jan 2012 01:26:05 +0900

언제봐도 Trac 은 멋지다.

최근에 라이브러리를 만들면서 오픈 소스 형식으로 여러 사람들이 볼수 있는 위키 혹은 개발 문서 사이트를 만들고 싶었다. 처음에 택한 도구는 당연 트랙(Trac)이었다. 테터툴즈라는 좋아라하는 오픈소스 프로젝트의 도구로 쓰기도 했었고, 이전에 다녔던 회사에서도 사용했던 도구여서 괜찮을 거라 생각했다. 하지만 Trac의 단점은 위키부분만 분리해서 쓰기에는 조금 불편하다는 점이었다.(적어도 나에게는)

위키피디아

두번째로 생각한 것은 위키(WiKi) 사이트이다. 위키피디아의 시스템도 개발 문서 및 오픈 소스 프로젝트 형식으로 괜찮을 것이라는 생각이 들었다. mediawiki 나 여타의 다른 위키를 찾아 봤지만, 가장 큰 문제는 서버에 대한 임대 문제이다. 회사에 설치 하자니 좀 캥기는 것도 있고, 왠지 모르게 호스팅 업체를 이용하자니 비용적인 부분이 부담이 되었다.

그러던 중 찾은 것이 구글 사이트 도구이다.

일단 로그인을 하고 사이트 도구를 누르면 바로 이런 화면이 나온다.

DocumentExtractor는 이미 작업중인 개발관련 위키이다.

일단 만들기른 눌러보자. 만들기를 누르면 아래와 같이 템플릿과 이름을 작성할수 있는 부분이 나오게 된다. 먼저 템플릿 부터 보자. 템플릿은 가장 중요하다. 왜냐하면 기본적인 사이트의 레이아웃을 정하기 때문이다. 다양한 형식의 템플릿이 있지만, 우리의 목적인 위키이다. 검색 하다 "Wiki"

다양한 템플릿이 존재한다.

다양한 형식의 위키 사이트를 볼 수가 있다. 일단은 가장 복잡해 보이지 않는 "Simple Wiki"를 선택해보자. 해당 위키 템플릿을 선택하면 미리보기를 해 볼수도 있고, 또 바로 선택할 수도 있다. 일단 해당 템플릿을 선택하고 나면 이름을 정해야 한다.

여기서는 BaboWiki 라는 이름으로 만들어 보도록 하자. 일단 입력하면 소문자의 형태로 url 이 자동적으로 생성된다. 물론 본인이 원하는 다른 url을 지정 할 수 있다. 이 이름은 겹치면 안되기 때문에 잘 선택해서 쓰자. (원래는 TestWiki라고 지었으나 같은 이름이 있어서 거절되었다.)

이름을 입력하고 나서는 테마를 정할수도 있다. 그리고 기타 옵션이 있는데 해당 사이트에 대한 공개 및 보안 설정을 할 수가 있으며, 사이트에 대한 설명을 쓸 수도 있다. 그리고 성인 콘텐츠가 포함되어 있는지의 여부 역시 체크할수 있다.

짜잔!!

자, 이제 사이트를 만들었다.

다음 시간에는 본격적으로 메뉴사용법과 개발 문서를 담을 수 있는 위키를 만들어 보도록 하자.

단위테스트를 보다 쉽게, JUnit 을 사용하자.

ASH84 — Sun, 15 Jan 2012 16:49:19 +0900

단위 테스트를 어떻게 구성해야 할까에 대해서 생각해 볼 경우가 종종 있는것 같다. 실제로 필자가 속한 조직에서는 아직 단위테스트에 대한 필요성을 인지 하지 못한것인지는 모르겠지만, 아무튼 새롭게 프로토타입(Prototype)을 구성중인 자바 기반의 문서 이미지 추출 프로젝트에서는 클린코드와 단위테스트를 필수로 포함시키기로 하였다.

단위 테스트란?

컴퓨터 프로그래밍에서 유닛 테스트란 소스 코드의 특정 모듈이 의도된 대로 정확히 작동하는지 검증하는 절차다. 즉, 모든 함수와 메소드에 대한 테스트 케이스(Test case)를 작성하는 절차를 말한다. 이를 통해서 언제라도 코드 변경으로 인해 문제가 발생할 경우, 단시간 내에 이를 파악하고 바로 잡을 수 있도록 해준다. 이상적으로, 각 테스트 케이스는 서로 분리되어야 한다. 이를 위해 가짜 객체(Mock object)를 생성하는 것도 좋은 방법이다. 유닛 테스트는 (일반적인 테스트와 달리) 개발자(developer) 뿐만 아니라 보다 더 심도있는 테스트를 위해 테스터(tester)에 의해 수행되기도 한다.

단위 테스트에 대해서 막연히 알고 있었고, 필요하다고는 느끼고 있었지만 처음 도입해 보는 과정에서 여러가지 시행 착오가 있었다.

가장 큰 문제는 단위테스트 코드는 어디에 위치하는것 인가? 하는 부분이었다. main함수에서 해야하는 것인지(이 경우, 객체를 생성해야 하고 publc 함수 밖에 테스팅 할수 밖에 없다.) , 해당 클래스 내 함수가 있는 위치에서 따로 뽑아서 해야하는것인지(이럴경우, 객체를 만들 필요가 없고, private 함수까지 테스팅을 할 수 있다.) 고민되는 부분이 있었다.

또 다른 문제는 명명법에 대한 문제인다. 같은 함수내에 단위 테스트에 대한 코드를 둔다면, 실제 실행 함수와 어떻게 구별할 것인가? 함수 앞에 test_ 접두어를 붙일수도 있지만, 더 큰 문제는 나 외에 다른 동료들도 이러한 내용을 강제하고 지키도록 동의를 해야한다는 것이다. 그렇지 않는다면, 소스코드는 실제 사용하는 부분과 그리고 테스트 코드 부분을 구분 할 수 없게 되는 문제가 있다.

처음에는 main() 함수가 있는 클래스에 static 함수로 다른 클래스의 실제 사용하는 함수를 테스팅 하는 코드를 넣는 방식으로 하였다. 이 경우 문제점은 여러가지 함수를 테스팅하기 위해서는 main()에서 다양한 static 테스트 함수들을 써야 한다는 점이다. 그래서 좀 불편한것 같았다.

그러던 중 JUnit 에 대해서 알게되었다. 일단 써보면서 특징을 설명하겠다.

일단 JUnit을 사용하기 전에,

빌드 패스(Build Path)에서 추가 라이브러리(Add Library)를 눌러서 JUnit을 추가하도록 하자. 필자는 JUnit3를 설치하였다. 자 그러면, 이제 JUnit 을 본격적으로 사용해 보자.

빌드경로에서 라이브러리 추가

JUnit3 선택

이클립스의 File의 New를 눌러서 JUnit Test Case를 누르면 테스트 케이스를 만들수 있다. 아래의 화면과 같이 나오게 되면 일단 하단에서 New JUnit3 Test Case를 선택한다. 우리는 앞에서 JUnit3 라이브러리를 추가했기 때문에 이것을 선택해 주면된다. 그리고 나서 되도록 현재 만드는 단위 테스트가 속할 패키지를 지정해 준다. 되도록이면 지정하는 것이 좋다. 왜냐하면 JUnit Test Case 역시 하나의 클래스 파일이기 때문에 패키지로 구분해 주는 것이 가독성 측면에서 좋다.

JUnit Test Case 추가

패키지 지정을 했으면, 이름(name)을 지정해 주자. 일반적인 클래스 이름이라고 생각하시면 되는데 이때에 일반 클래스를 대상으로 테스트 하는 것이기 때문에 이름에서 어떤 클래스를 테스트 하고 있음을 나타내는 동시에, 이 클래스가 유닛테스트 클래스라는 것을 알려주자. 예를 들어, 내가 ExtractorImage 라는 클래스에 대한 유닛테스트를 만든다고 하면, UnitTest_ExtractorImage 이런식으로 UnitTest_ 라는 접두어를 통해서 해당 클래스가 유닛테스트 클래스 임을 알려주자.

마지막으로는 어떤 클래스에 대한 유닛테스트 인지를 설정하는 부분으로 제일 아래에 있는 class under test 에서 browse를 눌러서 테스트 하려는 클래스를 적어주면 알아서 찾아준다. 자, 입력을 다 했으면, 이제 Next를 누르면 앞에서 입력한 테스트 대상 클래스의 함수들이 나온다. 보시면 알겟지만, Public 함수에 대해서만 테스트를 할 수가 있다. 이 단계에서 테스트를 할 함수를 체크를 한다. 체크를 다했으면 기본적은 단위 테스트의 구성이 끝나고 해당 단위테스트 클래스가 만들어 지는것을 볼 수가 있다.

테스트 대상 클래스 지정

테스트 할 함수 지정

만들어진 단위 테스트 클래스의 내부를 보자.

JUnit 테스트 결과

우리가 앞에서 지정했던 함수에 대해서 미리 만들어져 있다. 그런데 형태를 보면, public void testExtractorManager() 이런 형태로 원래 함수 test라는 접두어를 붙여서 표시를 하였다. 일단 한번 테스팅을해 보자 테스팅을 하면 이전과 다르게 오른쪽에 JUnit 테스트에 대한 결과를 보여주는 창이 나온다. 보시면 Runs, Errors, Fails 가 있는데 처음 생성을 하면 아래처럼 나오기 때문에 현재는 Fails:4 라고 표시가 되어 있다.

public void testExtractText()
{	
fail("Not yet implemented");
}

이제 구현을 해 보자. 일단 각각의 테스트 함수에다가 필요한 테스트 코드들을 넣어준다. 만약 테스트 함수 외의 함수를 넣고 싶다면, test 접두어를 붙이지 않은채 코드를 넣으면 된다. 예를 들어 testExtractImage() 함수에서 특정 디렉토리 경로를 가져오는 함수를 호출해야 한다면,


private String GetTestDocPath()
{	
File dir = new File("");	
return dir.getAbsolutePath() + File.separator + test_document;
}

public void testExtractImage()
{			
String doc_dir_path = GetTestDocPath(); 
}

이런식으로 GetTestDocPath()를 써주면 된다. 대신에 이 부분은 test접두어로 시작되지 않기 때문에 JUnit test를 실행 시킬때 결과에 표시되지 않는다. 그렇다면, 검사 대상 클래스의 내용이 추가 된다면 어떻게 해야 할까? 다시 앞의 단계를 반복해야할까?

수동으로 JUnit 테스트의 결과에 포함되는 테스트 함수를 추가 시키는 방법은 간단하다. 어떤 테스트 하려는 함수를 만들고 그 함수이름의 제일 앞에 test 접두어를 붙여주면 된다. 예를들어, testExtractImage1() 을 만들어 주고 테스트를 돌려보면 아래와 같은 결과를 얻을 수가 있다.

수동 테스트 함수 추가 결과

추가된 함수가 결과에 포함된 것을 볼수가 있다. 이렇게 하면 대상 클래스의 내용이 변하더라도 능동적으로 테스트 코드에 추가할 수가 있다.

자, 이제 다 구현을 하고 JUnit을 돌려보자. 필자가 생각하는 JUnit의 가장 큰 장점은 해당 함수에 대한 실행 시간을 표시해 줄수 있다는 것이다. 사실 프로그래머는 성능 측정에 대해서 자유로울 수가 없는데 JUnit 에서는 이런 부분을 쉽게 해결해 준다. 하나의 함수에 대한 실행 시간을 알려줌으로써, 어떤 부분이 병목을 가지고 있는지 테스트 케이스를 구성함으로써, 쉽게 알수가 있다. C 언어에서 처럼 시간을 측정하는 부분을 넣을 필요가 없다.(사실 이 부분은 소스코드를 더럽히기도 하고, 다른 여러가지 툴이 있을것이라 생각된다.)

결론.

JUnit을 꼭 사용하자.

그리고 성능 측정을 하고, 개선을 하자.

그리고 쉽게 유지보수 할수 있는 여지를 주자.

마지막으로. 쉽게 인수인계 할수 있을것 같다.