Le Tutoriel de Java PhantomReference

PhantomReference

1. PhantomReference

Dans cet article, on va discuter de la classe PhantomReference. Avant de commencer, il vous sera nécessaire de vous renseigner sur les classes WeakReference et SoftReference. Ces trois classes disposent de mêmes caractéristiques de base et n'ont pas besoin d'être mentionnées à nouveau.

PhantomReference Constructors

PhantomReference(T innerObject, ReferenceQueue<? super T> queue)

PhantomReference n'a qu'un seul constructeur. Afin de créer un objet PhantomReference, vous devez fournir deux paramètres :

innerObject: l'objet sera encapsulé dans l'objet PhantomReference.
queue: une file d'attente utilisée pour stocker cet objet PhantomReference lorsque son innerObject est supprimé de la mémoire par le GC.

ReferenceQueue<AnyObject> queue = new ReferenceQueue<>();

AnyObject innerObject = new AnyObject("Obj1");

PhantomReference phantomRef = new PhantomReference(innerObject, queue);

Toutes les méthodes de PhantomReference sont héritées de la classe parentale.

// Methods inherited from parent.
public T get()  
public void clear()  
public boolean isEnqueued()  
public boolean enqueue()

La méthode phantomReference.get() renvoie toujours null, dont le but est d'empêcher l'accès ou de tenter de faire revivre un objet qui a presque été supprimé.

Vous vous poseriez peut-être des questions sur les caractéristiques de PhantomReference et notamment à quoi sert PhantomReference?

PhantomReference phantomRef = new PhantomReference(innerObject, queue);

En règle générale, PhantomReference vous permet de savoir exactement quand son objet innerObject est supprimé de la mémoire. La méthode phantomRef.isEnqueued() renvoie true, ce qui signifie que l'objet innerObject a été supprimé de la mémoire. Lorsque l'objet innerObject est supprimé de la mémoire, l'objet phantomRef sera placé dans la file d'attente (queue).

Par exemple: si vous devez allouer de la mémoire pour gérer des fichiers vidéo volumineux, utiliser PhantomReference est un bon choix. Tout d'abord, user PhantomReference pour allouer de la mémoire pour traiter la première vidéo, ensuite, vous devez vérifier si la mémoire a été libérée avant de continuer à allouer de la mémoire pour traiter le fichier vidéo suivant. Cela réduit le risque d'obtenir une erreur OutOfMemoryError.

La classe VideoProcessor simule le traitement d'un gros fichier vidéo:

VideoProcessor.java

package org.o7planning.phantomreference.ex;

public class VideoProcessor {
    private String video;

    public VideoProcessor(String video)  {
        this.video = video;
        System.out.println("\nNew VideoProcessor: " + this.video);
    }

    public void process() {
        System.out.println("   >>> Processing video: " + this.video);
        try {
            Thread.sleep(2000);
        } catch (InterruptedException e) { }
        System.out.println("   >>> Completed processing video: " + this.video);
    }
    
    // !IMPORTANT: Do not override finalize() method.
    //  (Java9+: If you override this method, PhantomReference will not work!!)
    //    @Override
    //    protected void finalize() throws Throwable {
    //        System.out.println("VideoProcessor is being removed from memory\n");
    //        super.finalize();
    //    }
}

PhantomReferenceEx1.java

package org.o7planning.phantomreference.ex;

import java.lang.ref.PhantomReference;
import java.lang.ref.Reference;
import java.lang.ref.ReferenceQueue;

public class PhantomReferenceEx1 {

    public static void main(String[] args) {

        String[] videos = new String[] { "video1.mp4", "video2.mp4", "video3.mp4" };

        ReferenceQueue<VideoProcessor> queue = new ReferenceQueue<VideoProcessor>();

        for (String video : videos) {
            VideoProcessor videoProcessor = new VideoProcessor(video);

            PhantomReference<VideoProcessor> phantomRef = new PhantomReference<>(videoProcessor, queue);
            videoProcessor.process();

            videoProcessor = null;
            // Call GC:
            System.gc();

            while (true) {
                boolean isEnqueued = phantomRef.isEnqueued();
                System.out.println(" phantomRef.isEnqueued: " + isEnqueued);
            
                if (!isEnqueued) {
                    try {
                        Thread.sleep(1000);
                    } catch (InterruptedException e) {
                    }
                    continue;
                }
                break;
            }
        }
        System.out.println("\nObjects in the queue:");
        Reference<? extends VideoProcessor> ref= null;
        
        while((ref = queue.poll())!= null)  {
            System.out.println(ref);
        }
    }
}

Output:

New VideoProcessor: video1.mp4
   >>> Processing video: video1.mp4
   >>> Completed processing video: video1.mp4
 phantomRef.isEnqueued: false
 phantomRef.isEnqueued: true

New VideoProcessor: video2.mp4
   >>> Processing video: video2.mp4
   >>> Completed processing video: video2.mp4
 phantomRef.isEnqueued: false
 phantomRef.isEnqueued: true

New VideoProcessor: video3.mp4
   >>> Processing video: video3.mp4
   >>> Completed processing video: video3.mp4
 phantomRef.isEnqueued: false
 phantomRef.isEnqueued: true

Objects in the queue:
java.lang.ref.PhantomReference@5e265ba4
java.lang.ref.PhantomReference@156643d4
java.lang.ref.PhantomReference@123a439b

Le Tutoriel de Java PhantomReference

1. PhantomReference

Java Basic

Java Basic

Articles les plus récents