Класс StackWalker

public static StackWalker getInstance()

Возвращает:

экземпляр StackWalker, настроенный на пропуск всех скрытых кадров стека и не сохраняющий ссылки на классы.

public static StackWalker getInstance(StackWalker.Option option)

Параметры:

option - stack walking option

Возвращает:

экземпляр StackWalker, настроенный с заданным параметром

public static StackWalker getInstance(Set<StackWalker.Option> options)

Параметры:

options - stack walking options

Возвращает:

экземпляр StackWalker, настроенный с заданными параметрами

public static StackWalker getInstance(Set<StackWalker.Option> options, int estimateDepth)

Параметры:

options - stack walking options

estimateDepth - Приблизительное число кадров стека для прохода.

Возвращает:

экземпляр StackWalker, настроенный с заданными параметрами

Исключения:

IllegalArgumentException - если estimateDepth <= 0

public <T> T walk(Function<? super Stream<StackWalker.StackFrame>, ? extends T> function)

Примечание API:

Например, чтобы найти первые 10 вызывающих кадров, сначала пропустив те кадры, декларирующий класс которых находится в пакете com.foo:

List<StackFrame> frames = StackWalker.getInstance().walk(s ->
        s.dropWhile(f -> f.getClassName().startsWith("com.foo."))
         .limit(10)
         .toList());

Этот метод принимает Function, принимающий Stream<StackFrame>, а не возвращает Stream<StackFrame> и не позволяет вызывающему методу напрямую манипулировать потоком. Виртуальная машина Java может свободно переупорядочивать стек управления потока, например, при деоптимизации. Принимая параметр Function, этот метод позволяет получить доступ к кадрам стека через стабильный вид стека управления потока.

Параллельное выполнение фактически отключено, и выполнение потоковой обработки будет происходить только в текущем потоке.

Примечание реализации:

Реализация стабилизирует стек, привязывая кадр, специфичный для обработки стека, и гарантирует, что обработка стека выполняется над привязанным кадром. При закрытии или повторном использовании объекта потока будет брошено исключение IllegalStateException.

Параметры типа:

T - Тип результата применения функции к потоку кадра стека.

Параметры:

function - функция, которая принимает поток кадров стека и возвращает результат.

Возвращает:

результат применения функции к потоку кадров стека.

public void forEach(Consumer<? super StackWalker.StackFrame> action)

Параметры:

action - действие, которое должно быть выполнено для каждого элемента стека текущего потока

public Class<?> getCallerClass()

Примечание API:

Например, Util::getResourceBundle загружает ресурсный пакет от имени вызывающего метода. Он вызывает getCallerClass, чтобы определить класс, метод которого вызвал Util::getResourceBundle. Затем он получает загрузчик класса этого класса и использует загрузчик для загрузки ресурсного пакета. Класс вызывающего метода в этом примере — MyTool.

class Util {
    private final StackWalker walker =
        StackWalker.getInstance(Set.of(Option.DROP_METHOD_INFO, Option.RETAIN_CLASS_REFERENCE));
    public ResourceBundle getResourceBundle(String bundleName) {
        Class<?> caller = walker.getCallerClass();
        return ResourceBundle.getBundle(bundleName, Locale.getDefault(), caller.getClassLoader());
    }
}

class MyTool {
    private final Util util = new Util();
    private void init() {
        ResourceBundle rb = util.getResourceBundle("mybundle");
    }
}

Эквивалентный способ поиска класса вызывающего метода с использованием метода walk выглядит следующим образом (фильтруя кадры рефлексии, MethodHandle и скрытые кадры, не показанные ниже):

    Optional<Class<?>> caller = walker.walk(s ->
        s.map(StackFrame::getDeclaringClass)
         .skip(2)
         .findFirst());

Когда метод getCallerClass вызывается из метода, который является последним кадром в стеке, например, метода static public void main, запущенного запускателем java, или метода, вызванного из потока, подключенного к JNI, будет брошено исключение IllegalCallerException.

Возвращает:

объект класса вызывающего метода, вызвавшего этот метод.

Исключения:

UnsupportedOperationException - если этот StackWalker не настроен с Option.RETAIN_CLASS_REFERENCE.

IllegalCallerException - если нет кадра вызывающего метода, т. е. когда этот метод getCallerClass вызывается из метода, который является последним кадром в стеке.