Правильна реалізація IDisposable

У своїх класах я реалізую IDisposable наступним чином:

public class User : IDisposable
{
    public int id { get; protected set; }
    public string name { get; protected set; }
    public string pass { get; protected set; }

    public User(int UserID)
    {
        id = UserID;
    }
    public User(string Username, string Password)
    {
        name = Username;
        pass = Password;
    }

    // Other functions go here...

    public void Dispose()
    {
        // Clear all property values that maybe have been set
        // when the class was instantiated
        id = 0;
        name = String.Empty;
        pass = String.Empty;
    }
}

У VS2012 мій аналіз коду говорить, що правильно реалізувати IDisposable, але я не впевнений, що я тут зробив неправильно.
Точний текст такий:

CA1063 Правильно реалізувати ID Забезпечити реалізацію реалізованої версії Dispose (bool) на "User" або позначте тип як запечатаний. Заклик розпоряджатися (помилковим) повинен очищати лише рідні ресурси. Заклик розпоряджатися (правда) повинен очистити як керовані, так і рідні ресурси. stman User.cs 10

Для довідки: CA1063: Правильно реалізуйте ідентифікатор

Я прочитав цю сторінку, але боюся, що я не дуже розумію, що тут потрібно зробити.

Якщо хтось може пояснити більш ламенними термінами, в чому полягає проблема та / або як слід реалізувати IDisposable, це дійсно допоможе!

Це була б правильна реалізація, хоча я не бачу нічого необхідного для розпорядження в опублікованому вами коді. Вам потрібно реалізувати лише IDisposableтоді, коли:

1. У вас є некеровані ресурси
2. Ви тримаєтесь за посиланнями на речі, які самі по собі є одноразовими.

Нічого в коді, який ви опублікували, не потрібно утилізувати.

public class User : IDisposable
{
    public int id { get; protected set; }
    public string name { get; protected set; }
    public string pass { get; protected set; }

    public User(int userID)
    {
        id = userID;
    }
    public User(string Username, string Password)
    {
        name = Username;
        pass = Password;
    }

    // Other functions go here...

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (disposing) 
        {
            // free managed resources
        }
        // free native resources if there are any.
    }
}

Перш за все, вам не потрібно "прибирати" stringі int- вони будуть автоматично опікуватися сміттєзбірником. Єдине, що потрібно очистити, - Disposeце некеровані ресурси або керовані ресурси, які реалізуються IDisposable.

Однак якщо припустити, що це лише навчання, то рекомендованим способом реалізації IDisposableє додавання «уловлювача безпеки», щоб гарантувати, що будь-які ресурси не будуть утилізовані двічі:

public void Dispose()
{
    Dispose(true);

    // Use SupressFinalize in case a subclass 
    // of this type implements a finalizer.
    GC.SuppressFinalize(this);   
}
protected virtual void Dispose(bool disposing)
{
    if (!_disposed)
    {
        if (disposing) 
        {
            // Clear all property values that maybe have been set
            // when the class was instantiated
            id = 0;
            name = String.Empty;
            pass = String.Empty;
        }

        // Indicate that the instance has been disposed.
        _disposed = true;   
    }
}

Наступний приклад показує загальну найкращу практику для використання IDisposableінтерфейсу. Довідково

Майте на увазі, що деструктор (фіналізатор) вам потрібен лише в тому випадку, якщо у вас є керовані ресурси. І якщо ви додасте деструктор, вам слід придушити доопрацювання у розпорядженні , інакше це призведе до того, що ваші об'єкти залишаться в пам'яті протягом двох циклів сміття (Примітка. Прочитайте, як працює фіналізація ). Нижче наведено приклад детальніше.

public class DisposeExample
{
    // A base class that implements IDisposable. 
    // By implementing IDisposable, you are announcing that 
    // instances of this type allocate scarce resources. 
    public class MyResource: IDisposable
    {
        // Pointer to an external unmanaged resource. 
        private IntPtr handle;
        // Other managed resource this class uses. 
        private Component component = new Component();
        // Track whether Dispose has been called. 
        private bool disposed = false;

        // The class constructor. 
        public MyResource(IntPtr handle)
        {
            this.handle = handle;
        }

        // Implement IDisposable. 
        // Do not make this method virtual. 
        // A derived class should not be able to override this method. 
        public void Dispose()
        {
            Dispose(true);
            // This object will be cleaned up by the Dispose method. 
            // Therefore, you should call GC.SupressFinalize to 
            // take this object off the finalization queue 
            // and prevent finalization code for this object 
            // from executing a second time.
            GC.SuppressFinalize(this);
        }

