Java.util.logging 우수 사례

각 클래스에서 다음 패턴을 사용하여 JSR47 로거를 확보할 수 있습니다.

private static final String CLAZZ_NAME = MyClass.class.getName();
private static final String PKG = MyClass.class.getPackage().getName();
private static Logger _logger = Logger.getLogger(PKG);

LogManager는 <workspace>/.config/rcpinstall.properties 파일의 값을 통해 초기화됩니다. 여기에서 로거(logger) 레벨을 설정할 수 있습니다. 예를 들어, com.ibm.rcp.mypackage 패키지에서 사용자 코드에 해당되는 모든 로그 항목을 보려면 다음 문자열을 추가하십시오.

com.ibm.rcp.mypackage.level=FINEST

setlogrlev osgi 콘솔 명령을 사용하여 JSR47 사용 Lotus Expeditor 컴포넌트를 추적할 수 있습니다. 이 명령의 도움말이 아래 표시됩니다.

• setlogrlev <logger> (level) - 지정된 레벨로 로거를 설정하며 기본값으로 FINEST가 됩니다.
• getlogrlev <logger> - 지정된 로거의 현재 레벨을 리턴합니다.

다음 예제는 FINEST 레벨에서 com.ibm.rcp.core.internal.pd.manager 로거(logger) 추적을 사용하는 데 대해 자세히 설명합니다.

osgi> setlogrlev com.ibm.rcp.core.internal.pd.manager

"보호받는 로깅"은 로그 명령문이 실행 이전에 출력을 초래하는지 확인하는 패턴입니다. 로거(logger) 자체에서 초기 검사를 수행하여 이 메시지가 로그 이벤트 핸들러로 전송되는지 확인하지만 로거 보호장치(guarder)에 도달하도록 모든 매개변수가 우선 해결되도록 하십시오. 일부 경우 매개변수를 해결하기 위해 복합 오퍼레이션 또는 String 조작이 필요할 수 있습니다. 이 경우, 로그 또는 추적을 호출하기 전에 Java™ 코드에 명시적 보호장치를 추가하도록 권장합니다. 다음 예제는 로그 메시지의 매개변수 해결의 일부로 복합 String 조작이 필요한 로깅 메시지를 보여줍니다.

            if(_logger.isLoggable(WARNING)){
                _logger.logp(WARNING,CLAZZ_NAME, METHOD,
                     Nls.bind("warn.unable.to.get.preference",
                   new Object[]{pid,key}));
           }

다음 코드 샘플은 단순 String 병합의“보호받는 로깅(guarded logging)”필요 여부를 나타냅니다.

   private boolean methodP(String param1, String param2) {         
		logger.entering(CLAZZ_NAME,METHOD, param1 + "," + param2);
}

위의 샘플에서는 param1 및 param2가 String이라고 가정합니다. 이 매개변수가 String 오브젝트가 아니며 복합 toString() 구현이 없는 경우 보호받는 로깅은 권장되지 않습니다.

수행: 컴포넌트의 정상 오퍼레이션을 표시하고 다른 코드 세그먼트에서 발생할 수 있는 문제점을 해결하는 데 유용하게 될 이벤트의 경우 INFO를 사용하십시오. 예를 들어, 설치 오퍼레이션의 완료를 확인한 후에는 실행기로부터 다음 메시지가 로깅됩니다.

Done with install operations

수행: 불리하게 정상 오퍼레이션에 영향을 줄 문제점이 발생했지만 대부분의 오퍼레이션이 계속되도록 할 경우에 WARNING을 사용하십시오. 좋은 예제는 프로비저닝으로부터의 다음 메시지입니다.

Failed to retrieve page file for URL EXPEDITOR.png.

수행: 일부 기능의 전체가 손실되거나 상당부분이 손실되도록 하는 이벤트를 표시하려면 SEVERE를 사용하십시오. SEVERE 메시지의 예제는 plugin_customization.ini를 읽을 수 없을 때 플랫폼 플러그인이 기록하는 메시지입니다.

Error loading plugin customization file

