[태그:] Java

작성일자

JavaDoc 주석 다는 방법, 기본적인 예

여전이 주석이라는 것에 대해 긍정적인 면보다는 부정적인 면이 더 많다고 생각하고 있지만.. 소스 코드와 주석을 통해 멋지게 문서를 자동으로 생성해 주는 개념은 주석에 대한 부정적인 많은 부분을 불식시키고도 남는듯합니다.

Java로 만든 어플리케이션(또는 서비스)의 소스를 협업자 또는 제3자에게 제공하기 위해 주석을 달때 JavaDoc의 도움을 받아 좀더 체계적으로 작업할 수 있도록 하기 위한 주석법입니다. 간단히 제 스스로 개발할때 참고하여 사용할만한 예제 코드로 정리해 봅니다.

먼저 클래스에 대한 주석의 예입니다.

/**
 * 화면상에 윈도우를 나타내기 위한 클래스
 * 사용 방법:
 *
 *    Window win = new Window(parent);
 *    win.show();
 *
 *
 * @author  Sami Shaio
 * @version 1.0
 * @see     java.awt.BaseWindow
 * @see     java.awt.Button
 */
class Window extends BaseWindow {
   ...
}

다음은 클래스의 필드에 대한 주석의 예입니다.

    /**
     * 컴포넌트의 X 좌표
     *
     * @see #getLocation()
     */
    int x = 1263732;

끝으로 클래스의 매서드에 대한 주석의 예입니다.

    /**
     * 지정된 index에 위치하는 문자 반환. 
     * index의 범위는 0에서 length() - 1까지임.
     *
     * @param     index  얻고자 하는 문자의 인덱스 값
     * @return      지정된 index의 문자
     * @exception StringIndexOutOfRangeException
     *     index가 0에서 length()-1의 범위를 벗어남
     * @see       java.lang.Character#charValue()
     */
    public char charAt(int index) {
       ...
    }
작성일자

Java 프로세스의 종료시점 후킹

자신이 개발하고 있는 어플리케이션을 완전히 제어하고픈 개발자(나를 포함한..)에게 Java에 매우 좋은 API를 제공합니다. 바로 Java 프로세스의 종료 시점을 어떠한 상황에서든 잡아 내 그 시점에서 원하는 코드를 실행하게 할 수 있는 방법인데요.. 아래의 간단한 코드를 살펴 보는 것으로 시작하겠습니다.

public class TestMain {
    public static void main(String[] args) throws InterruptedException {
        System.out.println("processing something in main(" + 
            Thread.currentThread().getName() + ") start...");
  
        Runtime rt = Runtime.getRuntime();
  
        rt.addShutdownHook(
            new Thread() {
                public void run() {
                    System.out.println("======================");
                    System.out.println("do arrange resource !!");
                    System.out.println("======================");
            }
        } );
  
        System.out.println("Waiting while 10 seconds or hit ^C for exit.");
  
        Thread.sleep(10000);
        System.out.println("processing something in main end...");
        System.exit(0);
  
        System.out.println("this code never run!");
    }
}

핵심은 바로 Runtime.getRuntime()으로 얻어진 Runtime 타입의 인스턴스입니다. 이 인스턴스에 addShutdownHook 매서드를 통해 자바 가상 머신이 종료하는 시점에서 실행하는 코드를 개발자가 유연하게(얼마까지 유연할지는 모르겠지만…) 붙일 수 있습니다. 자바 어플리케이션이 콘솔이여서 ^C를 눌러 강제로 종료시키든… 예외나 에러가 발생하든 Runtime의 addShutdownHook로 지정한 스레드의 실행(run) 로직은 반드시 실행된다는 점입니다.