En guide till färdigställningsmetoden i Java

1. Översikt

I denna handledning fokuserar vi på en kärnaspekt av Java-språket - den slutgiltiga metoden från root Object- klassen.

Enkelt uttryckt kallas detta före skräpsamlingen för ett visst objekt.

2. Använda Finalizers

Den färdigställa () metoden kallas Finalizer.

Finaliserare åberopas när JVM räknar ut att just denna instans ska samlas in. En sådan slutbehandlare kan utföra alla operationer, inklusive att återföra objektet till liv.

Huvudsyftet med en finaliserare är dock att frigöra resurser som används av objekt innan de tas bort från minnet. En finalizer kan fungera som den primära mekanismen för sanering eller som ett skyddsnät när andra metoder misslyckas.

För att förstå hur en finaliserare fungerar, låt oss ta en titt på en klassdeklaration:

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 }

Klassen Finalizable har en fältläsare som refererar till en stängbar resurs. När ett objekt skapas från denna klass konstruerar det en ny instans av BufferedReader som läser från en fil i klassvägen.

En sådan instans används i readFirstLine- metoden för att extrahera den första raden i den givna filen. Observera att läsaren inte är stängd i den angivna koden.

Vi kan göra det med en finalizer:

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

Det är lätt att se att en finaliserare deklareras precis som alla vanliga instansmetoder.

I själva verket är den tid då sopsamlaren anropar slutbehandlare beroende av JVM: s implementering och systemets förhållanden som är utom vår kontroll.

För att få skräpsamlingen att ske på plats kommer vi att utnyttja metoden System.gc . I verkliga system bör vi aldrig åberopa det uttryckligen av ett antal skäl:

  1. Det är kostsamt
  2. Det utlöser inte skräpsamlingen omedelbart - det är bara en ledtråd för JVM att starta GC
  3. JVM vet bättre när GC behöver ringas

Om vi ​​behöver tvinga GC kan vi använda jconsole för det.

Följande är ett testfall som visar hur en finaliserare fungerar:

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

I det första meddelandet, en Finalizable är objekt som skapats, sedan dess readFirstLine Metoden kallas. Detta objekt tilldelas inte någon variabel, därför är det kvalificerat för skräpsamling när metoden System.gc åberopas.

Påståendet i testet verifierar innehållet i inmatningsfilen och används bara för att bevisa att vår anpassade klass fungerar som förväntat.

När vi kör testet kommer ett meddelande att skrivas ut på konsolen om att den buffrade läsaren stängs i finaliseraren. Detta innebär att den slutgiltiga metoden anropades och den har rensat upp resursen.

Fram till denna punkt ser finaliserare ut som ett bra sätt för förstörda operationer. Men det är inte riktigt sant.

I nästa avsnitt kommer vi att se varför man bör undvika att använda dem.

3. Undvika slutförande

Trots fördelarna de medför, kommer finaliserarna med många nackdelar.

3.1. Nackdelar med finaliserare

Låt oss ta en titt på flera problem vi kommer att möta när vi använder slutbehandlare för att utföra kritiska åtgärder.

Den första märkbara frågan är bristen på snabbhet. Vi kan inte veta när en finalizer körs eftersom skräpsamling kan ske när som helst.

I sig är detta inte ett problem eftersom finaliseraren fortfarande körs förr eller senare. Systemresurser är dock inte obegränsade. Således kan vi ta slut på resurser innan en sanering sker, vilket kan leda till en systemkrasch.

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

I denna handledning fokuserade vi på ett kärnkoncept i Java - finaliseringsmetoden . Detta ser bra ut på papper men kan ha fula biverkningar vid körning. Och, ännu viktigare, det finns alltid en alternativ lösning för att använda en finalizer.

En viktig punkt att lägga märke till är att slutförandet har upphört med början med Java 9 - och så småningom kommer att tas bort.

Som alltid kan källkoden för den här självstudien hittas på GitHub.