NetDataContractSerializer Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Serializa e desserializa uma instância de um tipo em fluxo ou documento XML usando os tipos .NET fornecidos. Esta classe não pode ser herdada.
public ref class NetDataContractSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer, System::Runtime::Serialization::IFormatter
public sealed class NetDataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer, System.Runtime.Serialization.IFormatter
type NetDataContractSerializer = class
inherit XmlObjectSerializer
interface IFormatter
Public NotInheritable Class NetDataContractSerializer
Inherits XmlObjectSerializer
Implements IFormatter
- Herança
- Implementações
Exemplos
O seguinte exemplo de código mostra um tipo nomeado Person que é serializado pelo NetDataContractSerializer. O DataContractAttribute atributo é aplicado à classe, e DataMemberAttribute é aplicado aos membros (incluindo um membro privado) para instruir o NetDataContractSerializer que serializar.
// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the NetDataContractSerializer.
[DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
class Person : IExtensibleDataObject
{
[DataMember()]
public string FirstName;
[DataMember]
public string LastName;
[DataMember()]
public int ID;
public Person(string newfName, string newLName, int newID)
{
FirstName = newfName;
LastName = newLName;
ID = newID;
}
private ExtensionDataObject extensionData_Value;
public ExtensionDataObject ExtensionData
{
get
{
return extensionData_Value;
}
set
{
extensionData_Value = value;
}
}
}
public sealed class Test
{
private Test() { }
public static void Main()
{
try
{
WriteObject("NetDataContractSerializerExample.xml");
ReadObject("NetDataContractSerializerExample.xml");
}
catch (SerializationException serExc)
{
Console.WriteLine("Serialization Failed");
Console.WriteLine(serExc.Message);
}
catch (Exception exc)
{
Console.WriteLine(
"The serialization operation failed: {0} StackTrace: {1}",
exc.Message, exc.StackTrace);
}
finally
{
Console.WriteLine("Press <Enter> to exit....");
Console.ReadLine();
}
}
public static void WriteObject(string fileName)
{
Console.WriteLine(
"Creating a Person object and serializing it.");
Person p1 = new Person("Zighetti", "Barbara", 101);
FileStream fs = new FileStream(fileName, FileMode.Create);
XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
NetDataContractSerializer ser =
new NetDataContractSerializer();
ser.WriteObject(writer, p1);
writer.Close();
}
public static void ReadObject(string fileName)
{
Console.WriteLine("Deserializing an instance of the object.");
FileStream fs = new FileStream(fileName,
FileMode.Open);
XmlDictionaryReader reader =
XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
NetDataContractSerializer ser = new NetDataContractSerializer();
// Deserialize the data and read it from the instance.
Person deserializedPerson =
(Person)ser.ReadObject(reader, true);
fs.Close();
Console.WriteLine(String.Format("{0} {1}, ID: {2}",
deserializedPerson.FirstName, deserializedPerson.LastName,
deserializedPerson.ID));
}
}
' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the NetDataContractSerializer.
<DataContract(Name := "Customer", [Namespace] := "http://www.contoso.com")> _
Class Person
Implements IExtensibleDataObject
<DataMember()> _
Public FirstName As String
<DataMember()> _
Public LastName As String
<DataMember()> _
Public ID As Integer
Public Sub New(ByVal newfName As String, ByVal newLName As String, _
ByVal newID As Integer)
FirstName = newfName
LastName = newLName
ID = newID
End Sub
Private extensionData_Value As ExtensionDataObject
Public Property ExtensionData() As ExtensionDataObject _
Implements IExtensibleDataObject.ExtensionData
Get
Return extensionData_Value
End Get
Set
extensionData_Value = value
End Set
End Property
End Class
NotInheritable Public Class Test
Private Sub New()
End Sub
Public Shared Sub Main()
Try
WriteObject("NetDataContractSerializerExample.xml")
ReadObject("NetDataContractSerializerExample.xml")
Catch serExc As SerializationException
Console.WriteLine("Serialization Failed")
Console.WriteLine(serExc.Message)
Catch exc As Exception
Console.WriteLine("The serialization operation failed: {0} StackTrace: {1}", exc.Message, exc.StackTrace)
Finally
Console.WriteLine("Press <Enter> to exit....")
Console.ReadLine()
End Try
End Sub
Public Shared Sub WriteObject(ByVal fileName As String)
Console.WriteLine("Creating a Person object and serializing it.")
Dim p1 As New Person("Zighetti", "Barbara", 101)
Dim fs As New FileStream(fileName, FileMode.Create)
Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()
ser.WriteObject(writer, p1)
writer.Close()
End Sub
Public Shared Sub ReadObject(ByVal fileName As String)
Console.WriteLine("Deserializing an instance of the object.")
Dim fs As New FileStream(fileName, FileMode.Open)
Dim reader As XmlDictionaryReader = _
XmlDictionaryReader.CreateTextReader(fs, New XmlDictionaryReaderQuotas())
Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()
' Deserialize the data and read it from the instance.
Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
fs.Close()
Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
End Sub
End Class
Observações
Segurança
NetDataContractSerializer é inseguro. Para obter mais informações, consulte o guia de segurança BinaryFormatter.
O NetDataContractSerializer difere do DataContractSerializer de num aspeto importante: o NetDataContractSerializer inclui informação do tipo CLR no XML serializado, enquanto o DataContractSerializer não. Portanto, o NetDataContractSerializer só pode ser usado se tanto as extremidades de serialização como de desserialização partilharem os mesmos tipos de CLR.
O serializador pode serializar tipos aos quais o DataContractAttribute atributo ou SerializableAttribute foi aplicado. Também serializa tipos que implementam ISerializable.
Para mais informações sobre serialização, consulte Serialização e Desserialização.
Incompatibilidade com XElement
A XElement classe é usada para escrever XML. No entanto, não NetDataContractSerializer podem serializar uma instância do tipo. O seguinte código, portanto, falha com a exceção: "O tipo raiz 'System.Xml.Linq.XElement' não é suportado ao nível superior pelo NetDataContractSerializer, pois é IXmlSerializável com IsAny=true e deve escrever todo o seu conteúdo, incluindo o elemento raiz."
FileStream fs = new FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite);
XElement myElement = new XElement("Parent", new XElement("child1", "form"),
new XElement("child2", "base"),
new XElement("child3", "formbase")
);
NetDataContractSerializer dcs = new NetDataContractSerializer();
dcs.WriteObject(fs, myElement);
Dim fs As New FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite)
Dim myElement As New XElement("Parent", New XElement("child1", "form"), _
New XElement("child2", "base"), _
New XElement("child3", "formbase") _
)
Dim ser As New System.Runtime.Serialization. _
NetDataContractSerializer()
ser.WriteObject(fs, myElement)
No entanto, se a XElement for usado como tipo de campo ou propriedade de uma classe, os dados contidos pelo campo ou propriedade são serializados. Isto porque, enquanto membro de uma turma, os dados não são o nível superior da turma.
Construtores
| Name | Description |
|---|---|
| NetDataContractSerializer() |
Inicializa uma nova instância da NetDataContractSerializer classe. |
| NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Inicializa uma nova instância da NetDataContractSerializer classe com os dados de contexto fornecidos; além disso, especifica o número máximo de itens no objeto a serializar, e parâmetros para especificar se dados adicionais são ignorados, o método de carregamento de montagem e um seletor substituto. |
| NetDataContractSerializer(StreamingContext) |
Inicializa uma nova instância da NetDataContractSerializer classe com os dados de contexto de streaming fornecidos. |
| NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Inicializa uma nova instância da NetDataContractSerializer classe com os dados de contexto fornecidos, nome raiz e espaço de nomes; adicionalmente, especifica o número máximo de itens no objeto a serializar, e parâmetros para especificar se dados adicionais são ignorados, o método de carregamento assembly e um seletor substituto. |
| NetDataContractSerializer(String, String) |
Inicializa uma nova instância da NetDataContractSerializer classe com o elemento raiz XML fornecido e o namespace. |
| NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Inicializa uma nova instância da NetDataContractSerializer classe com os dados de contexto fornecidos, nome raiz e espaço de nomes (como XmlDictionaryString parâmetros); adicionalmente, especifica o número máximo de itens no objeto a serializar, e parâmetros para especificar se os dados extra encontrados são ignorados, método de carregamento em assembly e um seletor substituto. |
| NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString) |
Inicializa uma nova instância da NetDataContractSerializer classe com dois parâmetros do tipo XmlDictionaryString que contêm o elemento raiz e o namespace usados para especificar o conteúdo. |
Propriedades
| Name | Description |
|---|---|
| AssemblyFormat |
Obtém um valor que especifica um método para localizar e carregar conjuntos. |
| Binder |
Obtém ou define um objeto que controla o carregamento de classes. |
| Context |
Obtém ou define o objeto que permite a passagem de dados de contexto que são úteis durante a serialização ou desserialização. |
| IgnoreExtensionDataObject |
Obtém um valor que especifica se os dados fornecidos por uma extensão do objeto são ignorados. |
| MaxItemsInObjectGraph |
Obtém o número máximo de itens permitidos no objeto a serializar. |
| SurrogateSelector |
Obtém ou define um objeto que auxilia o formatador ao selecionar um substituto para serialização. |
Métodos
| Name | Description |
|---|---|
| Deserialize(Stream) |
Desserializa um documento ou fluxo XML num objeto. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| IsStartObject(XmlDictionaryReader) |
Determina se o XmlDictionaryReader está posicionado num objeto que pode ser desserializado usando o leitor especificado. |
| IsStartObject(XmlReader) |
Determina se o XmlReader está posicionado num objeto que pode ser desserializado usando o leitor especificado. |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| ReadObject(Stream) |
Lê o fluxo ou documento XML com um Stream e devolve o objeto desserializado. (Herdado de XmlObjectSerializer) |
| ReadObject(XmlDictionaryReader, Boolean) |
Lê o fluxo ou documento XML com um XmlDictionaryReader e devolve o objeto deserializado; verifica também se os dados do objeto correspondem ao nome e ao espaço de nomes usados para criar o serializador. |
| ReadObject(XmlDictionaryReader) |
Lê o documento ou fluxo XML com um XmlDictionaryReader e devolve o objeto deserializado. (Herdado de XmlObjectSerializer) |
| ReadObject(XmlReader, Boolean) |
Lê o fluxo ou documento XML com um XmlDictionaryReader e devolve o objeto deserializado; verifica também se os dados do objeto correspondem ao nome e ao espaço de nomes usados para criar o serializador. |
| ReadObject(XmlReader) |
Lê o fluxo ou documento XML com um XmlDictionaryReader e devolve o objeto deserializado. |
| Serialize(Stream, Object) |
Serializa o grafo objeto especificado usando o escritor especificado. |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |
| WriteEndObject(XmlDictionaryWriter) |
Escreve o elemento XML de encerramento usando um XmlDictionaryWriter. |
| WriteEndObject(XmlWriter) |
Escreve o elemento XML de encerramento usando um XmlWriter. |
| WriteObject(Stream, Object) |
Escreve o conteúdo completo (início, conteúdo e fim) do objeto no documento ou fluxo XML com o especificado Stream. (Herdado de XmlObjectSerializer) |
| WriteObject(XmlDictionaryWriter, Object) |
Escreve o conteúdo completo (início, conteúdo e fim) do objeto no documento ou fluxo XML com o especificado XmlDictionaryWriter. (Herdado de XmlObjectSerializer) |
| WriteObject(XmlWriter, Object) |
Escreve o conteúdo completo (início, conteúdo e fim) do objeto no documento ou fluxo XML com o especificado XmlWriter. |
| WriteObjectContent(XmlDictionaryWriter, Object) |
Escreve o conteúdo XML usando um XmlDictionaryWriter. |
| WriteObjectContent(XmlWriter, Object) |
Escreve o conteúdo XML usando um XmlWriter. |
| WriteStartObject(XmlDictionaryWriter, Object) |
Escreve o elemento XML de abertura usando um XmlDictionaryWriterelemento . |
| WriteStartObject(XmlWriter, Object) |
Escreve o elemento XML de abertura usando um XmlWriterelemento . |