CA2237:ISerializable 型を SerializableAttribute に設定します

  • [アーティクル]
プロパティ 値
ルール ID CA2237
Title ISerializable 型を SerializableAttribute に設定します
[カテゴリ] 使用方法
修正が中断ありか中断なしか なし
.NET 8 では既定で有効 いいえ

原因

外部から参照できる型が System.Runtime.Serialization.ISerializable インターフェイスを実装し、その型が System.SerializableAttribute 属性でマークされていません。 この規則は、基本データ型がシリアル化可能でない派生型を無視します。

規則の説明

型が共通言語ランタイムでシリアル化できると認識されるようにするには、型を SerializableAttribute 属性でマークする必要があります。型が ISerializable インターフェイスの実装を通じてカスタムのシリアル化ルーチンを使用している場合でも、マークする必要があります。

違反の修正方法

この規則の違反を修正するには、SerializableAttribute 属性を型に適用します。

どのようなときに警告を抑制するか

例外クラスがアプリケーション ドメインを超えて正しく機能するためにはシリアル化できることが必要であるため、それらに対するこの規則からの警告を抑制しないでください。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

#pragma warning disable CA2237
// The code that's violating the rule is on this line.
#pragma warning restore CA2237

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

[*.{cs,vb}]
dotnet_diagnostic.CA2237.severity = none

詳細については、「コード分析の警告を抑制する方法」を参照してください。

例

次の例は、規則に違反する型を示しています。 規則を満たすには、SerializableAttribute 属性行のコメントを解除します。

Imports System
Imports System.Runtime.Serialization
Imports System.Security.Permissions

Namespace ca2237

    ' <SerializableAttribute> _ 
    Public Class BaseType
        Implements ISerializable

        Dim baseValue As Integer

        Sub New()
            baseValue = 3
        End Sub

        Protected Sub New(
         info As SerializationInfo, context As StreamingContext)

            baseValue = info.GetInt32("baseValue")

        End Sub

        Overridable Sub GetObjectData(
         info As SerializationInfo, context As StreamingContext) _
         Implements ISerializable.GetObjectData

            info.AddValue("baseValue", baseValue)

        End Sub

    End Class

End Namespace

// [SerializableAttribute]
public class BaseType : ISerializable
{
    int baseValue;

    public BaseType()
    {
        baseValue = 3;
    }

    protected BaseType(
       SerializationInfo info, StreamingContext context)
    {
        baseValue = info.GetInt32("baseValue");
    }

    public virtual void GetObjectData(
       SerializationInfo info, StreamingContext context)
    {
        info.AddValue("baseValue", baseValue);
    }
}