Внедрение инструментария для байт-кода времени сборки с Javassist

Если вам нужно изменить код в файлах классов во время (после) сборки без добавления каких-либо сторонних зависимостей, например, для внедрения сквозных задач, таких как ведение журнала, и вы не хотите иметь дело с Javassist — правильный инструмент для вас. Я уже писал в блоге о « Внедрении лучшего входа в двоичный .class с использованием Javassist », и сегодня я подробно остановлюсь на инструментальных возможностях Javassist и его интеграции в процесс сборки с помощью пользовательской задачи Ant.

терминология

• Инструментарий — добавление кода в существующие файлы .class
• Ткачество — инструментарий физических файлов, т.е. применение советов к файлам классов
• Совет — код, который «внедряется» в файл класса; обычно мы различаем рекомендации «до», «после» и «вокруг» в зависимости от того, как они применяются к методу
• Pointcut — указывает, где применить совет (например, полное имя класса + имя метода или шаблон, который понимает инструмент AOP)
• Инъекция — «логический» акт добавления кода в существующий класс с помощью внешнего инструмента
• АОП — аспектно-ориентированное программирование

Javassist против AspectJ

Почему вы должны использовать Javassit поверх классического AOP-инструмента, такого как AspectJ? Ну, обычно это не так, потому что AspectJ проще в использовании, менее подвержен ошибкам и намного более мощный. Но бывают случаи, когда вы не можете его использовать, например, вам нужно изменить байт-код, но вы не можете позволить себе добавить какие-либо внешние зависимости. При выборе между ними учитывайте следующее:

Javassist:

• Только базовые (но часто достаточные) инструментальные возможности
• Только во время сборки — изменяет файлы .class
• Измененный код не имеет дополнительных зависимостей (кроме тех, которые вы добавляете), т.е. вам не нужен javassist.jar во время выполнения
• Прост в использовании, но не так прост, как AspectJ; код для ввода обрабатывается как строка, которая компилируется в байт-код Javassist

AspectJ:

• Очень могущественный
• Поддерживается как время сборки, так и время загрузки (когда класс загружается JVM), ткачество (инструментарий)
• Измененный код зависит от библиотеки времени выполнения AspectJ (советы расширяют ее базовый класс, специальные объекты, используемые для обеспечения доступа к информации времени выполнения, такой как параметры метода)
• Его использование ничем не отличается от обычного программирования на Java, особенно если вы используете синтаксис на основе аннотаций (@Pointcut, @Around и т. Д.). Рекомендации составляются перед использованием и, таким образом, проверяются компилятором.

Классическая библиотека манипулирования байт-кодом:

• Слишком низкоуровневый, вам нужно определить и добавить инструкции байт-кода, в то время как Javassist позволяет вам добавлять фрагменты кода Java

Инструментарий с Javassist

О некоторых основных изменениях, которые вы можете сделать с Javassist. Это ни в коем случае не исчерпывающий список.

Объявление локальной переменной для передачи данных от до до после рекомендации

Если вам нужно передать некоторые данные из предварительного совета в последующий совет, вы не можете создать новую локальную переменную в коде, передаваемом Javassist (например, «int myVar = 5;»). Вместо этого вы должны объявить его с помощью CtMethod.addLocalVariable (имя строки, тип CtClass), а затем вы можете использовать его в коде, как до, так и после советы метода.

Пример:

final CtMethod method = ...;
method.addLocalVariable("startMs", CtClass.longType);
 method.insertBefore("startMs = System.currentTimeMillis();");
 method.insertAfter("{final long endMs = System.currentTimeMillis();" +
"System.out.println(\"Executed in ms: \" + (endMs-startMs));}");

// Advice my.example.TargetClass.myMethod(..) with a before and after advices
final ClassPool pool = ClassPool.getDefault();
final CtClass compiledClass = pool.get("my.example.TargetClass");
final CtMethod method = compiledClass.getDeclaredMethod("myMethod");

 method.addLocalVariable("startMs", CtClass.longType);
 method.insertBefore("startMs = System.currentTimeMillis();");
 method.insertAfter("{final long endMs = System.currentTimeMillis();" +
   "System.out.println(\"Executed in ms: \" + (endMs-startMs));}");

compiledClass.writeFile("/tmp/modifiedClassesFolder");
// Enjoy the new /tmp/modifiedClassesFolder/my/example/TargetClass.class

final CtClass compiledClass = pool.get("my.example.TargetClass");
final CtMethod[] targetMethods = compiledClass.getDeclaredMethods();
for (int i = 0; i < targetMethods.length; i++) {
  targetMethods[i].instrument(new ExprEditor() {
    public void edit(final MethodCall m) throws CannotCompileException {
      if ("javax.naming.NamingEnumeration".equals(m.getClassName()) && "next".equals(m.getMethodName())) {
        m.replace("{long startMs = System.currentTimeMillis(); " +
            "$_ = $proceed($$); " +
            "long endMs = System.currentTimeMillis();" +
            "System.out.println(\"Executed in ms: \" + (endMs-startMs));}");
      }
    }
  });
}

// Groovy code; the method instrumentCallsIn would perform the code above:
pool.appendClassPath("/path/to/a/folder");
new File("/path/to/a/folder").eachFileRecurse(FileType.FILES) {
 file -> instrumentCallsIn( pool.get(file.getAbsolutePath().replace("\.class$","").replace('/','.')) );}

private final ClassPool pool = ClassPool.getDefault();
...
final CtClass targetClass = pool.get("target.class.ClassName");

/* ClassPath newCP = */ pool.appendClassPath("/path/to/a/folder/OR/jar/OR/(jarFolder/*)");

<target name="declareCustomTasks" depends="compile">
   <mkdir dir="${antbuild.dir}"/>

   <!-- Javac classpath contains javassist.jar, ant.jar -->
   <javac srcdir="${antsrc.dir}" destdir="${antbuild.dir}" encoding="${encoding}" source="1.4" classpathref="monitoringInjectorTask.classpath" debug="true" />

 <taskdef name="javassistinject" classname="example.JavassistInjectTask"
   classpathref="monitoringInjectorTask.classpath" loaderref="javassistinject"/>
 <typedef name="call" classname="example.JavassistInjectTask$MethodDescriptor"
   classpathref="monitoringInjectorTask.classpath" loaderref="javassistinject"/>
 <typedef name="execution" classname="example.JavassistInjectTask$MethodDescriptor"
   classpathref="monitoringInjectorTask.classpath" loaderref="javassistinject"/>
 </target>

 <target name="injectMonitoring" depends="compile,declareCustomTasks" description="Process the compiled classes and inject calls to the performance monitoring API to some of them (currently hardcoded in PerfmonAopInjector)">

  <javassistinject outputFolder="${classes.dir}" logLevel="info">
    <fileset dir="${classes.dir}" includes="**/*.class">
    <!-- method executions to inject with performance monitoring -->
    <execution name="someSlowMethod" type="my.MyClass" />
    <!-- method calls to inject with performance monitoring -->
    <call name="search" type="javax.naming.directory.InitialDirContext" metric="ldap" />
    <call name="next" type="javax.naming.NamingEnumeration" metric="ldap" />
    <call name="hasMore" type="javax.naming.NamingEnumeration" metric="ldap" />
  </javassistinject>

 </target>