요소기술 - 에러메시지

개요

에러에 해당되는 메시지 정보를 확인할 수 있는 공통기능을 제공한다.

활용 예시

에러메시지 기능은 다음과 같은 상황에서 활용할 수 있다.

• 예외 발생 시 사용자에게 오류 내용을 안내하는 경우
• 입력값 검증 실패 메시지를 출력하는 경우
• 다국어 환경에서 공통 에러메시지를 관리하는 경우
• Property 파일을 이용하여 에러메시지를 중앙에서 관리하는 경우

설명

Property 파일에 정의된 에러메시지를 조회하여 반환하는 기능을 제공한다.

메시지 키를 이용하여 에러메시지를 조회할 수 있으며, 필요한 경우 파라미터를 전달하여 동적으로 메시지를 생성할 수 있다.

관련소스

메소드

Input

• key : 속성 파일에 기록된 key 정보
• params : 대치될 문자열 배열 정보
• Validation 체크: 요소기술 Validation 체크

Output

• String : 지정한 메시지 키에 해당하는 에러메시지 문자열. 해당 키가 존재하지 않으면 null을 반환한다.

환경설정

메시지 처리를 위해서는 User home 디렉토리밑에 egovProps/conf/errormessage.properties 파일에 메시지가 정의되어 있어야 한다. 해당 메시지 정의는 일반 property 정의 방식과 같다.

• User home 디렉토리 : System.getProperty(“user.home”)를 통해 얻는 정보로 Windows 계열의 OS는 보통 “C:\Documents and Settings\사용자계정"이고, Unix계정의 경우는 “/home/사용자계정"이 된다.

사용 시 주의사항

• 메시지 키는 errormessage.properties 파일에 정의되어 있어야 한다.
• 존재하지 않는 메시지 키를 조회하는 경우 null이 반환될 수 있다.
• 파라미터 개수와 메시지의 치환 인덱스({0}, {1} 등)가 일치하는지 확인해야 한다.

사용방법

우선 errormessage.properties 파일에 다음과 같은 메시지가 정의되어 있다고 가정한다.

test.message = error message
param.message = error message : {0} = {1}

import egovframework.com.utl.cas.service.EgovMessageUtil;
 
...
String message = null;
 
// 일반 경고 메시지 취득
message = EgovMessageUtil.getErrorMsg("test.message");
 
// 파라미터 처리 경고 메시지 취득 : String 배열의 값이 각각 {0}, {1}로 대치됨
message = EgovMessageUtil.getErrorMsg("param.message", new String[2] {"오류", "해당되는 기대값이 없습니다."});

참고자료

• 경고메시지 참조: 경고메시지
• 정보메시지 참조: 정보메시지
• 확인메시지 참조: 확인메시지