SLF4J 와 Logback

1. SLF4J와 Logback의 개요

a. SLF4J (Simple Logging Facade for Java)

• 정의: SLF4J는 다양한 로깅 프레임워크에 대한 추상화 계층을 제공하는 로깅 파사드(Facade)입니다.
• 역할: 애플리케이션 코드에서 직접 특정 로깅 프레임워크에 의존하지 않고, SLF4J API를 통해 로깅을 수행하도록 합니다. 이를 통해 로깅 구현체를 쉽게 교체하거나 변경할 수 있습니다.
• 장점:
  • 유연성: 여러 로깅 프레임워크(Log4j, Logback, java.util.logging 등)와 독립적으로 사용할 수 있습니다.
  • 일관된 API: 다양한 로깅 프레임워크에 대해 일관된 로깅 API를 제공합니다.
  • 성능 최적화: 메시지 포맷 시점에서 실제 로깅 여부를 검사하여 불필요한 문자열 연산을 방지합니다.

b. Logback

• 정의: Logback은 SLF4J의 창시자인 Ceki Gülcü가 개발한 고성능 로깅 프레임워크입니다.
• 역할: SLF4J의 구현체 중 하나로, 높은 성능과 다양한 기능을 제공하며, Log4j의 후속으로 자리잡았습니다.
• 장점:
  • 성능: Log4j에 비해 더 빠른 로깅 성능을 자랑합니다.
  • 유연성: 다양한 로깅 패턴, 로그 회전(Rolling), 필터링 기능 등을 지원합니다.
  • 자동 구성: Spring Boot와의 통합을 통해 별도의 설정 없이도 손쉽게 사용할 수 있습니다.
  • 확장성: 커스텀 앱렌더(Appender)나 레이아웃(Layout) 등을 쉽게 추가할 수 있습니다.

2. SLF4J와 Logback의 관계

SLF4J는 로깅 API의 추상화 계층을 제공하는 반면, Logback은 그 추상화를 구현하는 로깅 프레임워크입니다. 즉, SLF4J는 로깅을 위한 통합된 인터페이스를 제공하고, Logback은 그 인터페이스를 실제로 구현하여 로그를 기록하는 역할을 합니다.

흐름 예시:

1. 애플리케이션 코드: SLF4J API를 사용하여 로그를 작성합니다.
2. SLF4J 바인딩: SLF4J는 slf4j-logback과 같은 바인딩을 통해 Logback과 연결됩니다.
3. Logback: SLF4J의 로그 호출을 받아 실제 로그를 파일, 콘솔, 원격 서버 등으로 출력합니다.

이러한 구조 덕분에, 애플리케이션 코드는 SLF4J API에 의존하며, 로깅 구현체(Logback, Log4j 등)는 바인딩 설정을 통해 쉽게 변경할 수 있습니다.

3. SLF4J와 Logback의 설정 및 사용 방법

dependencies {
    // SLF4J API
    implementation 'org.slf4j:slf4j-api:2.0.7'
    
    // Logback Classic (SLF4J 구현체)
    implementation 'ch.qos.logback:logback-classic:1.4.11'
}

b. 로거 인스턴스 생성 및 사용

애플리케이션 코드 내에서 SLF4J 로거를 생성하고 사용하는 방법은 다음과 같습니다.

1. SLF4J를 사용한 로거 생성

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class MyService {
    
    // 로거 인스턴스 생성
    private static final Logger logger = LoggerFactory.getLogger(MyService.class);
    
    public void performTask() {
        logger.trace("Trace 레벨 메시지");
        logger.debug("Debug 레벨 메시지");
        logger.info("Info 레벨 메시지");
        logger.warn("Warn 레벨 메시지");
        logger.error("Error 레벨 메시지");
        
        try {
            // 일부 로직
        } catch (Exception e) {
            logger.error("예외 발생: {}", e.getMessage(), e);
        }
    }
}

설명:

• 로거 인스턴스 생성: LoggerFactory.getLogger(클래스명.class)를 통해 현재 클래스에 대한 로거 인스턴스를 생성합니다.
• 로깅 메시지 작성: logger.trace(), logger.debug(), logger.info(), logger.warn(), logger.error() 메서드를 사용하여 각 레벨에 맞는 메시지를 기록합니다.
• 파라미터 바인딩: {}를 사용하여 동적으로 값을 삽입할 수 있습니다. 이는 성능 최적화에도 도움이 됩니다.

2. Lombok을 활용한 로거 생성

Lombok 라이브러리를 사용하면 로거 인스턴스 생성 코드를 간소화할 수 있습니다.

Maven 의존성 추가:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.24</version>
    <scope>provided</scope>
</dependency>

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class MyService {
    
    public void performTask() {
        log.trace("Trace 레벨 메시지");
        log.debug("Debug 레벨 메시지");
        log.info("Info 레벨 메시지");
        log.warn("Warn 레벨 메시지");
        log.error("Error 레벨 메시지");
        
        try {
            // 일부 로직
        } catch (Exception e) {
            log.error("예외 발생: {}", e.getMessage(), e);
        }
    }
}

설명:

• @Slf4j 어노테이션을 클래스에 추가하면 Lombok이 자동으로 private static final Logger log 필드를 생성해줍니다.
• 이를 통해 로거 인스턴스 생성 코드를 간소화할 수 있습니다.

c. Logback 설정 파일

Logback의 동작 방식을 제어하기 위해 설정 파일을 사용할 수 있습니다. Spring Boot에서는 logback-spring.xml 또는 logback.xml 파일을 사용합니다.

logback-spring.xml 예시:

src/main/resources/logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 콘솔 로그 설정 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 파일 로그 설정 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 매일 롤링 -->
            <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 루트 로거 설정 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>

    <!-- 특정 패키지 로거 설정 -->
    <logger name="com.example.myapp" level="DEBUG" />
</configuration>