FINER: FINER 레벨의 메시지를 생성하는 로거(logger) 메소드 세트가 있습니다. 해당 메소드는 entering(...), exitin(..), finer(..) 및 throwing(..)입니다.

• 메소드 entry 및 exit에 Entering 및 exiting을 사용해야 합니다.
• Finer는 Fine에 대해 원하는 것보다 더 다양한 추적에 사용할 수 있지만 메소드 entry/exit가 아니거나 예외 발생 이전에 사용할 수 없습니다.
• 예외를 발생하거나 다시 발생하려고 할 때 throwing을 사용해야 합니다.

모든 예외는 로깅 문장으로 기록해야 합니다. 보통 예외가 사소하지 않거나 다시 발생하지 않으면 WARNING 또는 SEVERE 레벨에 있습니다. 추가 가이드라인은 다음과 같습니다.

• 항상 예외를 포함하여 로그 항목에 대해 특정 메시지를 제공하십시오. 예외의 영향을 설명해야 합니다.
• 메시지가 아니라 예외를 로깅하십시오. 사용자 스스로 설정하지 않으면 메시지가 이해 가능하거나 존재하는지 조차 보장하지 못하게 됩니다.
• 예외에 대해 printStackTrace를 호출하지 마십시오. 로거(logger)가 자동으로 예외에 응답하도록 허용하는 방식으로 이를 수행합니다. .
• 예외를 발견한 후 새 예외가 발생하는 경우(종종 잘 작성된 API에서) 발생한 예외의 원인으로 발견된 예외를 사용해야 합니다. 일반적으로, 이와 같은 경우 발견된 예외는 로깅하지 말아야 합니다(이 때 스택까지의 모든 것이 동일한 가이드라인을 따른다고 가정합니다).
• 이 정보가 사용자에게 유익하면 다른 예외를 발생시킬 경우에도 예외를 로그하는 것이 좋을 때도 있습니다.

다음의 두 코드 샘플은 공통되는 로깅 패턴입니다.

  _logger.logp(Level.INFO, CLAZZ_NAME, METHOD,
"Messages.PROCESS_RECS");

예외를 로깅해야 하는 경우:

_logger.logp(Level.SEVERE,CLAZZ_NAME,METHOD,Messages,RCP_XML_PROCESSING_ERROR
    throwable);

추적 예제 1:

if (_logger.isLoggable(Level.FINE)) 
        	            	_logger.logp(CLASS_NAME_METHOD,"Setting activities for page 
                           " + _model.getName() + ":");    	 }

추적 예제 2:

	private GUID methodX(URL url, IProgressMonitor pM, boolean overrideCache) {

          final String METHOD="methodX";
		if (logger.isLoggable(Level.FINER)) {
			logger.entering(CLASSNAME, METHOD, url==
                             null?"null":url.toExternalForm());
		}
		…
	}

이 예제에서는 URL만 입력에 대해 로깅됩니다. 다른 인수는 디버깅하는 동안 유용하지 않기 때문입니다. 종종 애플리케이션이 로드되지 않을 때 부분적으로 계산되는 부분적으로 손상된 URL에 문제점이 있으므로, 로드 호출로 전달되는 URL을 정확히 확인하는 것이 아주 중요합니다. 또한 이는 개인용 메소드입니다. 이 개인용 메소드를 호출하여 해당 작업을 수행하는 많은 공용 메소드가 있으므로, 공용 호출에 의해 여러 번 URL이 로깅되도록 하는 대신 이 메소드로 로그인을 집중시킵니다.

		logger.exiting(CLASSNAME, METHOD, res);

추적 예제 3:

public void showApplication(URL url, String pageId, IProgressMonitor 
          progressMonitor)
		 throws IllegalArgumentException, CompositeApplicationException {

    final String METHOD="showApplication";
		if (logger.isLoggable(Level.FINER)) {
			logger.entering(CLASSNAME, 
				
    METHOD, 
				new Object[] {url, pageId, progressMonitor});
		}
} catch (RuntimeException e) {
			logger.logp(Level.SEVERE,CLASS NAME, METHOD
Messages.PORTAL APP JOB UPDATE ERROR, e);
			throw new CompositeApplicationException(e);
		}