Spring MVC 기본 기능 - Logging

로깅

앞으로는 System.out.println()과 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력하도록 하겠습니다.

 

🚩 로그와 관련해서는 깊게 들어가면 끝도 없기 때문에 여기서는 최소한의 사용 방법만 알아보고 사용하도록 하겠습니다.

 

로그 사용 장점

• 쓰레드 정보, 클래스 이름 같은 부가정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있습니다.
• 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영 서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있습니다.
• System.out 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있습니다.
• 특히 파일로 남길 때에는 날짜 별, 특정 용량에 따른 로그 분할도 가능합니다.
• 성능 자체도 일반 System.out보다 좋습니다. (내부 버퍼링이나, 멀티 쓰레드 등등 ) 

그래서 실무에서는 시스템 콘솔을 사용하지 않고 로그를 꼭 로그를 사용해야 합니다. 

 

로깅 라이브러리

스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함됩니다.

스프링 부트 로깅 라이브러리는 기본적으로 SLF4J, Logback을 사용합니다.

 

로그 라이브러리는 Logback, Log4J, Log4J2 등 여러 라이브러리가 있지만, 이를 통합해 인터페이스로 제공하는 것이 SLF4J

로그 선언 방법

1. 직접 객체 호출해서 선언

private Logger log = LoggerFactory.getLogger(getClass());

2. @Slf4j 어노테이션으로 선언

@Slf4j
public class LogTestController{

	...

로그 호출

시스템 콘솔을 통한 직접 출력에서는 System.out.println("hello"); 와 같은 형태로 출력했습니다.

로그는 log.info("hello"); 와 같은 형태로 출력합니다.

 

또한 로그는 시스템 콘솔과 다르게 로그 레벨이 있어 레벨을 지정하여 로그를 남길 수 있습니다.

우선 코드를 통해 어노테이션으로 로그를 선언하고 레벨 별로 로그를 남겨보겠습니다.

 

@Slf4j
@RestController
public class LogTestController {

    @RequestMapping("/log-test")
    public String logTest()
    {
        String name = "Spring";

        System.out.println("name = " + name);

        // log high -> low Level
        log.trace("trace log = {}", name);
        log.debug("debug log = {}", name);
        log.info("info log = {}", name);
        log.warn("warn log = {}", name);
        log.error("error log = {}", name);

        return "OK";
    }
}

 

 @Controller를 사용하면 리턴 타입이 String일 경우에 해당 String과 일치하는 뷰를 찾고 뷰를 렌더링 하게 되는 반면, @RestController는 @Controller에 @ResponseBody를 더한 것과 같은 어노테이션으로 메소드의 return 타입이 String 일 경우에 String을 message body로 리턴합니다.

 

로그 레벨 

trace ▶︎ debug ▶︎ info ▶︎ warn ▶︎ error

High -------------------------------Low

 

로그 레벨 설정

application.properties 에서 설정할 수 있습니다.

#전체 로그 레벨 설정(기본 info)
logging.level.root=info

#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug

이렇게 레벨을 설정하면 설정해 준 레벨을 포함해 낮은 레벨들의 로그만 출력해줍니다.

대개 개발 서버에서는 로그레벨을 debug 레벨로, 운영 서버에서는 info 레벨로 지정해줍니다.

 

올바른 로그 사용법

(O) log.debug("data = {}", data);

의미없는 연산이 발생하지 않습니다.

 

(X) log.debug("data = " + data);

 

잘못된 경우의 케이스로 작성하게 되면 출력레벨을 debug보다 낮은 info로 설정해도 코드의 "data = " + data가 실제 실행이 되어 버리기 떄문에 결과적으로 문자 더하기 연산이 발생합니다.

 

실무에서 애플리케이션에서는 수많은 로그를 남기기 때문에 이렇게 쓸데없는 연산을 해서 자원을 낭비하는 경우가 없어야 합니다.