AOP로 ‘지루한’ 로깅 코드를 날려버리기

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'      // 기본 스타터
    implementation 'org.springframework.boot:spring-boot-starter-aop'  // AOP 지원
    // SLF4J+Logback은 스타터에 이미 포함되어 있습니다.
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Loggable {
    LogLevel level() default LogLevel.INFO;       // 로그 레벨
    boolean showParams() default true;            // 파라미터 로깅 여부
    boolean showResult() default true;            // 반환값 로깅 여부
    boolean measureExecutionTime() default true;  // 실행 시간 측정 여부
    String prefix() default "";                   // 메시지 앞에 붙일 접두사
}

public enum LogLevel { TRACE, DEBUG, INFO, WARN, ERROR }

@Aspect
@Component
public class LoggingAspect {

    // @Loggable이 붙은 메소드 또는 클래스 범위
    @Pointcut("@annotation(com.example.logging.annotation.Loggable)"
            + " || @within(com.example.logging.annotation.Loggable)")
    public void loggablePointcut() {}

    @Around("loggablePointcut()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 1) 메소드·클래스 정보 추출
        MethodSignature sig = (MethodSignature) joinPoint.getSignature();
        Method method = sig.getMethod();
        String className = joinPoint.getTarget().getClass().getSimpleName();
        String methodName = method.getName();
        Logger logger = LoggerFactory.getLogger(joinPoint.getTarget().getClass());

        // 2) @Loggable 설정 가져오기
        Loggable loggable = method.getAnnotation(Loggable.class);
        if (loggable == null) {
            loggable = joinPoint.getTarget().getClass().getAnnotation(Loggable.class);
        }

        // 3) 실행 시작 로그
        String prefix = loggable.prefix().isEmpty() ? "" : "[" + loggable.prefix() + "] ";
        Object[] args = joinPoint.getArgs();
        if (loggable.showParams() && args.length > 0) {
            String params = formatParameters(sig.getParameterNames(), args);
            logByLevel(logger, loggable.level(),
                "{}{}#{} - 실행 시작, 파라미터: {}", prefix, className, methodName, params);
        } else {
            logByLevel(logger, loggable.level(),
                "{}{}#{} - 실행 시작", prefix, className, methodName);
        }

        // 4) 실제 메소드 호출 및 종료/예외 처리
        long start = System.currentTimeMillis();
        try {
            Object result = joinPoint.proceed();
            long elapsed = System.currentTimeMillis() - start;

            // 4‑1) 실행 완료 로그
            if (loggable.showResult()) {
                String resStr = formatResult(result);
                String msg = loggable.measureExecutionTime()
                    ? "{}{}#{} - 실행 완료 ({}ms), 반환값: {}"
                    : "{}{}#{} - 실행 완료, 반환값: {}";
                logByLevel(logger, loggable.level(),
                    msg, prefix, className, methodName, elapsed, resStr);
            } else if (loggable.measureExecutionTime()) {
                logByLevel(logger, loggable.level(),
                    "{}{}#{} - 실행 완료 ({}ms)", prefix, className, methodName, elapsed);
            } else {
                logByLevel(logger, loggable.level(),
                    "{}{}#{} - 실행 완료", prefix, className, methodName);
            }
            return result;
        } catch (Exception e) {
            // 4‑2) 예외 발생 시 무조건 ERROR
            logger.error("{}{}#{} - 실행 실패: {}", prefix, className, methodName, e.getMessage(), e);
            throw e;
        }
    }

    // 파라미터·결과 스트링으로 변환하는 헬퍼 메소드들(formatParameters, formatResult, formatValue, logByLevel…)
    // (생략: 본문 참고)
}

@Configuration
@EnableAspectJAutoProxy
@ComponentScan("com.example.logging")
public class LoggingAutoConfiguration {}

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.logging.config.LoggingAutoConfiguration

@Service
public class ProductService {

    @Loggable                           // 기본 INFO, 파라미터/결과/시간 모두 로깅
    public List<String> getAllProducts() { … }

    @Loggable(level = LogLevel.DEBUG,
               showResult = false)     // DEBUG 레벨, 결과 생략
    public String getProductById(Long id) { … }

    @Loggable(measureExecutionTime = false,
               prefix = "상품관리")     // 실행 시간 생략, 접두사 포함
    public void updateProduct(Long id, String name, Double price) { … }

    @Loggable(level = LogLevel.WARN)    // WARN 레벨, 실패 시 에러 로그
    public Optional<String> findProductByCode(String code) { … }

    @Loggable(level = LogLevel.TRACE)   // TRACE 레벨로 가장 상세히 로깅
    public int processOrder(Long orderId,
            List<String> productCodes, boolean isPriority) { … }
}

@SpringBootTest(classes = {ProductService.class, LoggingAutoConfiguration.class})
public class LoggingAspectTest {
    @Autowired ProductService svc;

    @Test
    void testBasicLogging(CapturedOutput out) {
        svc.getAllProducts();
        assertThat(out).contains("ProductService#getAllProducts - 실행 시작");
        assertThat(out).containsPattern("\\(\\d+ms\\), 반환값: \\[.*\\]");
    }
    // … 그 외 DEBUG/예외/다양한 파라미터 케이스 테스트
}

<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  <logger name="com.example.logging" level="DEBUG"/>
  <root level="INFO">
    <appender-ref ref="CONSOLE"/>
  </root>
</configuration>

• com.example.logging(우리 AOP 코드)만 DEBUG로 띄워서, 개발 중 상세 로그를 볼 수 있게 하고
• 그 외 애플리케이션은 INFO 이상으로 통일해서 잡다한 로그를 줄여줍니다.