Посібник з остаточного методу на Java

1. Огляд

У цьому підручнику ми зупинимось на основному аспекті мови Java - методі завершення, наданому кореневим класом Object .

Простіше кажучи, це називається перед вивозом сміття для певного об’єкта.

2. Використання фіналізаторів

Метод finalize () називається фіналізатором.

Фіналізатори викликаються, коли JVM з’ясовує, що саме цей екземпляр повинен бути зібраним сміттям. Такий фіналізатор може виконувати будь-які операції, включаючи повернення об’єкта до життя.

Однак основною метою фіналізатора є вивільнення ресурсів, що використовуються об'єктами, перш ніж вони будуть вилучені з пам'яті. Фіналізатор може працювати як основний механізм для очищення або як захисна мережа, коли інші методи виходять з ладу.

Щоб зрозуміти, як працює фіналізатор, давайте поглянемо на декларацію класу:

public class Finalizable { private BufferedReader reader; public Finalizable() { InputStream input = this.getClass() .getClassLoader() .getResourceAsStream("file.txt"); this.reader = new BufferedReader(new InputStreamReader(input)); } public String readFirstLine() throws IOException { String firstLine = reader.readLine(); return firstLine; } // other class members }

Клас Finalizable має польовий зчитувач , який посилається на закритий ресурс. Коли об'єкт створюється з цього класу, він створює новий екземпляр BufferedReader, зчитуваний з файлу в шляху до класу.

Такий екземпляр використовується в методі readFirstLine для вилучення першого рядка у даному файлі. Зверніть увагу, що зчитувач не закритий у даному коді.

Ми можемо зробити це за допомогою фіналізатора:

@Override public void finalize() { try { reader.close(); System.out.println("Closed BufferedReader in the finalizer"); } catch (IOException e) { // ... } }

Неважко помітити, що фіналізатор оголошується так само, як і будь-який звичайний метод екземпляра.

Насправді час, коли збирач сміття називає фіналізатори, залежить від реалізації JVM та умов системи, які поза нашим контролем.

Щоб збір сміття відбувався на місці, ми скористаємось методом System.gc . У реальних системах ми ніколи не повинні посилатися на це явно з ряду причин:

  1. Це дорого
  2. Це не запускає збір сміття відразу - це лише підказка для JVM, щоб запустити GC
  3. JVM краще знає, коли потрібно викликати GC

Якщо нам потрібно примусити GC, ми можемо використовувати для цього jconsole .

Далі наведено тестовий приклад, що демонструє роботу фіналізатора:

@Test public void whenGC_thenFinalizerExecuted() throws IOException { String firstLine = new Finalizable().readFirstLine(); assertEquals("baeldung.com", firstLine); System.gc(); }

У першій заяві фіналізіруемий створюються об'єкт, то його readFirstLine метод. Цей об'єкт не призначений жодній змінній, отже, він придатний для збору сміття при виклику методу System.gc .

Твердження в тесті перевіряє вміст вхідного файлу і використовується лише для того, щоб довести, що наш користувацький клас працює належним чином.

Коли ми запускаємо наданий тест, на консолі буде надруковано повідомлення про закриття буферного зчитувача у фіналізаторі. Це означає, що був викликаний метод finalize і він очистив ресурс.

До цього моменту фіналізатори виглядають як чудовий спосіб для попереднього знищення. Однак це не зовсім так.

У наступному розділі ми побачимо, чому слід уникати їх використання.

3. Уникання фіналізаторів

Незважаючи на переваги, які вони приносять, фіналізатори мають багато недоліків.

3.1. Недоліки фіналізаторів

Давайте розглянемо кілька проблем, з якими ми зіткнемось при використанні фіналізаторів для виконання критичних дій.

Перша помітна проблема - відсутність оперативності. Ми не можемо знати, коли працює фіналізатор, оскільки збір сміття може відбуватися будь-коли.

Сам по собі це не проблема, оскільки фіналізатор все одно виконується рано чи пізно. Однак системні ресурси не необмежені. Таким чином, у нас може закінчитися ресурс до того, як відбудеться очищення, що може призвести до збою системи.

Finalizers also have an impact on the program's portability. Since the garbage collection algorithm is JVM implementation-dependent, a program may run very well on one system while behaving differently on another.

The performance cost is another significant issue that comes with finalizers. Specifically, JVM must perform many more operations when constructing and destroying objects containing a non-empty finalizer.

The last problem we'll be talking about is the lack of exception handling during finalization. If a finalizer throws an exception, the finalization process stops, leaving the object in a corrupted state without any notification.

3.2. Demonstration of Finalizers' Effects

It's time to put the theory aside and see the effects of finalizers in practice.

Let's define a new class with a non-empty finalizer:

public class CrashedFinalizable { public static void main(String[] args) throws ReflectiveOperationException { for (int i = 0; ; i++) { new CrashedFinalizable(); // other code } } @Override protected void finalize() { System.out.print(""); } }

Notice the finalize() method – it just prints an empty string to the console. If this method were completely empty, the JVM would treat the object as if it didn't have a finalizer. Therefore, we need to provide finalize() with an implementation, which does almost nothing in this case.

Inside the main method, a new CrashedFinalizable instance is created in each iteration of the for loop. This instance isn't assigned to any variable, hence eligible for garbage collection.

Let's add a few statements at the line marked with // other code to see how many objects exist in the memory at runtime:

if ((i % 1_000_000) == 0) { Class finalizerClass = Class.forName("java.lang.ref.Finalizer"); Field queueStaticField = finalizerClass.getDeclaredField("queue"); queueStaticField.setAccessible(true); ReferenceQueue referenceQueue = (ReferenceQueue) queueStaticField.get(null); Field queueLengthField = ReferenceQueue.class.getDeclaredField("queueLength"); queueLengthField.setAccessible(true); long queueLength = (long) queueLengthField.get(referenceQueue); System.out.format("There are %d references in the queue%n", queueLength); }

The given statements access some fields in internal JVM classes and print out the number of object references after every million iterations.

Let's start the program by executing the main method. We may expect it to run indefinitely, but that's not the case. After a few minutes, we should see the system crash with an error similar to this:

... There are 21914844 references in the queue There are 22858923 references in the queue There are 24202629 references in the queue There are 24621725 references in the queue There are 25410983 references in the queue There are 26231621 references in the queue There are 26975913 references in the queue Exception in thread "main" java.lang.OutOfMemoryError: GC overhead limit exceeded at java.lang.ref.Finalizer.register(Finalizer.java:91) at java.lang.Object.(Object.java:37) at com.baeldung.finalize.CrashedFinalizable.(CrashedFinalizable.java:6) at com.baeldung.finalize.CrashedFinalizable.main(CrashedFinalizable.java:9) Process finished with exit code 1

Looks like the garbage collector didn't do its job well – the number of objects kept increasing until the system crashed.

If we removed the finalizer, the number of references would usually be 0 and the program would keep running forever.

3.3. Explanation

To understand why the garbage collector didn't discard objects as it should, we need to look at how the JVM works internally.

When creating an object, also called a referent, that has a finalizer, the JVM creates an accompanying reference object of type java.lang.ref.Finalizer. After the referent is ready for garbage collection, the JVM marks the reference object as ready for processing and puts it into a reference queue.

We can access this queue via the static field queue in the java.lang.ref.Finalizer class.

Meanwhile, a special daemon thread called Finalizer keeps running and looks for objects in the reference queue. When it finds one, it removes the reference object from the queue and calls the finalizer on the referent.

During the next garbage collection cycle, the referent will be discarded – when it's no longer referenced from a reference object.

If a thread keeps producing objects at a high speed, which is what happened in our example, the Finalizer thread cannot keep up. Eventually, the memory won't be able to store all the objects, and we end up with an OutOfMemoryError.

Notice a situation where objects are created at warp speed as shown in this section doesn't often happen in real life. However, it demonstrates an important point – finalizers are very expensive.

4. No-Finalizer Example

Let's explore a solution providing the same functionality but without the use of finalize() method. Notice that the example below isn't the only way to replace finalizers.

Instead, it's used to demonstrate an important point: there are always options that help us to avoid finalizers.

Here's the declaration of our new class:

public class CloseableResource implements AutoCloseable { private BufferedReader reader; public CloseableResource() { InputStream input = this.getClass() .getClassLoader() .getResourceAsStream("file.txt"); reader = new BufferedReader(new InputStreamReader(input)); } public String readFirstLine() throws IOException { String firstLine = reader.readLine(); return firstLine; } @Override public void close() { try { reader.close(); System.out.println("Closed BufferedReader in the close method"); } catch (IOException e) { // handle exception } } }

It's not hard to see that the only difference between the new CloseableResource class and our previous Finalizable class is the implementation of the AutoCloseable interface instead of a finalizer definition.

Notice that the body of the close method of CloseableResource is almost the same as the body of the finalizer in class Finalizable.

The following is a test method, which reads an input file and releases the resource after finishing its job:

@Test public void whenTryWResourcesExits_thenResourceClosed() throws IOException { try (CloseableResource resource = new CloseableResource()) { String firstLine = resource.readFirstLine(); assertEquals("baeldung.com", firstLine); } }

In the above test, a CloseableResource instance is created in the try block of a try-with-resources statement, hence that resource is automatically closed when the try-with-resources block completes execution.

Running the given test method, we'll see a message printed out from the close method of the CloseableResource class.

5. Conclusion

У цьому навчальному посібнику ми зосередилися на основному понятті Java - методі finalize . Це виглядає корисним на папері, але може мати потворні побічні ефекти під час роботи. І, що більш важливо, завжди є альтернативне рішення для використання фіналізатора.

Одним із критичних моментів, який слід помітити, є те, що фіналізація застаріла, починаючи з Java 9 - і з часом буде видалена.

Як завжди, вихідний код цього підручника можна знайти на GitHub.