MyBatis와 Log4J 연동하기

• 관련글

- [JAVA/WEB] 웹 프로젝트에 MyBatis 세팅 및 적용하기

- MyBatis 설정 파일 - SQL Mapper 작성 방법

- MyBatis 설정 파일 작성 방법

---

MyBatis와 Log4J 연동하기

MyBatis와 log4j를 연동하여 MyBatis의 로그 출력 기능을 활용하는 방법에 대해 알아보자.

MyBatis의 로그 출력 기능을 이용하면 MyBatis에서 실행하는 SQL문, 파라미터 값, 실행 결과를 실시간으로 확인할 수 있다.

특히 동적 SQL문이 실행 조건에 따라 어떻게 달라지는지 확인할 수 있어 디버깅 시 매우 유용하다.

 

1. MyBatis 설정

MyBatis 설정 파일에 로그 출력 설정을 추가한다.

 

 

<configuration> 하위에 <settings>를 추가하고 <setting>을 사용해서 로그 출력기를 지정한다.

MyBatis는 여기에 지정한 도구를 사용해서 로그를 출력하다.

이 설정을 추가하지 않으면 로그 출력 기능은 동작하지 않는다.

 

1) name 속성

name은 logImpl로 지정한다.

 

2) value 속성

로그 출력 구현체를 지정한다.

SLF4J, LOG4J, LOG4J2, JDK_LOGGING, COMMONS_LOGGING, STDOUT_LOGGING, NO_LOGGING과 Log 인터페이스를 구현한 특정 클래스명을 지정할 수 있다.

 

value 속성값	설명
SLF4J	SLF4J
LOG4J	Log4j
LOG4J2	Log4j 2
JDK_LOGGING	JDK logging
COMMONS_LOGGING	Apache Commons Logging
STDOUT_LOGGING	표준 출력 장치로 출력
NO_LOGGING	로그 출력 기능 사용 안함
패키지명을 포함한 클래스명	org.apache.ibatis.logging.Log 인터페이스의 구현체

 

여기서는 log4j를 사용할 것이므로 LOG4J라고 지정하였다.

 

2. Log4J 라이브러리 준비

Log4j 라이브러리는 MyBatis 의존 라이브러리에 포함되어 있다.

MyBatis를 세팅할때 프로젝트에 이미 추가했을 것이다.

프로젝트 dependencies(Build path)에 log4j-x.x.x.jar가 있는지 확인해보고 없으면 https://mvnrepository.com/artifact/log4j/log4j 에서 다운받아 추가하자.

 

3. Log4J 설정 파일 작성

MyBatis에 로그 출력 설정을 추가하고 log4j 라이브러리 준비가 완료됐으면 마지막으로 log4j 설정 파일을 작성해야 한다.

로그 레벨, 출력 방식, 출력 형식, 로그 대상 등에 대한 정보가 들어간다.

자바 소스 폴더(src) 하위에 log4j.properties를 생성하고 다음과 같이 작성한다.

 

log4j.properties

log4j.rootLogger=ERROR, stdout
 
log4j.logger.com.atoz_develop.spms.dao=DEBUG
 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

 

1) 로그 레벨 설정 - rootLogger

먼저 rootLogger = 최상위 로거의 로그 레벨을 설정한다.

하위 로거들은 항상 부모의 로그 레벨을 상속받아서 별도로 설정하지 않으면 rootLogger의 레벨을 똑같이 따라간다.

 

표 - 로그 레벨

로그 레벨	설명
FATAL	어플리케이션을 중지해야 할 심각한 오류
ERROR	오류가 발생했지만 어플리케이션은 계속 실행할 수 있는 상태
WARN	잠재적인 위험을 갖고 있는 상태
INFO	어플리케이션의 주요 실행 정보
DEBUG	어플리케이션의 내부 실행 상황을 추적할 수 있는 상세 정보
TRACE	DEBUG보다 더 상세한 정보

