📅 2024년 01월 29일

53일차 : Spring (13)

Spring에서 Log

• application.yml

# trace < debug < info < error 순으로 로그레벨를 가짐
# info 설정 시  trace, debug 로그는 출력되지 않음
logging:
  # 로그파일 경로와 파일명 지정
  file:
    name: logs/app.log
  level:
    root: info

• LogTestController

/*
@Slf4j 를 통해 logBack 로그라이브러리 사용가능
 */
@Slf4j
@RestController
public class LogTestController {
    /*
    @Slf4j를 사용하지 않고, 직접 라이브러리 import에 로거 생성가능
     */
    // private  static final Logger loger = LoggerFactory.getLogger("logger");
    @GetMapping("/log/test1")
    public String testMethod1(){
        log.debug("디버그 로그입니다.");
        log.info("인포 로그입니다.");
        log.error("에러 로그입니다.");
        return "ok";
    }
}

• 로깅 사용 이유

목적	설명
디버깅 및 문제 해결	어플리케이션의 문제를 식별하고 해결하기 위해 로그를 사용. 변수 값, 메소드 호출, 예외 스택 트레이스 등이 기록됨.
성능 모니터링	어플리케이션의 성능을 추적하고 모니터링하기 위해 로그를 사용. 메소드 실행 시간, 데이터베이스 쿼리 소요 시간 등이 기록될 수 있음.
감사 및 보안	사용자의 활동 추적, 보안 이벤트 로깅 등을 통해 감사 및 보안 목적으로 사용됨.
운영 및 모니터링	어플리케이션의 운영 상태를 추적하고 모니터링하기 위해 로그를 사용. 중앙 집중식으로 모니터링될 수 있음.

• log 파일 관리(logback-spring.xml)

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--CONSOLE 로그 관련 설정-->
    <appender name = "CONSOLE" class ="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %logger{36} - %msg%n </pattern>
        </encoder>
    </appender>
    <!--정상로그 관련 설정 -->
    <!--로깅에서 rolling 이라는 것은 날짜의 변함에 따라 파일을 새롭게 만들어주는 것 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %logger{36} - %msg%n </pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/app.%d{yyyy-MM-dd HH:mm:ss}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
    <!--에러로그 관련 설정 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <file>logs/app-error.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %logger{36} - %msg%n </pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/app-error.%d{yyyy-MM-dd HH:mm:ss}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
<!--info 로그의 경우 정상 log파일로 분리-->
    <root level = "info">
    <!--console 과 정상 로그파일레 로그내용 추가-->
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR_FILE"/>
    </root>
<!--error 로그의 경우 에러 log 파일로 분리-->
<!--    <logger level = "error" name="com.encore.board">-->
<!--        <appender-ref ref="ERROR_FILE"/>-->
<!--    </logger>-->
</configuration>

AOP (관점 지향 프로그래밍)

용어/개념	내용
Aspect (관점)	핵심 비즈니스 로직에서 발생하는 횡단 관심사를 모듈화한 것으로, 예를 들어 로깅, 트랜잭션 처리, 보안 등이 해당됨.
Advice (조언)	어느 시점에서 어디에 관점을 적용할지를 정의한 것으로, 메소드 호출 전, 후, 예외 발생 시 등과 같은 지점에서 적용될 수 있음.
Pointcut (포인트컷)	어떤 지점에서 어떤 관점을 적용할지를 정의한 것으로, 메소드 호출, 객체 생성, 필드 접근 등 다양한 지점을 지정할 수 있음.
Join Point (조인 포인트)	프로그램 실행 중 특정 시점으로, 관점이 적용되어야 하는 특정 지점을 나타냄. 메소드 호출, 객체 생성 등이 조인 포인트에 해당할 수 있음.
Weaving (위빙)	관점을 핵심 비즈니스 로직에 적용하는 과정으로, 코드에 관점을 삽입하거나 연결하여 실행되도록 만드는 것을 의미함.

• AopLogService

@Slf4j
@Aspect
@Component
public class AopLogService {
    /*
    aop 에 대상이 되는 controller, service 등을 정의
    @Pointcut("execution(* com.encore.board..controller..*.*(..))")
     */
    @Pointcut("within(@org.springframework.stereotype.Controller *)")
    public void controllerPointCut(){
    }
    // 방식 1
    @Before("controllerPointCut()")
    public void beforeController(JoinPoint joinPoint){
        log.info("Before Controller");
        /*
        메서드가 실행되기 전에 인증, 입력값 검증등을 수행하는 용도로 사용하는 사전단계
         */
        HttpServletRequest httpServletRequest = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        /*
        json 형태로 사용자의 요청을 조립하기 위한 로직
         */
        ObjectMapper objectMapper = new ObjectMapper();
        ObjectNode objectNode = objectMapper.createObjectNode();
        objectNode.put("Method Name",joinPoint.getSignature().getName());
        objectNode.put("CRUD Name", httpServletRequest.getMethod());
        Map<String, String[]> paramMap = httpServletRequest.getParameterMap();
        ObjectNode objectNodeDetail = objectMapper.valueToTree(paramMap);
        objectNode.set("user inputs", objectNodeDetail);
        log.info("user request info" + objectNode);
    }
    @After("controllerPointCut()")
    public void afterController(){
        log.info("end Controller");
    }

