Класс 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 - действие, которое необходимо выполнить для каждого StackFrame стека текущего потока

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.

Возвращает:

объект Class вызывающего метода, который вызвал этот метод.

Выбрасывает:

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

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