ISerializable インターフェイス
オブジェクトが独自のシリアル化および逆シリアル化を制御できるようにします。
名前空間: System.Runtime.Serialization
アセンブリ: mscorlib (mscorlib.dll 内)
構文
解説
使用例
プラットフォーム
バージョン情報
参照
アセンブリ: mscorlib (mscorlib.dll 内)
構文解説シリアル化される可能性があるクラスは、SerializableAttribute でマークする必要があります。クラスがクラス自体のシリアル化プロセスを制御する必要がある場合は、ISerializable インターフェイスを実装できます。Formatter は、シリアル化時に GetObjectData を呼び出し、提供された SerializationInfo にオブジェクトを表すために必要なすべてのデータを設定します。Formatter は、グラフ内のオブジェクトの型を使用して SerializationInfo を作成します。自らのプロキシを送信する必要があるオブジェクトは、SerializationInfo で FullTypeName メソッドおよび AssemblyName メソッドを使用して、送信された情報を変更できます。
クラス継承の場合、基本クラスが ISerializable を実装していれば、その派生クラスをシリアル化できます。この場合、派生クラスは、その GetObjectData 実装の中で、基本クラスに実装されている GetObjectData を呼び出す必要があります。それ以外の場合、基本クラスからのデータはシリアル化されません。
ISerializable インターフェイスは、シグネチャ コンストラクタ (SerializationInfo 情報、StreamingContext コンテキスト) を使用して、コンストラクタを示します。逆シリアル化時に現在のコンストラクタが呼び出されるのは、フォーマッタが SerializationInfo のデータを逆シリアル化した後だけです。通常、クラスがシール クラスでない場合は、このコンストラクタを保護する必要があります。
オブジェクトが逆シリアル化される順序は保証できません。たとえば、ある型がまだ逆シリアル化されていない型を参照すると、例外が発生します。このような依存関係を持つ型を作成する場合は、IDeserializationCallback インターフェイスと OnDeserialization メソッドを実装することで問題を回避できます。
シリアル化アーキテクチャでは、Object を拡張する型の処理と同様に、MarshalByRefObject を拡張するオブジェクト型が処理されます。これらの型は、SerializableAttribute でマークして、ほかのオブジェクト型のように ISerializable インターフェイスを実装できます。それらのオブジェクトの状態は、キャプチャされ、ストリームに永続化されます。
これらの型が System.Runtime.Remoting を経由して使用されると、リモート処理インフラストラクチャによって、通常のシリアル化より優先されるサロゲートが提供され、代わりに MarshalByRefObject へのプロキシがシリアル化されます。サロゲートは、特定の型のオブジェクトをシリアル化および逆シリアル化する方法を把握しているヘルパです。プロキシはユーザーに見えないことが多く、ObjRef 型です。
通常、一般的なデザイン パターンとして、クラスがシリアル化できる属性でマークされ MarshalByRefObject を拡張することはありません。この 2 つの特性を組み合わせる場合、開発者は、使用できるシリアル化およびリモート処理方法について慎重に検討する必要があります。一例として、MemoryStream を使用することが考えられます。MemoryStream (Stream) の基本クラスを MarshalByRefObject から拡張すると、MemoryStream の状態をキャプチャして、自由にそれを復元できます。したがって、このストリームの状態をデータベースにシリアル化して、後でそれを復元できます。ただし、リモート処理を通して使用すると、この型のオブジェクトはプロキシ扱いになります。
MarshalByRefObject を拡張するクラスのシリアル化の詳細については、RemotingSurrogateSelector のトピックを参照してください。ISerializable の実装方法の詳細については、「シリアル化のカスタマイズ」を参照してください。
実装時の注意 このインターフェイスを実装して、オブジェクトが独自のシリアル化および逆シリアル化を実行できるようにします。使用例クラスのカスタム シリアル化動作を定義するために、ISerializable インターフェイスを使用するコード例を次に示します。
Imports System Imports System.Web Imports System.IO Imports System.Collections Imports System.Runtime.Serialization.Formatters.Binary Imports System.Runtime.Serialization Imports System.Security.Permissions ' There should be only one instance of this type per AppDomain. <Serializable()> _ Public NotInheritable Class Singleton Implements ISerializable ' This is the one instance of this type. Private Shared ReadOnly theOneObject As New Singleton ' Here are the instance fields. Public someString As String Public someNumber As Int32 ' Private constructor allowing this type to construct the Singleton. Private Sub New() ' Do whatever is necessary to initialize the Singleton. someString = "This is a string field" someNumber = 123 End Sub ' A method returning a reference to the Singleton. Public Shared Function GetSingleton() As Singleton Return theOneObject End Function ' A method called when serializing a Singleton. <SecurityPermissionAttribute(SecurityAction.LinkDemand, _ Flags:=SecurityPermissionFlag.SerializationFormatter)> _ Private Sub GetObjectData(ByVal info As SerializationInfo, _ ByVal context As StreamingContext) _ Implements ISerializable.GetObjectData ' Instead of serializing this object, we will ' serialize a SingletonSerializationHelp instead. info.SetType(GetType(SingletonSerializationHelper)) ' No other values need to be added. End Sub ' Note: ISerializable's special constructor is not necessary ' because it is never called. End Class <Serializable()> _ Friend NotInheritable Class SingletonSerializationHelper Implements IObjectReference ' This object has no fields (although it could). ' GetRealObject is called after this object is deserialized. Public Function GetRealObject(ByVal context As StreamingContext) As Object Implements IObjectReference.GetRealObject ' When deserialiing this object, return a reference to ' the Singleton object instead. Return Singleton.GetSingleton() End Function End Class Class App <STAThread()> Shared Sub Main() Run() End Sub Shared Sub Run() Dim fs As New FileStream("DataFile.dat", FileMode.Create) Try ' Construct a BinaryFormatter and use it ' to serialize the data to the stream. Dim formatter As New BinaryFormatter ' Create an array with multiple elements refering to ' the one Singleton object. Dim a1() As Singleton = {Singleton.GetSingleton(), Singleton.GetSingleton()} ' This displays "True". Console.WriteLine("Do both array elements refer to the same object? " & _ Object.ReferenceEquals(a1(0), a1(1))) ' Serialize the array elements. formatter.Serialize(fs, a1) ' Deserialize the array elements. fs.Position = 0 Dim a2() As Singleton = DirectCast(formatter.Deserialize(fs), Singleton()) ' This displays "True". Console.WriteLine("Do both array elements refer to the same object? " & _ Object.ReferenceEquals(a2(0), a2(1))) ' This displays "True". Console.WriteLine("Do all array elements refer to the same object? " & _ Object.ReferenceEquals(a1(0), a2(0))) Catch e As SerializationException Console.WriteLine("Failed to serialize. Reason: " & e.Message) Throw Finally fs.Close() End Try End Sub End Class
using System; using System.Web; using System.IO; using System.Collections; using System.Runtime.Serialization.Formatters.Binary; using System.Runtime.Serialization; using System.Security.Permissions; // There should be only one instance of this type per AppDomain. [Serializable] public sealed class Singleton : ISerializable { // This is the one instance of this type. private static readonly Singleton theOneObject = new Singleton(); // Here are the instance fields. private string someString_value; private Int32 someNumber_value; public string SomeString { get{return someString_value;} set{someString_value = value;} } public Int32 SomeNumber { get{return someNumber_value;} set{someNumber_value = value;} } // Private constructor allowing this type to construct the Singleton. private Singleton() { // Do whatever is necessary to initialize the Singleton. someString_value = "This is a string field"; someNumber_value = 123; } // A method returning a reference to the Singleton. public static Singleton GetSingleton() { return theOneObject; } // A method called when serializing a Singleton. [SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.SerializationFormatter)] void ISerializable.GetObjectData( SerializationInfo info, StreamingContext context) { // Instead of serializing this object, // serialize a SingletonSerializationHelp instead. info.SetType(typeof(SingletonSerializationHelper)); // No other values need to be added. } // Note: ISerializable's special constructor is not necessary // because it is never called. } [Serializable] internal sealed class SingletonSerializationHelper : IObjectReference { // This object has no fields (although it could). // GetRealObject is called after this object is deserialized. public Object GetRealObject(StreamingContext context) { // When deserialiing this object, return a reference to // the Singleton object instead. return Singleton.GetSingleton(); } } class App { [STAThread] static void Main() { FileStream fs = new FileStream("DataFile.dat", FileMode.Create); try { // Construct a BinaryFormatter and use it // to serialize the data to the stream. BinaryFormatter formatter = new BinaryFormatter(); // Create an array with multiple elements refering to // the one Singleton object. Singleton[] a1 = { Singleton.GetSingleton(), Singleton.GetSingleton() }; // This displays "True". Console.WriteLine( "Do both array elements refer to the same object? " + (a1[0] == a1[1])); // Serialize the array elements. formatter.Serialize(fs, a1); // Deserialize the array elements. fs.Position = 0; Singleton[] a2 = (Singleton[]) formatter.Deserialize(fs); // This displays "True". Console.WriteLine("Do both array elements refer to the same object? " + (a2[0] == a2[1])); // This displays "True". Console.WriteLine("Do all array elements refer to the same object? " + (a1[0] == a2[0])); } catch (SerializationException e) { Console.WriteLine("Failed to serialize. Reason: " + e.Message); throw; } finally { fs.Close(); } } }
using namespace System; using namespace System::IO; using namespace System::Collections; using namespace System::Runtime::Serialization::Formatters::Binary; using namespace System::Runtime::Serialization; ref class SingletonSerializationHelper; // There should be only one instance of this type per AppDomain. [Serializable] public ref class Singleton sealed: public ISerializable { private: // This is the one instance of this type. static Singleton^ theOneObject = gcnew Singleton; public: // Here are the instance fields. String^ someString; Int32 someNumber; private: // Private constructor allowing this type to construct the singleton. Singleton() { // Do whatever is necessary to initialize the singleton. someString = "This is a String* field"; someNumber = 123; } public: // A method returning a reference to the singleton. static Singleton^ GetSingleton() { return theOneObject; } // A method called when serializing a Singleton. [System::Security::Permissions::SecurityPermissionAttribute (System::Security::Permissions::SecurityAction::LinkDemand, Flags=System::Security::Permissions::SecurityPermissionFlag::SerializationFormatter)] virtual void GetObjectData( SerializationInfo^ info, StreamingContext context ) { // Instead of serializing this Object*, we will // serialize a SingletonSerializationHelp instead. info->SetType( SingletonSerializationHelper::typeid ); // No other values need to be added. } // NOTE: ISerializable*'s special constructor is NOT necessary // because it's never called }; [Serializable] private ref class SingletonSerializationHelper sealed: public IObjectReference { public: // This Object* has no fields (although it could). // GetRealObject is called after this Object* is deserialized virtual Object^ GetRealObject( StreamingContext context ) { // When deserialiing this Object*, return a reference to // the singleton Object* instead. return Singleton::GetSingleton(); } }; [STAThread] int main() { FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Create ); try { // Construct a BinaryFormatter and use it // to serialize the data to the stream. BinaryFormatter^ formatter = gcnew BinaryFormatter; // Create an array with multiple elements refering to // the one Singleton Object*. array<Singleton^>^a1 = {Singleton::GetSingleton(),Singleton::GetSingleton()}; // This displays S"True". Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a1[ 0 ] == a1[ 1 ]) ); // Serialize the array elements. formatter->Serialize( fs, a1 ); // Deserialize the array elements. fs->Position = 0; array<Singleton^>^a2 = (array<Singleton^>^)formatter->Deserialize( fs ); // This displays S"True". Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a2[ 0 ] == a2[ 1 ]) ); // This displays S"True". Console::WriteLine( "Do all array elements refer to the same Object? {0}", (a1[ 0 ] == a2[ 0 ]) ); } catch ( SerializationException^ e ) { Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message ); throw; } finally { fs->Close(); } return 0; }
プラットフォームWindows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- ISerializable インターフェイスのページへのリンク
