🔥우당탕탕 개발기 - 로그

온갖 예상을 뛰어넘는 서비스 장애에 빠르게 대비하기 위해 Log를 잘 남겨야 한다. 열심히 (안정적이라고 생각하는) 코드를 작성하고 테스트해도 장애가 발생할 가능성은 항상 있다. 장애가 난 곳을 파악하고 빠르게 대응해서 피해를 최소화해야 한다. 이를 위해 프로그램 상태를 모니터링할 수 있는 정보를 기록하는 것을 로깅이라고 한다. 나는 slf4j 로깅 라이브러리를 사용했다. 그리고 모든 함수가 실행되고 끝날 때 로그를 찍어 보고자 AOP 개념을 공부했다.

조인 포인트(Join point)

조인 포인트는 추상적인 개념이다. AOP를 적용할 수 있는 모든 지점이라 생각하면 된다. 스프링 AOP는 프록시 방식을 사용하므로 조인 포인트는 항상 메소드 실행 지점으로 제한된다.

포인트컷 (Pointcut)

조인 포인트 중에서 어드바이스가 적용될 위치를 선별하는 기능

어드바이스(Advice)

특정 조인 포인트에서 Aspect에 의해 취해지는 조치, Around(주변), Before(전), After(후)와 같은 다양한 종류의 어드바이스가 있음

package hello.mentoring.aop;

import org.aspectj.lang.annotation.Pointcut;

public class Pointcuts {

    @Pointcut("execution(* hello.mentoring..*.*(..))")
    public void log() {}

    @Pointcut("execution(* hello.mentoring.controller.*.*(..))")
    public void controller() {}

    @Pointcut("execution(* hello.mentoring.service.*.*(..))")
    public void service() {}

    @Pointcut("execution(* hello.mentoring.repository.*.*(..))")
    public void repository() {}
}

처음에는 서비스 패키지에만 로그를 걸고 싶었는데, 컨트롤러, 서비스, 레포지토리 모두 로그가 필요할 것 같아서 다 만들었다.

어드바이스 종류

• @Around : 메서드 호출 전후에 수행, 가장 강력한 어드바이스, 조인 포인트 실행 여부 선택, 반환 값 변환, 예외 변환 등이 가능
• @Before : 조인 포인트 실행 이전에 실행
• @AfterReturning : 조인 포인트가 정상 완료후 실행
• @AfterThrowing : 메서드가 예외를 던지는 경우 실행
• @After : 조인 포인트가 정상 또는 예외에 관계없이 실행(finally)

package hello.mentoring.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.io.*;
import java.lang.reflect.Method;
import java.util.Date;

@Slf4j
@Aspect
@Component
public class LogAop {

    @Before("hello.mentoring.aop.Pointcuts.log()")
    public void before(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

		// 조언되는 메서드에 대한 설명
        log.info("[before] {}", joinPoint.getSignature());

        Object[] args = joinPoint.getArgs();
        for (Object arg: args) {
            log.info("parameter value = {}", arg);
        }
    }

    @AfterReturning(value="hello.mentoring.aop.Pointcuts.log()", returning = "result")
    public void doRetutn(JoinPoint joinPoint, Object result) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

        log.info("[return] {}", joinPoint.getSignature());

        Object[] args = joinPoint.getArgs();
        for (Object arg: args) {
            log.info("parameter value = {}", arg);
        }
    }

    @AfterThrowing(value="hello.mentoring.aop.Pointcuts.log()", throwing = "ex")
    public void doThrowing(JoinPoint joinPoint, Exception ex) {
        log.info("[ex] {} message={}", joinPoint.getSignature(), ex.getMessage());
    }



}

로그파일을 생성할 경로나 파일 이름을 properties에 지정할 수 있다.

#logging.file.path=/Users/jiho/Documents/Spring/file/
logging.file.name=log