WeakReference Classe

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

Représente une référence faible, qui référence un objet tout en autorisant toujours cet objet à être récupéré lors du garbage collection.

public ref class WeakReference

public ref class WeakReference : System::Runtime::Serialization::ISerializable

public class WeakReference

public class WeakReference : System.Runtime.Serialization.ISerializable

[System.Serializable]
public class WeakReference : System.Runtime.Serialization.ISerializable

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class WeakReference : System.Runtime.Serialization.ISerializable

type WeakReference = class

type WeakReference = class
    interface ISerializable

[<System.Serializable>]
type WeakReference = class
    interface ISerializable

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type WeakReference = class
    interface ISerializable

Public Class WeakReference

Public Class WeakReference
Implements ISerializable

Héritage

Object

WeakReference

Attributs

SerializableAttribute ComVisibleAttribute

Implémente

ISerializable

Exemples

L’exemple suivant montre comment utiliser des références faibles pour conserver un cache d’objets en tant que ressource pour une application. Le cache est construit à l’aide d’un IDictionary<TKey,TValue> d’objets WeakReference clés par une valeur d’index. La Target propriété des WeakReference objets est un objet dans un tableau d’octets qui représente des données.

L’exemple accède de manière aléatoire aux objets du cache. Si un objet est récupéré pour le garbage collection, un nouvel objet de données est régénéré ; sinon, l’objet est accessible en raison de la référence faible.

using System;
using System.Collections.Generic;

public class Program
{
    public static void Main()
    {
        // Create the cache.
        int cacheSize = 50;
        Random r = new Random();
        Cache c = new Cache(cacheSize);

        string DataName = "";
        GC.Collect(0);

        // Randomly access objects in the cache.
        for (int i = 0; i < c.Count; i++) {
            int index = r.Next(c.Count);

            // Access the object by getting a property value.
            DataName = c[index].Name;
        }
        // Show results.
        double regenPercent = c.RegenerationCount/(double)c.Count;
        Console.WriteLine("Cache size: {0}, Regenerated: {1:P2}%", c.Count, regenPercent);
    }
}

public class Cache
{
    // Dictionary to contain the cache.
    static Dictionary<int, WeakReference> _cache;

    // Track the number of times an object is regenerated.
    int regenCount = 0;

    public Cache(int count)
    {
        _cache = new Dictionary<int, WeakReference>();

        // Add objects with a short weak reference to the cache.
       for (int i = 0; i < count; i++) {
            _cache.Add(i, new WeakReference(new Data(i), false));
        }
    }

    // Number of items in the cache.
    public int Count
    {
        get {  return _cache.Count; }
    }

    // Number of times an object needs to be regenerated.
    public int RegenerationCount
    {
        get { return regenCount; }
    }

    // Retrieve a data object from the cache.
    public Data this[int index]
    {
        get {
            Data d = _cache[index].Target as Data;
            if (d == null) {
                // If the object was reclaimed, generate a new one.
                Console.WriteLine("Regenerate object at {0}: Yes", index);
                d = new Data(index);
                _cache[index].Target = d;
                regenCount++;
            }
            else {
                // Object was obtained with the weak reference.
                Console.WriteLine("Regenerate object at {0}: No", index);
            }

            return d;
       }
    }
}

// This class creates byte arrays to simulate data.
public class Data
{
    private byte[] _data;
    private string _name;

    public Data(int size)
    {
        _data = new byte[size * 1024];
        _name = size.ToString();
    }

    // Simple property.
    public string Name
    {
        get { return _name; }
    }
}
// Example of the last lines of the output:
//
// ...
// Regenerate object at 36: Yes
// Regenerate object at 8: Yes
// Regenerate object at 21: Yes
// Regenerate object at 4: Yes
// Regenerate object at 38: No
// Regenerate object at 7: Yes
// Regenerate object at 2: Yes
// Regenerate object at 43: Yes
// Regenerate object at 38: No
// Cache size: 50, Regenerated: 94%

open System
open System.Collections.Generic

// This class creates byte arrays to simulate data.
type Data(size) =
    let _data = Array.zeroCreate<byte> (size * 1024)
    
    // Simple property.
    member _.Name = 
        string size

type Cache(count) =
    // Dictionary to contain the cache.
    static let mutable _cache = Dictionary<int, WeakReference>()

    // Track the number of times an object is regenerated.
    let mutable regenCount = 0

    do
        _cache <- Dictionary<int, WeakReference>()
        // Add objects with a short weak reference to the cache.
        for i = 0 to count - 1 do
            _cache.Add(i, WeakReference(Data i, false))

    // Number of items in the cache.
    member _.Count =
        _cache.Count

    // Number of times an object needs to be regenerated.
    member _.RegenerationCount =
        regenCount

    // Retrieve a data object from the cache.
    member _.Item
        with get (index) =
            match _cache[index].Target with
            | :? Data as d->
                // Object was obtained with the weak reference.
                printfn $"Regenerate object at {index}: No"
                d
            | _ ->
                // If the object was reclaimed, generate a new one.
                printfn $"Regenerate object at {index}: Yes"
                let d = Data index
                _cache[index].Target <- d
                regenCount <- regenCount + 1
                d 

// Create the cache.
let cacheSize = 50
let r = Random()
let c = Cache cacheSize

let mutable dataName = ""
GC.Collect 0

// Randomly access objects in the cache.
for _ = 0 to c.Count - 1 do
    let index = r.Next c.Count

    // Access the object by getting a property value.
    dataName <- c[index].Name

