CA2000: スコープが失われる前にオブジェクトを破棄します
TypeName |
DisposeObjectsBeforeLosingScope |
CheckId |
CA2000 |
分類 |
Microsoft.Reliability |
互換性に影響する変更点 |
なし |
原因
IDisposable 型のローカル オブジェクトは作成されますが、そのオブジェクトに対するすべての参照がスコープ外になる前に、オブジェクトが破棄されていません。
規則の説明
破棄できるオブジェクトに対するすべての参照がスコープ外になる前に、オブジェクトが明示的に破棄されない場合、ガベージ コレクターでオブジェクトのファイナライザーが実行されるときに破棄されますが、タイミングは一定ではありません。例外的なイベントが発生するとオブジェクトのファイナライザーを実行できないため、オブジェクトは明示的に破棄する必要があります。
違反の修正方法
この規則違反を修正するには、オブジェクトに対するすべての参照がスコープ外になる前に、そのオブジェクトで Dispose を呼び出します。
using ステートメント (Visual Basic の場合は Using) を使用して、IDisposable を実装するオブジェクトをラップすることができます。このステートメントによってラップされたオブジェクトは、using ブロックの終わりで自動的に破棄されます。
using ステートメントでは十分に IDisposable オブジェクトを保護できない次のような場合があります。この場合、CA2000 が発生する可能性があります。
破棄可能オブジェクトを返すには、このオブジェクトは using ブロック外の try/finally ブロックで構築される必要があります。
破棄可能オブジェクトのメンバーは、using ステートメントのコンストラクターでは初期化できません。
1 つの例外ハンドラーによってのみ保護された入れ子のコンストラクター。次に例を示します。
using (StreamReader sr = new StreamReader(new FileStream("C:\myfile.txt", FileMode.Create))) { ... }この場合、StreamReader オブジェクトの構築が失敗すると FileStream オブジェクトが閉じられなくなることがあるので、CA2000 が発生します。
動的オブジェクトは、シャドウ オブジェクトを使用して IDisposable オブジェクトの Dispose パターンを実装する必要があります。
警告を抑制する状況
Dispose を呼び出すオブジェクトに対して Close などのメソッドを呼び出した場合、または警告を発生させたメソッドがオブジェクトをラップする IDisposable オブジェクトを返す場合を除き、この規則による警告を抑制しないでください。
関連規則
CA2213: 破棄可能なフィールドは破棄されなければなりません
使用例
破棄可能なオブジェクトを返すメソッドを実装している場合は、catch ブロックのない try/finally ブロックを使用して、そのオブジェクトが確実に破棄されるようにします。try/finally ブロックを使用することによって、障害点での例外の発生が可能になり、そのオブジェクトが確実に破棄されます。
OpenPort1 メソッドでは、ISerializable オブジェクトの SerialPort を開くための呼び出し、または SomeMethod の呼び出しが失敗する可能性があります。この実装では CA2000 警告は発生しません。
OpenPort2 メソッドでは、次の 2 つの SerialPort オブジェクトが宣言され、null に設定されます。
tempPort。メソッド操作が成功しているかどうかをテストするのに使用されます。
port。メソッドの戻り値に使用されます。
tempPort は、try ブロックで構築され、開かれます。その他必要な作業も同じ try ブロック内で実行されます。try ブロックの最後に、開かれたポートが port オブジェクトに割り当てられ、このオブジェクトが返されます。tempPort オブジェクトは null に設定されます。
finally ブロックは tempPort 値をチェックします。null でない場合、メソッド内の操作は失敗しています。tempPort は閉じられ、すべてのリソースが解放されます。返されるオブジェクトには、メソッド操作が成功した場合、開かれた SerialPort オブジェクトが含まれます。メソッドの操作が失敗した場合は null になります。
Public Function OpenPort1(ByVal PortName As String) As SerialPort
Dim port As New SerialPort(PortName)
port.Open() 'CA2000 fires because this might throw
SomeMethod() 'Other method operations can fail
Return port
End Function
Public Function OpenPort2(ByVal PortName As String) As SerialPort
Dim tempPort As SerialPort = Nothing
Dim port As SerialPort = Nothing
Try
tempPort = New SerialPort(PortName)
tempPort.Open()
SomeMethod()
'Add any other methods above this line
port = tempPort
tempPort = Nothing
Finally
If Not tempPort Is Nothing Then
tempPort.Close()
End If
End Try
Return port
End Function
Public Function CreateReader1(ByVal x As Integer) As StreamReader
Dim local As New StreamReader("C:\Temp.txt")
x += 1
Return local
End Function
Public Function CreateReader2(ByVal x As Integer) As StreamReader
Dim local As StreamReader = Nothing
Dim localTemp As StreamReader = Nothing
Try
localTemp = New StreamReader("C:\Temp.txt")
x += 1
local = localTemp
localTemp = Nothing
Finally
If (Not (localTemp Is Nothing)) Then
localTemp.Dispose()
End If
End Try
Return local
End Function
public SerialPort OpenPort1(string portName)
{
SerialPort port = new SerialPort(portName);
port.Open(); //CA2000 fires because this might throw
SomeMethod(); //Other method operations can fail
return port;
}
public SerialPort OpenPort2(string portName)
{
SerialPort tempPort = null;
SerialPort port = null;
try
{
tempPort = new SerialPort(portName);
tempPort.Open();
SomeMethod();
//Add any other methods above this line
port = tempPort;
tempPort = null;
}
finally
{
if (tempPort != null)
{
tempPort.Close();
}
}
return port;
}
Visual Basic コンパイラは既定ですべての算術演算子のオーバーフローをチェックします。そのため、いずれかの Visual Basic 算術演算子で OverflowException がスローされる可能性があります。これにより、CA2000 のような予期しない規則違反が発生する場合があります。たとえば、次の CreateReader1 関数では、Visual Basic コンパイラが加算に対するオーバーフロー チェックを実行し、それが例外をスローすると StreamReader が破棄されなくなるので、CA2000 違反が発生します。
これを修正するには、プロジェクトで Visual Basic コンパイラによるオーバーフロー チェックの実施を無効にするか、または次の CreateReader2 関数のようにコードを変更します。
オーバーフロー チェックの実施を無効にするには、ソリューション エクスプローラーでプロジェクト名を右クリックし、[プロパティ] をクリックします。[コンパイル] をクリックし、[詳細コンパイル オプション] をクリックし、[整数オーバーフローのチェックを解除] をオンにします。