NonSerializedAttribute クラス
シリアル化できるクラスのフィールドをシリアル化しないことを示します。このクラスは継承できません。
名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文
解説
使用例
継承階層
スレッド セーフ
プラットフォーム
バージョン情報
参照
アセンブリ: mscorlib (mscorlib.dll 内)
構文<AttributeUsageAttribute(AttributeTargets.Field, Inherited:=False)> _ <ComVisibleAttribute(True)> _ Public NotInheritable Class NonSerializedAttribute Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Field, Inherited=false)] [ComVisibleAttribute(true)] public sealed class NonSerializedAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Field, Inherited=false)] [ComVisibleAttribute(true)] public ref class NonSerializedAttribute sealed : public Attribute
解説BinaryFormatter クラスまたは SoapFormatter クラスを使用してオブジェクトをシリアル化する場合は、NonSerializedAttribute 属性を使用して、フィールドがシリアル化されないようにします。たとえば、この属性を使用して、重要情報がシリアル化されるのを防ぐことができます。
NonSerializedAttribute 属性の対象のオブジェクトは、シリアル化できるクラスのパブリック フィールドおよびプライベート フィールドです。既定では、クラスは SerializableAttribute によってマーク付けされていない限り、シリアル化できません。シリアル化処理時には、既定としてクラスのすべてのパブリック フィールドおよびプライベート フィールドがシリアル化されます。NonSerializedAttribute によってマーク付けされたフィールドは、シリアル化の実行時に除外されます。XmlSerializer クラスを使用してオブジェクトをシリアル化する場合は、XmlIgnoreAttribute クラスを使用して同じ機能を得ることができます。また、ISerializable インターフェイスを実装することにより、シリアル化処理を明示的に制御することもできます。ISerializable を実装しているクラスにも SerializableAttribute でマーク付けする必要があります。
NonSerializedAttribute クラスをイベントに適用するには、次の C# コードのように、属性の位置をフィールドに設定します。
シリアル化しないフィールドでも、逆シリアル化後に既定値を指定する必要がある場合は、フィールドに値を提供するメソッドを作成し、そのメソッドに対して OnDeserializedAttribute を適用できます。
使用例SerializableAttribute 属性でマーク付けされたオブジェクトのシリアル化と、シリアル化されたオブジェクトでの、NonSerializedAttribute でマーク付けされたフィールドの動作を、次の例に示します。
Imports System Imports System.IO Imports System.Runtime.Serialization Imports System.Runtime.Serialization.Formatters.Soap Public Class Test Public Shared Sub Main() ' Creates a new TestSimpleObject object. Dim obj As New TestSimpleObject() Console.WriteLine("Before serialization the object contains: ") obj.Print() ' Opens a file and serializes the object into it in binary format. Dim stream As Stream = File.Open("data.xml", FileMode.Create) Dim formatter As New SoapFormatter() formatter.Serialize(stream, obj) stream.Close() ' Empties obj. obj = Nothing ' Opens file "data.xml" and deserializes the object from it. stream = File.Open("data.xml", FileMode.Open) formatter = New SoapFormatter() obj = CType(formatter.Deserialize(stream), TestSimpleObject) stream.Close() Console.WriteLine("") Console.WriteLine("After deserialization the object contains: ") obj.Print() End Sub 'Main End Class 'Test ' A test object that needs to be serialized. <Serializable()> Public Class TestSimpleObject Public member1 As Integer Public member2 As String Public member3 As String Public member4 As Double ' A member that is not serialized. <NonSerialized()> Public member5 As String Public Sub New() member1 = 11 member2 = "hello" member3 = "hello" member4 = 3.14159265 member5 = "hello world!" End Sub 'New Public Sub Print() Console.WriteLine("member1 = '{0}'", member1) Console.WriteLine("member2 = '{0}'", member2) Console.WriteLine("member3 = '{0}'", member3) Console.WriteLine("member4 = '{0}'", member4) Console.WriteLine("member5 = '{0}'", member5) End Sub 'Print End Class 'TestSimpleObject
using System; using System.IO; using System.Runtime.Serialization; using System.Runtime.Serialization.Formatters.Soap; //using System.Runtime.Serialization.Formatters.Binary; public class Test { public static void Main() { //Creates a new TestSimpleObject object. TestSimpleObject obj = new TestSimpleObject(); Console.WriteLine("Before serialization the object contains: "); obj.Print(); //Opens a file and serializes the object into it in binary format. Stream stream = File.Open("data.xml", FileMode.Create); SoapFormatter formatter = new SoapFormatter(); //BinaryFormatter formatter = new BinaryFormatter(); formatter.Serialize(stream, obj); stream.Close(); //Empties obj. obj = null; //Opens file "data.xml" and deserializes the object from it. stream = File.Open("data.xml", FileMode.Open); formatter = new SoapFormatter(); //formatter = new BinaryFormatter(); obj = (TestSimpleObject)formatter.Deserialize(stream); stream.Close(); Console.WriteLine(""); Console.WriteLine("After deserialization the object contains: "); obj.Print(); } } // A test object that needs to be serialized. [Serializable()] public class TestSimpleObject { public int member1; public string member2; public string member3; public double member4; // A field that is not serialized. [NonSerialized()] public string member5; public TestSimpleObject() { member1 = 11; member2 = "hello"; member3 = "hello"; member4 = 3.14159265; member5 = "hello world!"; } public void Print() { Console.WriteLine("member1 = '{0}'", member1); Console.WriteLine("member2 = '{0}'", member2); Console.WriteLine("member3 = '{0}'", member3); Console.WriteLine("member4 = '{0}'", member4); Console.WriteLine("member5 = '{0}'", member5); } }
#using <system.dll> #using <system.messaging.dll> #using <System.Runtime.Serialization.Formatters.Soap.dll> using namespace System; using namespace System::IO; using namespace System::Runtime::Serialization::Formatters::Soap; // A test object that needs to be serialized. [Serializable] ref class TestSimpleObject { private: int member1; String^ member2; String^ member3; double member4; public: // A field that is not serialized. [NonSerialized] String^ member5; TestSimpleObject() { member1 = 11; member2 = "hello"; member3 = "hello"; member4 = 3.14159265; member5 = "hello world!"; } void Print() { Console::WriteLine( "member1 = ' {0}'", member1 ); Console::WriteLine( "member2 = ' {0}'", member2 ); Console::WriteLine( "member3 = ' {0}'", member3 ); Console::WriteLine( "member4 = ' {0}'", member4 ); Console::WriteLine( "member5 = ' {0}'", member5 ); } }; int main() { //Creates a new TestSimpleObject object. TestSimpleObject^ obj = gcnew TestSimpleObject; Console::WriteLine( "Before serialization the Object* contains: " ); obj->Print(); //Opens a file and serializes the object into it in binary format. Stream^ stream = File::Open( "data.xml", FileMode::Create ); SoapFormatter^ formatter = gcnew SoapFormatter; //BinaryFormatter* formatter = new BinaryFormatter(); formatter->Serialize( stream, obj ); stream->Close(); //Empties obj. obj = nullptr; //Opens file S"data.xml" and deserializes the object from it. stream = File::Open( "data.xml", FileMode::Open ); formatter = gcnew SoapFormatter; //formatter = new BinaryFormatter(); obj = dynamic_cast<TestSimpleObject^>(formatter->Deserialize( stream )); stream->Close(); Console::WriteLine( "" ); Console::WriteLine( "After deserialization the object contains: " ); obj->Print(); }
import System.*; import System.IO.*; import System.Runtime.Serialization.*; import System.Runtime.Serialization.Formatters.Soap.*; //import System.Runtime.Serialization.Formatters.Binary; public class Test { public static void main(String[] args) { //Creates a new TestSimpleObject object. TestSimpleObject obj = new TestSimpleObject(); Console.WriteLine("Before serialization the object contains: "); obj.Print(); //Opens a file and serializes the object into it in binary format. Stream stream = File.Open("data.xml", FileMode.Create); SoapFormatter formatter = new SoapFormatter(); //BinaryFormatter formatter = new BinaryFormatter(); formatter.Serialize(stream, obj); stream.Close(); //Empties obj. obj = null; //Opens file "data.xml" and deserializes the object from it. stream = File.Open("data.xml", FileMode.Open); formatter = new SoapFormatter(); //formatter = new BinaryFormatter(); obj = (TestSimpleObject)(formatter.Deserialize(stream)); stream.Close(); Console.WriteLine(""); Console.WriteLine("After deserialization the object contains: "); obj.Print(); } //main } //Test // A test object that needs to be serialized. /** @attribute Serializable() */ public class TestSimpleObject { public int member1; public String member2; public String member3; public double member4; // A field that is not serialized. /** @attribute NonSerialized() */ public String member5; public TestSimpleObject() { member1 = 11; member2 = "hello"; member3 = "hello"; member4 = 3.14159265; member5 = "hello world!"; } //TestSimpleObject public void Print() { Console.WriteLine("member1 = '{0}'", (System.Int32)member1); Console.WriteLine("member2 = '{0}'", member2); Console.WriteLine("member3 = '{0}'", member3); Console.WriteLine("member4 = '{0}'", (System.Double)member4); Console.WriteLine("member5 = '{0}'", member5); } //Print } //TestSimpleObject
継承階層
System.Object
System.Attribute
System.NonSerializedAttribute
System.Attribute
System.NonSerializedAttribute
スレッド セーフプラットフォームWindows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照NonSerializedAttribute コンストラクタ
NonSerializedAttribute クラスの新しいインスタンスを初期化します。
名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文
プラットフォーム
バージョン情報
参照
アセンブリ: mscorlib (mscorlib.dll 内)
構文プラットフォームWindows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照NonSerializedAttribute プロパティ
.gif)
NonSerializedAttribute メソッド
パブリック メソッド| 名前 | 説明 | |
|---|---|---|
.gif) | Equals | オーバーロードされます。 ( Attribute から継承されます。) |
| | GetCustomAttribute | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。) |
| | GetCustomAttributes | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。) |
| | GetHashCode | このインスタンスのハッシュ コードを返します。 ( Attribute から継承されます。) |
| | GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) |
.gif) | IsDefaultAttribute | 派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。) |
| | IsDefined | オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。) |
| | Match | 派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。) |
| | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) |
| | ToString | 現在の Object を表す String を返します。 ( Object から継承されます。) |
参照NonSerializedAttribute メンバ
シリアル化できるクラスのフィールドをシリアル化しないことを示します。このクラスは継承できません。
NonSerializedAttribute データ型で公開されるメンバを以下の表に示します。
パブリック コンストラクタパブリック プロパティパブリック メソッド| 名前 | 説明 | |
|---|---|---|
| | Equals | オーバーロードされます。 ( Attribute から継承されます。) |
| | GetCustomAttribute | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。) |
| | GetCustomAttributes | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。) |
| | GetHashCode | このインスタンスのハッシュ コードを返します。 (Attribute から継承されます。) |
| | GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
| | IsDefaultAttribute | 派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。) |
| | IsDefined | オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。) |
| | Match | 派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。) |
| | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) |
| | ToString | 現在の Object を表す String を返します。 (Object から継承されます。) |
参照- NonSerializedAttributeのページへのリンク
