[java] Java Byte Buddy를 사용한 로그 파일 생성

23 Nov 2023

java

많은 애플리케이션에서는 로그 파일을 생성하여 디버깅 및 오류 추적에 사용합니다. 이번 기사에서는 Java Byte Buddy 라이브러리를 사용하여 로그 파일을 생성하는 방법을 알아보겠습니다.

1. Byte Buddy 라이브러리 추가

먼저 Maven 또는 Gradle 프로젝트에 Byte Buddy 라이브러리를 추가해야 합니다. Maven 프로젝트의 경우 pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
    <groupId>net.bytebuddy</groupId>
    <artifactId>byte-buddy</artifactId>
    <version>1.11.5</version>
</dependency>

Gradle 프로젝트의 경우 build.gradle 파일의 dependencies 부분에 다음 의존성을 추가합니다:

implementation 'net.bytebuddy:byte-buddy:1.11.5'

의존성을 추가한 후 프로젝트를 다시 빌드해야 합니다.

2. 로그 생성 클래스 작성

다음으로 로그를 생성할 클래스를 작성해야 합니다. 아래 코드는 LoggingClass라는 이름의 클래스를 생성하고, log 메서드를 추가한 예시입니다.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingClass {
    private static final Logger LOGGER = LoggerFactory.getLogger(LoggingClass.class);

    public void log(String message) {
        LOGGER.info(message);
    }
}

위의 코드에서는 slf4j 라이브러리를 사용하여 로그를 작성합니다. 이 라이브러리는 로깅 시스템과 상호 작용하기 위해 사용됩니다.

3. Byte Buddy로 로그 생성 확장

이제 Byte Buddy를 사용하여 LoggingClass를 확장하여 로그 파일 생성 기능을 추가합니다. 아래 코드는 LoggingClass를 LogToFileClass로 확장한 예시입니다:

import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.builder.AgentBuilder;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
import net.bytebuddy.implementation.FixedValue;
import net.bytebuddy.matcher.ElementMatchers;

import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.lang.instrument.Instrumentation;

public class LogToFileClass {
    public static void premain(String arguments, Instrumentation instrumentation) throws Exception {
        new AgentBuilder.Default()
            .type(ElementMatchers.nameContains("LoggingClass"))
            .transform((builder, typeDescription, classLoader, module) -> {
                try {
                    return builder.method(ElementMatchers.named("log"))
                        .intercept(MethodDelegation.to(LogInterceptor.class));
                } catch (ClassNotFoundException e) {
                    throw new IllegalStateException(e);
                }
            })
            .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION)
            .with(AgentBuilder.InitializationStrategy.NoOp.INSTANCE)
            .with(AgentBuilder.TypeStrategy.Default.REDEFINE)
            .installOn(instrumentation);
    }

    public static class LogInterceptor {
        public static String log() throws Exception {
            String message = (String) ArgumentLoader.loadArgument(0);
            String logMessage = "[LOG] " + message;

            File logFile = new File("logfile.txt");
            try (OutputStream outStream = new FileOutputStream(logFile, true)) {
                outStream.write(logMessage.getBytes());
                outStream.write(System.getProperty("line.separator").getBytes());
            }

            return logMessage;
        }
    }

    public static class ArgumentLoader {
        public static Object loadArgument(int index) throws ClassNotFoundException {
            Class<?> stackWalkerClass = Class.forName("java.lang.StackWalker");
            Object stackWalkerInstance = stackWalkerClass.getMethod("getInstance").invoke(null);
            Object stackFrame = stackWalkerClass.getMethod("getCallerFrame").invoke(stackWalkerInstance);
            Object[] methodArgs = (Object[]) stackFrame.getClass().getMethod("getArguments").invoke(stackFrame);
            return methodArgs[index];
        }
    }
}

위의 코드에서는 premain 메서드를 사용하여 Agent를 등록합니다. AgentBuilder를 사용하여 LoggingClass를 찾아서 log 메서드를 LogInterceptor로 대체합니다. LogInterceptor는 로그를 파일에 작성하는 역할을 합니다.

4. 로그 파일 생성 테스트

이제 프로그램을 실행하여 로그를 파일에 생성하는지 확인할 수 있습니다. 아래 코드는 테스트하기 위한 간단한 메인 클래스 예시입니다:

public class Main {
    public static void main(String[] args) {
        LoggingClass loggingClass = new LoggingClass();
        loggingClass.log("Hello, World!");
    }
}

프로그램을 실행한 후 logfile.txt 파일을 확인하면 로그가 생성된 것을 볼 수 있습니다.

결론

Java Byte Buddy를 사용하여 로그 파일 생성 기능을 추가하는 방법을 알아보았습니다. 이를 통해 애플리케이션의 디버깅 및 오류 추적에 도움이 되는 로그 파일을 생성할 수 있습니다. 예제 코드와 함께 Byte Buddy 문서를 참조하여 원하는 강화 기능을 추가할 수도 있습니다.