각 레벨은 위 레벨을 포함해서 ERROR로 설정하면 FATAL 로그를 포함해서 출력하고 INFO로 설정하면 FATAL, ERROR, WARN 로그를 포함해서 출력한다. 따라서 TRACE로 설정하면 모든 로그를 출력한다.

 

2) Appender(출력 담당자) 선언

rootLogger의 로그 레벨 설정 다음에는 appender(출력 담당자)의 이름이 온다. appender 이름은 마음대로 지정할 수 있고 이렇게 선언한 이름으로 다음 설정에서 appender를 정의한다.

 

3) Appender(출력 담당자) 정의

Appender를 정의하는 방법은

log4j.appender.stdout(appender 이름)에 로그를 어디로 출력할지,

log4j.appender.stdout.layout에는 로그 출력 형식을,

log4j.appender.stdout.layout.ConversionPattern에는 로그를 출력할때 사용할 패턴을 정의한다.

 

(1) 로그를 어디로 출력할 것인가

로그를 기본 출력 장치인 모니터로 출력하거나 파일로 출력하거나 네트워크를 이용해서 원격의 서버로 출력할 수 있다.

위와 같이 ConsoleAppender로 설정하면 표준 출력 = 모니터로 출력한다.

 

주요 로그 출력 클래스는 다음과 같다.

 

클래스	설명
org.apache.log4j.ConsoleAppender	표준 출력 장치인 모니터로 출력한다. System.out 또는 System.err로 로그를 출력한다. 기본은 System.out이다.
org.apache.log4j.FileAppender	파일로 로그를 출력한다.
org.apache.log4j.net.SocketAppender	원격 로그 서버에 로그 정보를 담은 LoggingEvent 객체를 보낸다.

 

(2) 로그의 출력 형식

로그는 문자열, XML, HTML 형식이나 특정 패턴으로 출력할 수 있다.

위와 같이 설정하면 특정 패턴 형식에 따라 로그를 출력하도록 하는것이다.

이 경우 추가적으로 ConversionPattern 설정이 필요하다.

 

다음은 주요 출력 형식 클래스이다.

 

클래스	설명
org.apache.log4j.SimpleLayout	로그 레벨 - 메시지 형식
org.apache.log4j.HTMLLayout	HTML 테이블 형식
org.apache.log4j.PatternLayout	패턴에 따라 로그 출력
org.apache.log4j.xml.XMLLayout	log4j.dtd 규칙에 따라 XML을 만들어 출력

 

(3) 패턴 정의

PatternLayout에서 사용할 패턴을 정의한다.

 

• %5p : 로그 레벨을 5자리 문자열로 출력하라
• %t : thread 이름을 출력하라
• %m : 로그 내용을 출력하라
• %n : 다음 행

 

ConversionPattern을 정의하는 더 자세한 방법은 log4j 사이트 http://logging.apache.org/log4j/ 를 참고하자.

 

4) 특정 패키지의 클래스에 대해 로그 레벨 설정

rootLogger에 정의한 루트 레벨과 다른 레벨을 사용하고 싶으면 하위 로거를 선언해서 로그 레벨을 지정하면 된다.

 

log4.logger 다음에 패키지 이름을 지정하고 로그 레벨을 설정해주면 된다.

위와 같이설정하면 com.atoz_develop.spms.dao 패키지 하위의 클래스에 대해 로그 레벨을 DEBUG로 설정한다는 의미이다.

 

4. 로그 출력 테스트

서버를 기동하고 프로젝트를 실행한 뒤 DB와 연동하는 기능을 실행해보자.

 

패턴을 설정한 형식 대로 로그가 출력되며, MyBatis가 실행하는 SQL문과 파라미터, 결과를 이 로그를 통해 확인할 수 있다.

 

로그 레벨을 변경하고싶으면 저 부분을 변경하면 된다.

---

• 관련글

- [JAVA/WEB] 웹 프로젝트에 MyBatis 세팅 및 적용하기

- MyBatis 설정 파일 - SQL Mapper 작성 방법

- MyBatis 설정 파일 작성 방법

 

References

열혈강의 자바 웹 개발 워크북(프리렉, 2016, 엄진영)