    // 방식 2
    @Around("controllerPointCut()")
    public Object controllerLogger(ProceedingJoinPoint proceedingJoinPoint){ // joinPoint 란 aop 대상으로 하는 컨트롤러의 특정 메서드를 의미
        // log.info("request method"+ proceedingJoinPoint.getSignature().toString());
        /*
        사용자의 요청값을 json 형태로 출력하기 위해 HttpServletRequest 객체를 꺼내는 로직
         */
        HttpServletRequest httpServletRequest = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        /*
        json 형태로 사용자의 요청을 조립하기 위한 로직
         */
        ObjectMapper objectMapper = new ObjectMapper();
        ObjectNode objectNode = objectMapper.createObjectNode();
        objectNode.put("Method Name",proceedingJoinPoint.getSignature().getName());
        objectNode.put("CRUD Name", httpServletRequest.getMethod());
        Map<String, String[]> paramMap = httpServletRequest.getParameterMap();
        ObjectNode objectNodeDetail = objectMapper.valueToTree(paramMap);
        objectNode.set("user inputs", objectNodeDetail);
        log.info("user request info" + objectNode);
        try {
            return proceedingJoinPoint.proceed();
        }catch (Throwable e){
            log.error(e.getMessage());
            throw new RuntimeException(e);
        }
    }
}

어노테이션	쓰임세	내용
@Pointcut	Pointcut을 정의하는 데 사용	특정 지점(메소드 호출, 객체 생성 등)에 AOP를 적용하기 위해 사용되는 표현식을 정의합니다. 해당 표현식은 여러 어드바이스에서 공유될 수 있습니다.
@Before	메소드 실행 전에 어드바이스를 실행	어드바이스 메소드를 특정 조인 포인트(메소드 호출 등) 전에 실행합니다. 주로 전처리 로직을 수행하는 데 사용됩니다.
@After	메소드 실행 후에 어드바이스를 실행	어드바이스 메소드를 특정 조인 포인트 후에 실행합니다. 주로 후처리 로직을 수행하거나 예외 처리에 사용됩니다.
@Around	메소드 실행 전후에 어드바이스를 실행	어드바이스 메소드가 조인 포인트를 감싸서 실행 전후에 로직을 수행할 수 있습니다. 가장 유연한 어드바이스로, 전, 후 처리 및 예외 처리 등 모든 로직을 포함할 수 있습니다.

@ControllerAdvice

: 컨트롤러 특화기능 주로 예외처리

• CommonException

@Slf4j
@ControllerAdvice
public class CommonException {
    @ExceptionHandler(EntityNotFoundException.class)
    public ResponseEntity<Map<String, Object>> entityNotFoundExceptionHandler(EntityNotFoundException e){
        log.error("EntityNotFoundException message : " + e.getMessage());
        return this.responseErrorMassage(HttpStatus.NOT_FOUND,e.getMessage());
    }
    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<Map<String, Object>> IllegalArgumentExceptionHandler(IllegalArgumentException e){
        log.error("IllegalArgumentException : " + e.getMessage());
        return this.responseErrorMassage(HttpStatus.BAD_REQUEST,e.getMessage());
    }
    private ResponseEntity<Map<String, Object>> responseMassage(HttpStatus status, Object object){
        Map<String, Object> map = new HashMap<>();
        map.put("status", Integer.toString(status.value()));
        map.put("message", object);
        return new ResponseEntity<>(map, status);
    }
    private ResponseEntity<Map<String, Object>> responseErrorMassage(HttpStatus status, String message){
        Map<String, Object> map = new HashMap<>();
        map.put("status", Integer.toString(status.value()));
        map.put("status message", status.getReasonPhrase());
        map.put("error message", message);
        return new ResponseEntity<>(map, status);
    }
}

만약 컨트롤러에서 try-catch 블록 내에서 예외를 처리하면 해당 메소드의 예외 처리 로직이 우선 호출되고, 처리하지 않거나 전파되는 경우에 @ControllerAdvice의 @ExceptionHandler 메소드가 호출

Spring 실습 github 링크