การใช้ 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 Implement IDisposable อย่างถูกต้องจัดให้มีการใช้งาน Disrid (bool) overridable ใน 'ผู้ใช้' หรือทำเครื่องหมายประเภทเป็นปิดผนึก การเรียกใช้การกำจัด (false) ควรล้างทรัพยากรดั้งเดิมเท่านั้น การเรียกร้องให้จัดการ (จริง) ควรล้างทรัพยากรที่มีการจัดการและดั้งเดิม stman User.cs 10

สำหรับการอ้างอิง: CA1063: ใช้ IDisposable อย่างถูกต้อง

ฉันได้อ่านหน้านี้แล้ว แต่ฉันเกรงว่าฉันไม่เข้าใจจริงๆว่าต้องทำอะไรที่นี่

หากทุกคนสามารถอธิบายได้ในแง่ของปัญหาที่เกิดขึ้นและ / หรือวิธีการที่ 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และints - พวกเขาจะได้รับการดูแลโดยอัตโนมัติโดยการเก็บขยะ สิ่งเดียวที่จะต้องทำความสะอาดในDisposeเป็นทรัพยากรที่ไม่มีการจัดการหรือ recources 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ส่วนต่อประสาน การอ้างอิง

จำไว้ว่าคุณต้องมี destructor (finalizer) ก็ต่อเมื่อคุณมีทรัพยากรที่ไม่มีการจัดการในชั้นเรียนของคุณ และถ้าคุณเพิ่ม destructor คุณควรระงับ Finalization ใน Disposeมิฉะนั้นจะทำให้วัตถุของคุณอยู่ในหน่วยความจำสำหรับสองรอบขยะ (หมายเหตุ: อ่านวิธีการทำงานของ Finalization ) ตัวอย่างด้านล่างให้รายละเอียดทั้งหมดข้างต้น

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มีอยู่เพื่อจัดเตรียมวิธีการสำหรับคุณในการล้างทรัพยากรที่ไม่มีการจัดการซึ่งจะไม่ถูกล้างข้อมูลโดยอัตโนมัติโดย Garbage Collector

ทรัพยากรทั้งหมดที่คุณ "ล้างข้อมูล" เป็นทรัพยากรที่มีการจัดการและDisposeวิธีการของคุณไม่ประสบความสำเร็จ ชั้นเรียนของคุณไม่ควรติดตั้งIDisposableเลย The Garbage Collector จะดูแลทุกฟิลด์เหล่านั้นให้ดีเอง

คุณต้องใช้รูปแบบที่ใช้แล้วทิ้งแบบนี้:

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" เพื่อหลีกเลี่ยงการเรียกวิธีการกำจัดอย่างชัดเจน:

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

ในตอนท้ายของการใช้บล็อกที่สร้างขึ้นวัตถุผู้ใช้จะถูกกำจัดโดยการร้องขอโดยนัยของวิธีการกำจัด

ฉันเห็นตัวอย่างมากมายของรูปแบบ 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