📘[Java] 예외처리 로그 방식

예외처리 시 로그 남기기

서비스를 구현하다보면 여러 오류에 부딪힌다.
이 때, 예외처리를 진행한다면 어떤 부분에서 어떤 오류가 발생한 것인지 쉽게 파악할 수 있다.

인턴 기간동안 진행한 프로젝트에서는 org.slf4j.Logger, org.slf4j.LoggerFactory 라이브러리를 사용했다.
이 외에도 java.util.logging 라이브러리가 존재한다.
두 라이브러리는 개인 선호도 차이지만, slf4j 라이브러리가 logging에 비해 로깅에 대한 유연성이 크고, 다양한 백엔드를 지원하는 등의 특징 덕분에 많은 프로젝트에서 선호하는 라이브러리라고 한다.

어디에 사용하지?

프로젝트를 진행하며 Logger를 어디에 사용하는지 선임 개발자분들의 코드를 참조하여 알 수 있었다.
먼저, Logger를 선언해줘야 한다.

Logger log = LoggerFactory.getLogger(ProductController.class);

[예시 1]

    /**
	 * product 수정(Update) Controller
	 */
	@ResponseBody
	@RequestMapping("update")
	public String update(ProductVO voData, HttpSession session) {
		
		String resultCode = "success";

		// update
		try {
			productService.updateProduct(voData);
		} catch (Exception e) {
			log.error("update product failed.", e);
			resultCode = "failed";
		}
		
		return resultCode;
	}   

위와 같은 예시에서 보면, 변수 선언과 같은 부분은 try ~ catch 구문 밖에서 진행하고 Service(Impl)에 접근하는 로직부터는 try ~ catch 구문으로 감싸고 있다.
Logger는 try ~ catch 구문에서 사용하며, catch(Exception e)와 같이 예외가 발생하면 Exception으로 예외처리를 진행한다.
이 때, log.error() 메소드에 예외처리 변수를 넣어주어 예외 상황을 로그(log)로 알 수 있다.

[예시 2]

    /**
	 * product 수정(Update) Controller
	 */
	@ResponseBody
	@RequestMapping("update")
	public String update(ProductVO voData, HttpSession session) {
		
		String resultCode = "success";

		// update
		try {
			productService.updateProduct(voData);
		} catch (Exception e) {
			e.printStackTrace();
			resultCode = "failed";
		}
		
		return resultCode;
	}   

위에서는 log.error()가 아닌 e.printStackTrace() 메소드를 사용해 예외 처리를 진행했다.

이 둘의 차이점은 뭘까?

log.error() vs e.printStackTrace()

log.error()는 말 그대로 error 발생 시, 콘솔에 로그를 찍어주는 방식이다.
여기서는 log.error()만 사용했는데, 이 메소드는 요청을 처리하는 중 문제가 발생한 오류 정보를 콘솔에 찍어주는 방식이다.
log 메소드를 사용하면 로그레벨을 통해 원하는 수준의 로그까지만 볼 수 있다.

e.printStackTrace()는 에러의 발생 근원지를 찾아 단계별로 에러를 출력하는 방식이다.
이는 개발자가 상황을 분석하기 좋게 도와주는 역할을 하려 디버깅을 할 수 있는 힌트를 제공한다.
하지만, e.printStackTrace()를 지양하는 것이 좋다고 하는데 왜 그럴까?

왜 e.printStackTrace() 지양하는 것이 좋을까?

1. printStackTrace()를 call할 경우 System.err로 쓰여져 제어가 힘들다.
2. printStackTrace()는 java 리플렉션을 사용하여 추적하는 것 -> 많은 오버헤드 발생 가능.
3. printStackTrace()는 서버에서 스택정보를 취합하기 때문에 서버에 부하가 생길 가능성이 있음.
4. printStackTrace()는 출력이 어디로 가는지 파악이 어려움.(tomcat의 경우 catalina.out에 남음)

성능을 중요하게 여기는 어플리케이션이라면 e.printStackTrace()는 피하는 것이 좋다.

참고자료

https://tgyun615.com/59

https://developsd.tistory.com/132

운영 환경에서 오류 검출하기 [Log, Logging 개요, Log의 특징]