F010 - System.out.println(), Logger

✍️ 처음 Java를 공부 할 때, "Hello World" 라는 문자열을 콘솔창에 출력하는 것 부터 시작했다. 그리고 최근까지 웹 애플리케이션을 개발하면서 여러 정보를 확인하기 위해 System.out.println() 를 자주 사용했다.
하지만 CTO님께서 System.out.println()를 지양하고 Log 라이브러리를 써서 확인하라고 하셔서 묻지도 따지지도 않고 Log 라이브러리를 사용했다.

이번 시간에는 최근 멘토링 중에 멘토님께서 왜 실제 개발 시에 System.out.println()을 사용하면 안되는지, 왜 Log 라이브러리를 이용해야 하는지 질문해주셨는데 왜 그런지 알아보자!

---

System.out.println()

해당 명령어는 java.lang 패키지에 속한 System 클래스의 클래스 필드로 선언되어 있는 PrintStream 클래스의 메소드이다.

System.class

표준 입력과 표준 출력 그리고 오류 출력 스트림을 제공하는 클래스로 인스턴스화가 불가능한 클래스이다. 또한, 외부적으로 정의된 시스템에 관련한 속성이나 환경 변수 등을 엑세스 할 수 있고, 파일 및 라이브러리를 읽는 수단 그리고 배열을 복사하는 수단으로 사용 할 수 있는 클래스이다.

클래스 필드로 PrintStream, InputStream 클래스를 참조하고 있으며, PrintStream 클래스는 error, out 두 개의 클래스 변수로 선언했다.

대표적인 메소드 살펴보기

🔎 Syetem.gc() → GC를 실행한다.

🔎 System.out.println() → PrintStream 클래스를 이용해 문자열을 출력한다.

🔎 System.nanoTime() → 실행 중인 JVM의 현재 값을 나노초로 리턴한다.

PrintStream.class

FilterOutputStream 클래스를 상속 받는 클래스로 다양한 입력값을 콘솔창에 출력 할 수 있는 기능을 제공하며, 다른 출력 스트림과 달리 IOException 예외를 발생하지 않는다. 해당 클래스로 출력된 모든 문자열들은 플랫폼의 인코딩을 이용해 byte로 변환된다.

왜 사용을 지양하는걸까?

지금까지 어떤 상황에서 System.out.println()을 사용했을까? 주로 데이터가 현재 어떤 값을 가지고 있는지, 내가 의도한대로 조건문이 작성되었는지, for 구문에서 몇 번째 루프에 데이터값이 무엇인지 등의 상황에서 사용했었다.
(대부분 디버깅을 통해 확인 가능하다. 다만, 내겐 아직 익숙하지 않을 뿐💦)

그렇다면 다시 Java를 처음 배울 때로 돌아가서, "Hello Wolrd" 라는 문자열을 System.out.println() 으로 콘솔에 출력 했을 때 현재 시스템에 대한 기본 정보가 함께 출력되었는가? 오직 "Hello Wolrd" 라는 문자열만 출력되었다.

즉, System.out.println()을 실제 애플리케이션에서 사용했을 때는 현재 시스템의 기본 정보를 알 수 없다. 더 나아가 예외 발생 시, 콘솔 창에 출력만 하기 때문에 해당 메세지를 나중에 다시 확인 할 수가 없다.
(물론 개발자가 직접 현재 상태 등을 담아 파일로 저장하게끔 할 수도 있다. 번거로울 뿐!)

이러한 문제점으로 인해 애플리케이션의 상태를 분석하고 유지보수하기에 큰 어려움이 있다. 때문에 조금 더 수월하게 개발 할 수 있도록 Log 라이브러리를 사용하는 것이 좋다.

---

Logger

Log4j, Slf4j 등과 같은 다양한 라이브러리가 존재하지만 Java에서는 Logger라는 자체 라이브러리를 지원한다. Java의 Logger는 총 7단계의 레벨로 나뉘어 로깅을 할 수 있도록 제공한다.

• SEVERE (High Level)
• WARNING
• INFO
• CONFIG
• FINE
• FINER
• FINEST (Low Level)

Logger 클래스의 생성자는 protected가 선언되어 있기 때문에 new 생성자를 이용해서 변수 선언은 일반적으로 불가능하다. 하지만 Logger.getLogger() 메소드를 이용해 객체 생성이 가능한데 클래스의 이름과 필요하다면 리소스 이름을 매개 변수 인자로 넣어야 생성 할 수 있다.

보통 메소드 내에서 호출하기보다는 클래스 변수로 만들어 사용하는데, 앞에서 설명한 것처럼 클래스의 이름을 넣어야 하기 때문에 굳이 메소드 별로 지역 변수로 만들어 사용할 필요가 없기 때문이다.

private static final Logger logger = Logger.getLogger(LoggerTest.class.getName());

위의 코드처럼 private, statitc, final 제어자와 함께 선언하면 해당 클래스를 상속받는 자식 클래스에서는 부모 클래스의 logger를 호출 할 수 없고, 재정의도 불가능하며, 해당 객체가 메모리에 할당된 후 JVM이 종료될 때까지 메모리에 남아있게 된다.

logger.info("Hello");
logger.log(Level.WARNING, "위험한 상태!");

/*
	May 19, 2021 4:29:36 PM composition.interfaceComposition.InterfaceTest main
	정보: hello
	May 19, 2021 4:29:36 PM composition.interfaceComposition.InterfaceTest main
	경고: 위험한 상태!
*/

위의 코드를 보면 알 수 있듯, 다양한 방법으로 여러 레벨의 로그를 출력 할 수 있다.

왜 기본 라이브러리를 사용하지 않을까?

먼저 JDK 1.4를 기준으로 더 다양한 기능을 제공하는 log4j가 상용홛히어 있었기에 굳이 Logger를 찾아 쓸 필요가 없었다고 한다. 이는 단편적인 이유이고, 더 큰 이유는 다른 Log 라이브러리에 비해 성능 상 이슈가 많기 때문이다.

🛠 다른 라이브러리에 비해 퍼포먼스가 느리다.

🛠 FINE, FINER, FINEST 로그가 의미하는 것을 파악하기 힘들다.

🛠 개발자가 Custome Level을 구현 할 수 있는데, Custom Level을 이용해 로그 출력 시 메모리 누수가 발생한다.

🛠 다른 라이브러리에 비해 제공하는 기능이 적다.

---

🤔 최근부터 로그를 사용하기 시작하면서 아무 의미도 모른 채 사용하고, 선임 개발자님들께서 서버에 쌓인 로그 확인해보라고 하실 때 그 이유를 정확히 파악하지 못했는데, 이번 시간을 통해서 왜 로그를 사용해야 하는지 파악 할 수 있게 되었다.

또한, 이번 시간을 통해 그저 로그를 찍어보며 상태를 확인하기보단 디버깅과 테스트 주도 개발을 통해 문제를 해결 할 수 있는 역량을 키워야겠다고 느꼈다.

---

Java Platform SE 8

자바 java.util.logging vs log4j vs slf4j? 어떤 것을 사용해야 할까?