// Show results.
let regenPercent = double c.RegenerationCount / double c.Count
printfn $"Cache size: {c.Count}, Regenerated: {regenPercent:P2}%%"

// Example of the last lines of the output:
//
// ...
// Regenerate object at 36: Yes
// Regenerate object at 8: Yes
// Regenerate object at 21: Yes
// Regenerate object at 4: Yes
// Regenerate object at 38: No
// Regenerate object at 7: Yes
// Regenerate object at 2: Yes
// Regenerate object at 43: Yes
// Regenerate object at 38: No
// Cache size: 50, Regenerated: 94%

Imports System.Collections.Generic

Public Class Example
    Public Shared Sub Main()
        ' Create the cache. 
        Dim cacheSize As Integer = 50
        Dim r As Random = New Random()
        Dim c As Cache = New Cache(cacheSize)

        Dim DataName As String = "" 
        GC.Collect(0)
        
        ' Randomly access objects in the cache. 
        For ctr As Integer = 0 To C.Count - 1 
            Dim index As Integer = r.Next(c.Count)

            ' Access the object by getting a property value.
            DataName = c(index).Name
        Next 

        ' Show results. 
        Dim regenPercent As Double = c.RegenerationCount * 100 / c.Count
        Console.WriteLine("Cache size: {0}, Regenerated: {1}%", c.Count, regenPercent)
    End Sub 
End Class 

Public Class Cache
    ' Dictionary to contain the cache. 
    Private Shared _cache As Dictionary(Of Integer, WeakReference)

    ' Track the number of times an object is regenerated. 
    Dim regenCount As Integer = 0

    Public Sub New(ByVal count As Integer)
        _cache = New Dictionary(Of Integer, WeakReference)

        ' Add data objects with a short weak reference to the cache. 
        For ctr = 0 To count - 1
            _cache.Add(ctr, New WeakReference(New Data(ctr)))
        Next
    End Sub 

    ' Number of items in the cache. 
    Public ReadOnly Property Count() As Integer 
        Get 
            Return _cache.Count
        End Get 
    End Property 

    ' Number of times an object needs to be regenerated. 
    Public ReadOnly Property RegenerationCount() As Integer 
        Get 
            Return regenCount
        End Get 
    End Property 

    ' Retrieve a data object from the cache. 
    Default Public ReadOnly Property Item(ByVal index As Integer) As Data
        Get 
            Dim d As Data = TryCast(_cache(index).Target, Data)
            ' If the object was reclaimed, generate a new one.
            If d Is Nothing Then 
                Console.WriteLine("Regenerate object at {0}: Yes", index)
                d = New Data(index)
                _cache(index).Target = d
                regenCount += 1
           Else 
                ' Object was obtained with the weak reference.
                Console.WriteLine("Regenerate object at {0}: No", index.ToString())
            End If 
            Return d
        End Get 
    End Property 
End Class 

' Class that creates byte arrays to simulate data. 
Public Class Data
    Private _data() As Byte 
    Private _name As String 

    Public Sub New(ByVal size As Integer)
        _data = New Byte(((size * 1024)) - 1) {}
        _name = size.ToString
    End Sub 

    ' Simple property for accessing the object. 
    Public ReadOnly Property Name() As String 
        Get 
            Return _name
        End Get 
    End Property 
End Class 
' Example of the last lines of the output: 
' ... 
' Regenerate object at 36: Yes 
' Regenerate object at 8: Yes 
' Regenerate object at 21: Yes 
' Regenerate object at 4: Yes 
' Regenerate object at 38: No 
' Regenerate object at 7: Yes 
' Regenerate object at 2: Yes 
' Regenerate object at 43: Yes 
' Regenerate object at 38: No 
' Cache size: 50, Regenerated: 94%

Remarques

Une référence faible permet au récupérateur de mémoire de collecter un objet tout en permettant à une application d’accéder à l’objet. Si vous avez besoin de l’objet, vous pouvez toujours obtenir une référence forte à celui-ci et l’empêcher d’être collecté. Pour plus d’informations sur l’utilisation des références faibles courtes et longues, consultez Références faibles.

Constructeurs

WeakReference()	Représente une référence faible, qui référence un objet tout en autorisant toujours cet objet à être récupéré lors du garbage collection.
WeakReference(Object)	Initialise une nouvelle instance de la classe WeakReference, référençant l'objet spécifié.
WeakReference(Object, Boolean)	Initialise une nouvelle instance de la classe WeakReference, référençant l’objet spécifié et utilisant le suivi de réactivation spécifié.
WeakReference(SerializationInfo, StreamingContext)	Initialise une nouvelle instance de la classe WeakReference, à l'aide de données désérialisées provenant des objets de sérialisation et de flux spécifiés.

Propriétés

IsAlive	Obtient une indication permettant de savoir si l’objet auquel l’objet WeakReference fait référence a été récupéré par le garbage collector.
Target	Obtient ou définit l’objet (la cible) référencé par l’objet WeakReference actuel.
TrackResurrection	Indique si un suivi est effectué pour l’objet référencé par l’objet WeakReference actuel après sa finalisation.

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
Finalize()	Ignore la référence à la cible représentée par l'objet WeakReference actuel.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetObjectData(SerializationInfo, StreamingContext)	Remplit un objet SerializationInfo de toutes les données nécessaires à la sérialisation de l'objet WeakReference en cours.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• GC
• Références faibles