Реализация 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 Внедрение IDisposable правильно Предоставьте переопределяемую реализацию Dispose (bool) для «User» или пометьте тип как закрытый. Вызов Dispose (false) должен только очистить собственные ресурсы. Вызов Dispose (true) должен очистить как управляемые, так и собственные ресурсы. stman User.cs 10

Для справки: CA1063: правильно реализовать ID

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

Если кто-то может объяснить более ламенными терминами, в чем заключается проблема и / или как должна реализовываться 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.
    }
}

Прежде всего, вам не нужно «убирать» strings и ints - они будут автоматически обработаны сборщиком мусора. Единственное, что нужно очистить, 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интерфейса. Ссылка

Имейте в виду, что вам нужен деструктор (финализатор), только если у вас есть неуправляемые ресурсы в вашем классе. И если вы добавите деструктор, вы должны запретить Финализацию в Dispose , иначе это приведет к тому, что ваши объекты будут находиться в памяти в течение двух циклов мусора (Примечание: прочтите, как работает Финализация ). Ниже приведен пример.

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

При создании и использовании класса Users используйте блок «using», чтобы избежать явного вызова метода dispose:

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

конец созданного блока пользователя Объект Users будет удален неявным вызовом метода dispose.

Я вижу много примеров шаблона Microsoft Dispose, который действительно является анти-шаблоном. Как многие отмечают, код в вопросе не требует IDisposable вообще. Но если вы собираетесь его реализовать, не используйте шаблон 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