WeakReference WeakReference WeakReference WeakReference Class

Определение

Представляет слабую ссылку, которая указывает на объект, но позволяет удалять его сборщику мусора.Represents a weak reference, which references an object while still allowing that object to be reclaimed by garbage collection.

public ref class WeakReference : System::Runtime::Serialization::ISerializable
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class WeakReference : System.Runtime.Serialization.ISerializable
type WeakReference = class
    interface ISerializable
Public Class WeakReference
Implements ISerializable
Наследование
WeakReferenceWeakReferenceWeakReferenceWeakReference
Атрибуты
Реализации

Примеры

В следующем примере показано, как можно использовать слабые ссылки для поддержки кэша объектов в качестве ресурса для приложения.The following example demonstrates how you can use weak references to maintain a cache of objects as a resource for an application. Кэш создается с использованием IDictionary<TKey,TValue> объектов, ключом которых WeakReference является значение индекса.The cache is constructed using an IDictionary<TKey,TValue> of WeakReference objects keyed by an index value. Target СвойствоWeakReference для объектов — это объект в массиве байтов, который представляет данные.The Target property for the WeakReference objects is an object in a byte array that represents data.

В примере случайным образом обращается к объектам в кэше.The example randomly accesses objects in the cache. Если объект освобождается для сборки мусора, новый объект данных создается заново; в противном случае объект доступен для доступа из-за слабой ссылки.If an object is reclaimed for garbage collection, a new data object is regenerated; otherwise, the object is available to access because of the weak reference.

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%
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% 

Комментарии

Слабая ссылка позволяет сборщику мусора получать объект, при этом позволяя приложению получить доступ к объекту.A weak reference allows the garbage collector to collect an object while still allowing an application to access the object. Если вам нужен объект, вы по-прежнему можете получить строгую ссылку на него и предотвратить его сбор.If you need the object, you can still obtain a strong reference to it and prevent it from being collected. Дополнительные сведения об использовании коротких и длинных слабых ссылок см. в разделе слабые ссылки.For more information about how to use short and long weak references, see Weak References.

Конструкторы

WeakReference() WeakReference() WeakReference() WeakReference()
WeakReference(Object) WeakReference(Object) WeakReference(Object) WeakReference(Object)

Инициализирует новый экземпляр класса WeakReference, ссылающийся на заданный объект.Initializes a new instance of the WeakReference class, referencing the specified object.

WeakReference(Object, Boolean) WeakReference(Object, Boolean) WeakReference(Object, Boolean) WeakReference(Object, Boolean)

Инициализирует новый экземпляр класса WeakReference, ссылающийся на заданный объект и использующий заданное отслеживание восстановления.Initializes a new instance of the WeakReference class, referencing the specified object and using the specified resurrection tracking.

WeakReference(SerializationInfo, StreamingContext) WeakReference(SerializationInfo, StreamingContext) WeakReference(SerializationInfo, StreamingContext) WeakReference(SerializationInfo, StreamingContext)

Инициализирует новый экземпляр класса WeakReference, используя десериализованные данные из заданных объектов сериализации и потока.Initializes a new instance of the WeakReference class, using deserialized data from the specified serialization and stream objects.

Свойства

IsAlive IsAlive IsAlive IsAlive

Возвращает сведения о том, был ли удален сборщиком мусора объект, на который ссылается объект WeakReference.Gets an indication whether the object referenced by the current WeakReference object has been garbage collected.

Target Target Target Target

Возвращает или задает (целевой) объект, на который ссылается текущий объект WeakReference.Gets or sets the object (the target) referenced by the current WeakReference object.

TrackResurrection TrackResurrection TrackResurrection TrackResurrection

Возвращает сведения о том, отслеживается ли после финализации объект, на который ссылается текущий объект WeakReference.Gets an indication whether the object referenced by the current WeakReference object is tracked after it is finalized.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize() Finalize() Finalize() Finalize()

Удаляет ссылку на целевой объект, представленный текущим объектом WeakReference.Discards the reference to the target represented by the current WeakReference object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

Заполняет объект SerializationInfo всеми данными, необходимыми для сериализации текущего объекта WeakReference.Populates a SerializationInfo object with all the data needed to serialize the current WeakReference object.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Безопасность

SecurityPermission
для возможности вызова неуправляемого кода.for the ability to call unmanaged code. Значение спроса: InheritanceDemand; Значение разрешения:UnmanagedCodeDemand value: InheritanceDemand; Permission value: UnmanagedCode

Применяется к

Дополнительно