Глубокое погружение в Java 9 Stack-Walking API

 // count the number of frames long nbFrames = stackWalker.walk( // the lambda returns a long frames -> frames.count()); 

Одно из больших преимуществ использования метода обхода состоит в том, что, поскольку API обхода стека лениво оценивает кадры, использование оператора limit фактически уменьшает количество восстанавливаемых кадров. Следующий код извлечет первые два кадра, что, как мы увидим позже , намного дешевле, чем захват полного стека.

 List<StackWalker.StackFrame> caller = stackWalker.walk( frames -> frames .limit(2) .collect(Collectors.toList())); 

Опубликованный Рори Хайдом под CC-BY-SA 2.0 / SitePoint изменил окраску и поле зрения и делится под той же лицензией

Продвинутый StackWalker

С основами того, как получить стековый ходок и как использовать его для доступа к фреймам под нашим поясом, пришло время перейти к более сложным темам.

Почему брать Function вместо того, чтобы просто возвращать Stream ?

При обсуждении стека проще всего представить его как стабильную структуру данных, которую JVM мутирует только в верхней части, добавляя или удаляя отдельные кадры при входе или выходе из методов. Это не совсем верно, хотя. Вместо этого вы должны думать о стеке как о чем-то, что виртуальная машина может реструктурировать в любое время (в том числе в середине выполняемого кода) для повышения производительности.

Поэтому для того, чтобы ходящий мог видеть согласованный стек, API должен убедиться, что стек стабилен во время построения фреймов. Это возможно только в том случае, если он контролирует стек вызовов, что означает, что обработка потока должна происходить в вызове API. Вот почему поток не может быть возвращен, но должен быть пройден внутри вызова. (Кроме того, обратные вызовы обхода выполняются из собственной функции JVM, как вы можете видеть в комментарии для StackStreamFactory и doStackWalk .)

Если вы попытаетесь утечь поток, передав функцию идентификации, он выдаст IllegalStateException только вы попытаетесь его обработать.

 Stream<StackWalker.StackFrame> doNotDoThat = stackWalker.walk(frames -> frames); doNotDoThat.count(); // throws an IllegalStateException 

Метод getCallerClass

Чтобы сделать общий случай быстрым и простым, StackWalker предоставляет оптимизированный способ получения класса вызывающего.

 Class<?> callerClass = StackWalker .getInstance(RETAIN_CLASS_REFERENCE) .getCallerClass() 

Этот вызов быстрее, чем аналогичный вызов через Stream и быстрее, чем использование SecurityManager (более подробно в тесте производительности )

StackFrame

Методы forEach и walk передают экземпляры StackFrame в потоке или обратному вызову потребителя. Этот класс обеспечивает прямой доступ к:

• Индекс байт-кода : индекс текущей инструкции байт-кода относительно начала метода.
• Имя класса : имя класса, объявляющего вызываемый метод.
• Объявление класса : объект Class класса, объявляющего вызываемый метод (вы не можете просто использовать Class.forName(frame.getClassName()) поскольку у вас может не быть правого ClassLoader ; он доступен только при использовании RETAIN_CLASS_REFERENCE .)
• Имя метода : имя вызываемого метода.
• Является ли метод родным.

Это также дает ленивый доступ к имени файла и номеру строки, но это создаст StackTraceElement которому он будет делегировать вызов. Создание StackTraceElement является дорогостоящим и откладывается до тех пор, пока оно не понадобится впервые. Метод toString также делегирует StackTraceElement .

Опции StackWalker

Теперь, когда мы идем, давайте посмотрим на влияние различных опций StackWalker . Поскольку некоторые из них обрабатывают кадры со специальными свойствами, обычной иерархии вызовов недостаточно, чтобы продемонстрировать их все. Следовательно, нам придется сделать что-то более причудливое, в этом случае использовать рефлексию для создания более сложного стека.

Мы рассмотрим кадры, создаваемые следующей иерархией вызовов:

 public static void delegateViaReflection(Runnable task) throws Exception { StackWalkerOptions .class .getMethod("runTask", Runnable.class) .invoke(null, task); } public static void runTask(Runnable task) { task.run(); } 

Задача Runnable task будет лямбда-печатью стека с использованием StackWalker::forEach . Стек выполнения затем содержит рефлексивный код delegateViaReflection и скрытый фрейм, связанный с лямбда-выражением.

 delegateViaReflection(() -> StackWalker .getInstance() .forEach(System.out::println)); 

 delegateViaReflection(() -> StackWalker .getInstance(Option.SHOW_REFLECT_FRAMES) .forEach(System.out::println) ); 

 delegateViaReflection(() -> StackWalker .getInstance(Option.SHOW_HIDDEN_FRAMES) .forEach(System.out::println) ); 

 delegateViaReflection(() -> StackWalker .getInstance() .forEach(frame -> System.out.println( "declaring class = " // throws UnsupportedOperationException + frame.getDeclaringClass()))); 

 delegateViaReflection(() -> StackWalker .getInstance(Option.RETAIN_CLASS_REFERENCE) .forEach(frame -> System.out.println( "declaring class = " + frame.getDeclaringClass()))); 

 StackWalker .getInstance() .walk(frames -> { frames.limit(limit).forEach(b::consume); return null; }); 

 int estimatedSize = limit + 2; StackWalker .getInstance(Set.of(SHOW_HIDDEN_FRAMES), estimatedSize) .walk(frames -> { frames.limit(limit).forEach(b::consume); return null; }); 

 StackWalker .getInstance() .walk(frames -> { frame.skip(skip).forEach(b::consume); return null; }); 

 StackWalker.getInstance().walk(frames -> ...);