delombok.io.github.qsy7.logging.plugin.LoggingPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plugin Show documentation
There is a newer version: 0.3.3
// Generated by delombok at Fri Jan 12 23:25:53 EST 2024
package io.github.qsy7.logging.plugin;

import static net.bytebuddy.matcher.ElementMatchers.is;
import io.github.qsy7.logging.ContextualLoggable;
import io.github.qsy7.logging.FieldContextualLoggable;
import io.github.qsy7.logging.annotation.NonLoggable;
import io.github.qsy7.logging.plugin.advice.ContextualExceptionAdvice;
import io.github.qsy7.logging.plugin.advice.ExceptionAdvice;
import io.github.qsy7.logging.plugin.advice.FieldContextualExceptionAdvice;
import io.github.qsy7.logging.plugin.enumeration.LogAdviceType;
import java.lang.reflect.Method;
import java.util.Arrays;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.build.HashCodeAndEqualsPlugin;
import net.bytebuddy.build.Plugin;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.ClassFileLocator;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.matcher.ElementMatchers;

@HashCodeAndEqualsPlugin.Enhance
public class LoggingPlugin extends Plugin.ForElementMatcher implements Plugin.Factory {
  @java.lang.SuppressWarnings("all")
  private static final org.slf4j.Logger LOGGER = org.slf4j.LoggerFactory.getLogger(LoggingPlugin.class);

  public LoggingPlugin() {
    super(ElementMatchers.declaresMethod(ElementMatchers.not(ElementMatchers.isAnnotatedWith(NonLoggable.class))));
  }

  @Override
  public DynamicType.Builder apply(DynamicType.Builder builder, TypeDescription typeDescription, ClassFileLocator classFileLocator) {
    return apply(builder, typeDescription);
  }

  public static DynamicType.Builder apply(DynamicType.Builder builder, TypeDescription typeDescription) {
    for (MethodDescription.InDefinedShape methodDescription : typeDescription.getDeclaredMethods().filter(ElementMatchers.not(ElementMatchers.isBridge()))) {
      // wire in info and exception advice
      final Class adviceClass = LogAdviceType.getAdvice(methodDescription);
      if (adviceClass == null) {
        continue;
      }
      if (isInfrastructure(typeDescription, methodDescription)) {
        LOGGER.warn("skipping additional logging on infrastructure method:" + typeDescription.getName() + "." + methodDescription.getName());
        continue;
      }
      try {
        builder = builder.visit(Advice.to(adviceClass).on(is(methodDescription)));
        // 2022/04/17 - previously disabled
        // exceptions may be caught more than once by this
        // previously used a ThreadLocal + WeakReference, but that also doesn't seem ideal
        builder = handleExceptions(builder, typeDescription, methodDescription);
      } catch (IllegalStateException e) {
        LOGGER.warn(String.format("Unable to apply advice: %s %s", adviceClass, methodDescription), e);
      }
    }
    return builder;
  }

  private static boolean isInfrastructure(final TypeDescription typeDescription, final MethodDescription methodDescription) {
    if (typeDescription.isAssignableTo(ContextualLoggable.class)) {
      return Arrays.stream(ContextualLoggable.class.getDeclaredMethods()).filter(method -> method.getName().equals(methodDescription.getName()) && matchesParameters(method, methodDescription)).findFirst().isPresent();
    }
    return false;
  }

  private static boolean matchesParameters(final Method method, final MethodDescription methodDescription) {
    if (method.getParameterCount() != methodDescription.getParameters().size()) {
      return false;
    }
    int i = 0;
    for (Class parameterType : method.getParameterTypes()) {
      if (parameterType.equals(methodDescription.getParameters().get(i))) {
        return false;
      }
      i++;
    }
    return true;
  }

  private static DynamicType.Builder handleExceptions(final DynamicType.Builder builder, final TypeDescription typeDescription, final MethodDescription methodDescription) {
    if (!methodDescription.isConstructor()) {
      if (!methodDescription.isStatic()) {
        if (typeDescription.isAssignableTo(ContextualLoggable.class)) {
          LOGGER.info("Applying ContextualExceptionAdvice:" + typeDescription.getName() + ", " + methodDescription.getName());
          return builder.visit(Advice.to(ContextualExceptionAdvice.class).on(is(methodDescription)));
        }
        if (typeDescription.isAssignableTo(FieldContextualLoggable.class)) {
          LOGGER.info("Applying FieldContextualExceptionAdvice:" + typeDescription.getName() + ", " + methodDescription.getName());
          return builder.visit(Advice.to(FieldContextualExceptionAdvice.class).on(is(methodDescription)));
        }
      }
      LOGGER.info("Applying ExceptionAdvice:" + typeDescription.getName() + ", " + methodDescription.getName());
      return builder.visit(Advice.to(ExceptionAdvice.class).on(is(methodDescription)));
    }
    return builder;
  }

  @Override
  public void close() {
  }

  @Override
  public Plugin make() {
    return this;
  }
}