Класс Cleaner

• java.lang.Object
• • java.lang.ref.Cleaner

public final class Cleaner
extends Object

API Note:

Действие по очистке вызывается только после того, как связанный с ним объект становится призрачно достижимым, поэтому важно, чтобы объект, реализующий действие по очистке, не содержал ссылок на объект. В этом примере статический класс инкапсулирует состояние и действие очистки. Не следует использовать «вложенный» класс, анонимный или нет, потому что он неявно содержит ссылку на внешний экземпляр, препятствуя его призрачной достижимости. Выбор нового очистителя или совместного использования существующего очистителя определяется конкретным случаем использования.

Если CleaningExample используется в блоке try-finally, то метод close вызывает действие по очистке. Если метод close не вызывается, действие по очистке вызывается очистителем, когда экземпляр CleaningExample стал призрачно достижимым.

public class CleaningExample implements AutoCloseable {
        // A cleaner, preferably one shared within a library
        private static final Cleaner cleaner = <cleaner>;

        static class State implements Runnable {

            State(...) {
                // initialize State needed for cleaning action
            }

            public void run() {
                // cleanup action accessing State, executed at most once
            }
        }

        private final State;
        private final Cleaner.Cleanable cleanable

        public CleaningExample() {
            this.state = new State(...);
            this.cleanable = cleaner.register(this, state);
        }

        public void close() {
            cleanable.clean();
        }
    }

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

Действия по очистке должны быть готовы к одновременным вызовам с другими действиями по очистке. Как правило, действия по очистке должны быть очень быстрыми для выполнения и не блокирующими. Если действие по очистке блокируется, это может замедлить обработку других действий по очистке, зарегистрированных в том же очистителе. Все действия по очистке, зарегистрированные для очистителя, должны быть взаимно совместимы.

Since:

9

public static Cleaner create()

public static Cleaner create(ThreadFactory threadFactory)

public Cleaner.Cleanable register(Object obj,
                                  Runnable action)