        // Dispose(bool disposing) executes in two distinct scenarios. 
        // If disposing equals true, the method has been called directly 
        // or indirectly by a user's code. Managed and unmanaged resources 
        // can be disposed. 
        // If disposing equals false, the method has been called by the 
        // runtime from inside the finalizer and you should not reference 
        // other objects. Only unmanaged resources can be disposed. 
        protected virtual void Dispose(bool disposing)
        {
            // Check to see if Dispose has already been called. 
            if(!this.disposed)
            {
                // If disposing equals true, dispose all managed 
                // and unmanaged resources. 
                if(disposing)
                {
                    // Dispose managed resources.
                    component.Dispose();
                }

                // Call the appropriate methods to clean up 
                // unmanaged resources here. 
                // If disposing is false, 
                // only the following code is executed.
                CloseHandle(handle);
                handle = IntPtr.Zero;

                // Note disposing has been done.
                disposed = true;

            }
        }

        // Use interop to call the method necessary 
        // to clean up the unmanaged resource.
        [System.Runtime.InteropServices.DllImport("Kernel32")]
        private extern static Boolean CloseHandle(IntPtr handle);

        // Use C# destructor syntax for finalization code. 
        // This destructor will run only if the Dispose method 
        // does not get called. 
        // It gives your base class the opportunity to finalize. 
        // Do not provide destructors in types derived from this class.
        ~MyResource()
        {
            // Do not re-create Dispose clean-up code here. 
            // Calling Dispose(false) is optimal in terms of 
            // readability and maintainability.
            Dispose(false);
        }
    }
    public static void Main()
    {
        // Insert code here to create 
        // and use the MyResource object.
    }
}

IDisposableіснує, щоб забезпечити вам засіб для очищення некерованих ресурсів, які не буде очищено автоматично збирачем сміття.

Усі ресурси, які ви "прибираєте", - це керовані ресурси, і тому ваш Disposeметод нічого не досягає. Ваш клас взагалі не повинен реалізовуватись IDisposable. Колекціонер сміття піклується про всі ці поля самостійно.

Вам потрібно використовувати одноразовий візерунок так:

private bool _disposed = false;

protected virtual void Dispose(bool disposing)
{
    if (!_disposed)
    {
        if (disposing)
        {
            // Dispose any managed objects
            // ...
        }

        // Now disposed of any unmanaged objects
        // ...

        _disposed = true;
    }
}

public void Dispose()
{
    Dispose(true);
    GC.SuppressFinalize(this);  
}

// Destructor
~YourClassName()
{
    Dispose(false);
}

Вам не потрібно робити свій Userклас, IDisposableоскільки клас не набуває жодних керованих ресурсів (файлів, підключення до бази даних тощо). Зазвичай ми позначаємо класи так, IDisposableніби вони мають принаймні одне IDisposableполе чи / та властивість. Реалізуючи IDisposable, краще покладіть його за типовою схемою Microsoft:

public class User: IDisposable {
  ...
  protected virtual void Dispose(Boolean disposing) {
    if (disposing) {
      // There's no need to set zero empty values to fields 
      // id = 0;
      // name = String.Empty;
      // pass = String.Empty;

      //TODO: free your true resources here (usually IDisposable fields)
    }
  }

  public void Dispose() {
    Dispose(true);

    GC.SuppressFinalize(this);
  } 
}

Idisposable - це реалізація, коли потрібно детермінований (підтверджений) збір сміття.

class Users : IDisposable
    {
        ~Users()
        {
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
            // This method will remove current object from garbage collector's queue 
            // and stop calling finilize method twice 
        }    

        public void Dispose(bool disposer)
        {
            if (disposer)
            {
                // dispose the managed objects
            }
            // dispose the unmanaged objects
        }
    }

Під час створення та використання класу "Користувачі" використовуйте блок "використання", щоб уникнути явного виклику методу розпорядження:

using (Users _user = new Users())
            {
                // do user related work
            }

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

Я бачу дуже багато прикладів схеми Microsoft Dispose, яка справді є антидією. Як багато хто вказав, код у запитанні зовсім не вимагає ідентифікації. Але якщо ви, де збираєтесь його реалізувати, не використовуйте шаблон Microsoft. Кращою відповіддю буде наступні пропозиції в цій статті:

https://www.codeproject.com/Articles/29534/IDisposable-What-Your-Mother-Never-Told-You- About

Єдине, що може бути корисним - це придушення попередження про аналіз коду ... https://docs.microsoft.com/en-us/visualstudio/code-quality/in-source-suppression-overview?view=vs- 2017 рік