Freigeben über

Eigenständige JSON-Serialisierung mit DataContractJsonSerializer

  • Artikel

Hinweis

In diesem Artikel geht es um DataContractJsonSerializer. Für die meisten Szenarien, bei denen es um die Serialisierung und Deserialisierung von JSON geht, empfehlen wir die APIs im System.Text.Json-Namespace.

JSON (JavaScript Object Notation) ist ein Datenformat, das speziell zur Verwendung von JavaScript-Code entworfen wurde, der auf Webseiten innerhalb des Browsers ausgeführt wird. Dies ist das Standarddatenformat für ASP.NET-AJAX-Dienste, die in Windows Communication Foundation (WCF) erstellt wurden.

Dieses Format kann auch für AJAX-Dienste verwendet werden, die nicht in ASP.NET integriert sind. In diesem Fall ist zwar XML der Standard, jedoch kann JSON gewählt werden.

Und wenn Sie schließlich JSON-Unterstützung benötigen, aber keinen AJAX-Dienst erstellen, ermöglicht Ihnen der DataContractJsonSerializer, .NET-Objekte direkt in JSON-Daten zu serialisieren und diese Daten wieder in Instanzen von .NET-Typen zu deserialisieren. Eine Beschreibung zur Vorgehensweise finden Sie unter Gewusst wie: Serialisieren und Deserialisieren von JSON-Daten.

Bei der Arbeit mit JSON werden mit wenigen Ausnahmen dieselben .NET-Typen unterstützt, die auch vom DataContractSerializer unterstützt werden. Eine Liste der unterstützten Typen finden Sie unter Vom Datenvertragsserialisierer unterstützte Typen. Dazu gehören die meisten primitiven Typen, die meisten Array- und Auflistungstypen sowie die komplexen Typen, die das DataContractAttribute und das DataMemberAttribute verwenden.

Zuordnen von .NET-Typen zu JSON-Typen

Die folgende Tabelle zeigt die Entsprechungen zwischen .NET-Typen und JSON/JavaScript-Typen, die für die Zuordnung während der Serialisierung und Deserialisierung gelten.

.NET-Typen JSON/JavaScript Hinweise
Alle numerischen Typen, z. B. Int32, Decimal oder Double Number Spezielle Werte, z. B. Double.NaN, Double.PositiveInfinity und Double.NegativeInfinity, werden nicht unterstützt und führen zu ungültigem JSON-Code.
Enum Number Siehe hierzu „Enumerationen und JSON“ weiter unten in diesem Artikel.
Boolean Boolean
String, Char String
TimeSpan, Guid, Uri String Das Format dieser Typen ist in JSON das gleiche wie in XML (insbesondere der Zeitbereich im ISO 8601-Zeitformat, GUID im Format „12345678-ABCD-ABCD-ABCD-1234567890AB“ und URI in seiner natürlichen Form als Zeichenfolge, z. B. „"http://www.example.com"“). Genaue Informationen finden Sie in der Referenz zum Datenvertragsschema.
XmlQualifiedName String Das Format ist "name:namespace" (sämtliche Zeichen vor dem ersten Doppelpunkt bilden den Namen). Der Name oder der Namespace kann fehlen. Wenn kein Namespace angegeben wird, kann auch der Doppelpunkt weggelassen werden.
Array vom Typ Byte Array von Zahlen Jede Zahl stellt den Wert eines Bytes dar.
DateTime DateTime oder Zeichenfolge Siehe „Datums-/Uhrzeitangaben und JSON“ weiter unten in diesem Artikel.
DateTimeOffset Komplexer Typ Siehe „Datums-/Uhrzeitangaben und JSON“ weiter unten in diesem Artikel.
XML- und ADO.NET-Typen (XmlElement,

XElement. Arrays von XmlNode,

ISerializable,

DataSet).		 String Siehe Abschnitt „XML-Typen und JSON“ in diesem Artikel.
DBNull Leerer komplexer Typ --
Auflistungen, Wörterbücher und Arrays Array Siehe den Abschnitt "Auflistungen, Wörterbücher und Arrays" in diesem Thema.
Komplexe Typen (mit angewendetem DataContractAttribute oder SerializableAttribute) Komplexer Typ Datenmember werden Member des komplexen JavaScript-Typs.
Komplexe Typen (die die ISerializable-Schnittstelle implementieren) Komplexer Typ Wie bei anderen komplexen Typen, allerdings werden einige ISerializable-Typen nicht unterstützt – siehe ISerializable-Unterstützung.
Null-Wert für jeden Typ Null Typen, die NULL-Werte zulassen, werden ebenfalls unterstützt und JSON-Typen auf die gleiche Weise zugeordnet wie Non-Nullable-Typen.

Enumerationen und JSON

Enumerationsmemberwerte werden in JSON als Zahlen behandelt. Dies unterscheidet sich von ihrer Behandlung in Datenverträgen, in die sie als Membernamen eingefügt werden. Weitere Informationen zur Datenvertragsbehandlung finden Sie unter Enumerationstypen in Datenverträgen.

  • Wenn beispielsweise public enum Color {red, green, blue, yellow, pink} gegeben ist, ergibt die Serialisierung von yellow die Zahl 3 und nicht die Zeichenfolge "yellow".

  • Alle enum-Member sind serialisierbar. Die EnumMemberAttribute-Klasse und die NonSerializedAttribute-Attribute werden ignoriert, wenn sie verwendet werden.

  • Es ist möglich, einen nicht vorhandenen enum-Wert zu deserialisieren. Der Wert 87 kann z. B. in den vorherigen Farbenumerationswert deserialisiert werden, auch wenn kein entsprechender Farbname definiert ist.

  • Eine enum aus Flags stellt keinen Sonderfall dar und wird wie jede andere enum behandelt.

Datums-/Uhrzeitangaben und JSON

Das JSON-Format unterstützt Datums- und Zeitangaben nicht direkt. Jedoch werden sie sehr häufig verwendet, und ASP.NET AJAX bietet eine spezielle Unterstützung dieser Typen. Werden ASP.NET AJAX-Proxys verwendet, entspricht der DateTime-Typ in .NET vollständig dem DateTime-Typ in JavaScript.

  • Wird ASP.NET nicht verwendet, wird ein DateTime-Typ in JSON durch ein spezielles Zeichenfolgenformat dargestellt, das im Abschnitt "Weitere Informationen" in diesem Thema beschrieben wird.

  • DateTimeOffset wird in JSON als komplexer Typ dargestellt: {"DateTime":dateTime,"OffsetMinutes":offsetMinutes}. Der offsetMinutes-Member gibt den mit der Position des Ereignisses von Interesse verbundenen Ortszeitoffset zur GMT (Greenwich Mean Time) an. GMT wird jetzt auch als UTC (Coordinated Universal Time) bezeichnet. Der dateTime-Member gibt den Zeitpunkt an, zu dem das betreffende Ereignis eingetreten ist (er wird wieder in einen DateTime-Typ in JavaScript umgewandelt, wenn ASP.NET AJAX verwendet wird; andernfalls wird er in eine Zeichenfolge umgewandelt). Bei der Serialisierung wird der dateTime-Member immer in GMT serialisiert. Wenn beispielsweise die Uhrzeit 3:00 AM in der Zeitzone von New York beschrieben wird, dann enthält dateTime die Zeitangabe "8:00 AM" und offsetMinutes den Wert "300" (minus 300 Minuten oder 5 Stunden gegenüber GMT).

    Hinweis

    Werden die Objekte DateTime und DateTimeOffset zu JSON serialisiert, behalten sie die Informationen nur mit Millisekundengenauigkeit bei. Werte, die kleiner als Millisekunden (Mikro-/Nanosekunden) sind, gehen bei der Serialisierung verloren.

XML-Typen und JSON

XML-Typen werden zu JSON-Zeichenfolgen.

  • Wenn beispielsweise der Datenmember „q“ des Typs XElement den Wert <abc/> enthält, lautet die JSON-Zeichenfolge {"q":"<abc/>"}.

  • Es gibt einige spezielle Regeln, die festlegen, wie XML eingebunden wird. Nähere Informationen dazu finden Sie im Abschnitt „Weitere Informationen“ weiter unten in diesem Artikel.

  • Wenn Sie mit ASP.NET AJAX arbeiten und in JavaScript keine Zeichenfolgen, sondern XML DOM verwenden möchten, legen Sie die ResponseFormat-Eigenschaft für WebGetAttribute oder die ResponseFormat-Eigenschaft für WebInvokeAttribute auf XML fest.

Auflistungen, Wörterbücher und Arrays

Alle Auflistungen, Wörterbücher und Arrays werden in JSON als Arrays dargestellt.

  • Jede Anpassung, in der das CollectionDataContractAttribute verwendet wird, wird in der JSON-Darstellung ignoriert.

  • Wörterbücher stellen keine Möglichkeit dar, JSON-Daten direkt zu bearbeiten. „Dictionary<string,object>“ wird in WCF möglicherweise nicht auf die gleiche Weise unterstützt, wie Sie es von der Arbeit mit anderen JSON-Technologien kennen. Wird beispielsweise in einem Wörterbuch "abc" dem Wert "xyz" und "def" dem Wert 42 zugeordnet, dann lautet die JSON-Darstellung nicht {"abc":"xyz","def":42}, sondern [{"Key":"abc","Value":"xyz"},{"Key":"def","Value":42}].

  • Wenn Sie direkt mit JSON arbeiten möchten (also ohne vorher definierten strengen Vertrag auf Schlüssel und Werte dynamisch zugreifen möchten), stehen Ihnen mehrere Optionen zur Verfügung:

    • Erwägen Sie die Verwendung des Beispiels zur schwach typisierten JSON-Serialisierung (AJAX).

    • Verwenden Sie die ISerializable-Schnittstelle und Deserialisierungskonstruktoren. Diese beiden Mechanismen ermöglichen es Ihnen, bei der Serialisierung und der Deserialisierung auf JSON-Schlüssel/Wert-Paare zuzugreifen, was jedoch in teilweise vertrauenswürdigen Szenarien nicht möglich ist.

    • Ziehen Sie eine Zuordnung zwischen JSON und XML in Erwägung, anstatt ein Serialisierungsmodul zu verwenden.

    • Polymorphie im Kontext der Serialisierung bezieht sich auf die Fähigkeit, einen abgeleiteten Typ dort zu serialisieren, wo sein Basistyp erwartet wird. Es gelten spezielle JSON-spezifische Regeln für die polymorphe Verwendung von Auflistungen (beispielsweise die Zuweisung einer Auflistung zu einem Object. Dieser Punkt wird im Abschnitt „Weitere Informationen“ weiter unten in diesem Artikel näher erläutert.

Zusätzliche Details

Reihenfolge der Datenmember

Die Reihenfolge der Datenmember ist bei Verwendung von JSON nicht von Bedeutung. Insbesondere gilt: Auch wenn Order festgelegt wird, können die JSON-Daten immer noch in jeder beliebigen Reihenfolge deserialisiert werden.

JSON-Typen

Der JSON-Typ muss bei der Deserialisierung nicht mit der vorangehenden Tabelle übereinstimmen. Beispielsweise wird ein Wert vom Typ Int normalerweise einer JSON-Zahl zugeordnet, aber er kann auch aus einer JSON-Zeichenfolge deserialisiert werden, sofern diese Zeichenfolge eine gültige Zahl enthält. Daher ist sowohl {"q":42} als auch {"q":"42"} zulässig, wenn ein Int-Datenmember namens "q" vorhanden ist.

Polymorphie

Polymorphe Serialisierung besteht aus der Fähigkeit, einen abgeleiteten Typ zu serialisieren, wo sein Basistyp erwartet wird. Dies wird von WCF für die JSON-Serialisierung auf ähnliche Weise wie für die XML-Serialisierung unterstützt. Sie können zum Beispiel MyDerivedType serialisieren, wo MyBaseType erwartet wird, oder Int serialisieren, wo Object erwartet wird.

Typinformationen gehen möglicherweise verloren, wenn ein abgeleiteter Typ deserialisiert wird, wo der Basistyp erwartet wird, es sei denn, Sie deserialisieren einen komplexen Typ. Wenn z. B. ein Uri serialisiert wird, wo ein Object erwartet wird, ergibt sich daraus eine JSON-Zeichenfolge. Wenn diese Zeichenfolge dann wieder in Object zurück deserialisiert wird, wird ein .NET String zurückgegeben. Das Deserialisierungsprogramm weiß nicht, dass die Zeichenfolge ursprünglich den Typ Uri hatte. Allgemein gilt: Wird ein Object erwartet, werden alle JSON-Zeichenfolgen als .NET-Zeichenfolgen und alle JSON-Arrays, die zur Serialisierung von .NET-Auflistungen, -Wörterbüchern und -Arrays verwendet wurden, als .NET Array des Typs Object deserialisiert, unabhängig davon, welchen ursprünglichen Typ sie hatten. Der JSON-Typ boolean wird dem .NET-Typ Boolean zugeordnet. Wenn jedoch ein Object erwartet wird, dann werden JSON-Zahlen in einen der .NET-Typen Int32, Decimal oder Double serialisiert, wobei automatisch der am besten geeignete Typ ausgewählt wird.

Beim Deserialisieren in einen Schnittstellentyp, deserialisiert der DataContractJsonSerializer die Daten so, als wäre ein Objekt als Typ deklariert.

Wenn Sie mit Ihren eigenen Basistyp und abgeleiteten Typen arbeiten, ist normalerweise die Verwendung von KnownTypeAttribute, ServiceKnownTypeAttribute oder eines äquivalenten Mechanismus erforderlich. Wenn beispielsweise ein Vorgang den Rückgabewert Animal aufweist und tatsächlich eine Instanz von Cat (abgeleitet von Animal) zurückgibt, sollten Sie entweder KnownTypeAttribute auf den Typ Animal oder ServiceKnownTypeAttribute auf den Vorgang anwenden und den Typ Cat in diesen Attributen angeben. Weitere Informationen finden Sie unter Bekannte Typen in Datenverträgen.

Weitere Informationen zur polymorphen Serialisierung und den Einschränkungen, die Sie bei der Verwendung beachten müssen, finden Sie im Abschnitt „Weitere Informationen“ weiter unten in diesem Artikel.

Versionsverwaltung

Die Datenvertragsversionsfunktionen werden einschließlich der IExtensibleDataObject-Schnittstelle in JSON vollständig unterstützt. Darüber hinaus ist es in den meisten Fällen möglich, einen Typ in ein Format (beispielsweise XML) zu deserialisieren, es dann in ein anderes Format (beispielsweise JSON) zu serialisieren und die Daten in IExtensibleDataObject beizubehalten. Weitere Informationen finden Sie unter Aufwärtskompatible Datenverträge. Denken Sie daran, dass JSON ungeordnet ist und daher alle Reihenfolgeninformationen verloren gehen. .JSON unterstützt auch keine mehrfachen Schlüssel/Wert-Paare mit dem gleichen Schlüsselnamen. Und schließlich sind alle Vorgänge mit IExtensibleDataObject grundsätzlich polymorph. Das bedeutet, dass ihr abgeleiteter Typ Object zugewiesen ist, dem Basistyp aller Typen.

JSON in URLs

Bei Verwendung von ASP.NET AJAX-Endpunkten mit dem HTTP-GET-Verb (wobei das WebGetAttribute-Attribut verwendet wird) werden eingehende Parameter in der Anforderungs-URL statt im Nachrichtentext angegeben. JSON wird auch in der Anforderungs-URL unterstützt. Wenn daher ein Vorgang vorliegt, der einen Int-Wert namens „number“ und einen komplexen Person-Typ namens „p“ akzeptiert, dann kann die URL in etwa wie folgt aussehen:

http://example.com/myservice.svc/MyOperation?number=7&p={"name":"John","age":42}

Wenn Sie ein ASP.NET AJAX Script-Manager-Steuerelement und einen Proxy für den Aufruf des Diensts verwenden, wird diese URL automatisch vom Proxy erstellt und nicht erkannt. JSON kann nicht in URLs auf Nicht-ASP.NET AJAX-Endpunkten verwendet werden.

Weiterführende Informationen

ISerializable-Unterstützung

Unterstützte und nicht unterstützte ISerializable-Typen

Im Allgemeinen werden Typen, die die ISerializable-Schnittstelle implementieren, bei der Serialisierung oder Deserialisierung von JSON vollständig unterstützt. Jedoch sind manche dieser Typen (einschließlich einiger .NET Framework-Typen) so implementiert, dass die JSON-spezifischen Serialisierungseigenheiten dazu führen, dass diese Typen nicht korrekt deserialisiert werden:

  • Mit ISerializable ist der Typ einzelner Datenmember nicht im Voraus bekannt. Dies führt zu einer polymorphen Situation ähnlich der Deserialisierung von Typen in ein Objekt. Wie bereits erwähnt, führt dies in JSON möglicherweise zum Verlust der Typinformationen. Ein Typ z. B., der eine enum in seiner ISerializable-Implementierung serialisiert und versucht, den erhaltenen Wert direkt wieder zurück in eine enum zu deserialisieren, wird ohne die korrekten Umwandlungen fehlschlagen, weil eine enum in JSON als Zahl serialisiert wird und JSON-Zahlen in die integrierten numerischen .NET-Typen (Int32, Decimal oder Double) deserialisiert werden. Deshalb geht die Tatsache, dass die verwendete Zahl ein enum-Wert war, verloren.

  • Ein ISerializable-Typ, der in seinem Deserialisierungskonstruktor von einer bestimmten Reihenfolge der Deserialisierung abhängt, wird bei der Deserialisierung mancher JSON-Daten möglicherweise ebenfalls fehlschlagen, weil die meisten JSON-Serialisierungsprogramme keine bestimmte Reihenfolge gewährleisten.

Factorytypen

Während die IObjectReference-Schnittstelle allgemein in JSON unterstützt wird, werden Typen, die die Funktion „Factorytyp“ benötigen (die Rückgabe eines anderen Typs von GetRealObject(StreamingContext) als den Typ, der die Schnittstelle implementiert) nicht unterstützt.

DateTime-Übertragungsformat

DateTime-Werte werden als JSON-Zeichenfolgen im Format "/Date(700000+0500)/" dargestellt, wobei die erste Zahl (700000 in dem angeführten Beispiel) die Anzahl der seit Mitternacht des 1. Januar 1970 in der GMT-Zeitzone verstrichenen Millisekunden (ohne Berücksichtigung der Sommerzeit) angibt. Die Zahl kann negativ sein und gibt dann einen früheren Zeitpunkt an. Der im Beispiel als „+0500“ angegebene Teil ist optional und legt fest, dass die Zeitangabe als Local zu verstehen ist, also bei der Deserialisierung in eine lokale Zeitzone konvertiert werden muss. Fehlt dieser Teil, wird die Zeitangabe als Utc deserialisiert. Die tatsächliche Zahl ("0500" in diesem Beispiel) und ihr Vorzeichen (+ oder -) werden ignoriert.

Bei der Serialisierung werden DateTime-, Local- und Unspecified-Zeitangaben mit einem Offset und Utc-Zeitangaben ohne Offset geschrieben.

Im JavaScript-Code eines ASP.NET AJAX-Clients werden solche Zeichenfolgen automatisch in DateTime-Instanzen für JavaScript konvertiert. Andere Zeichenfolgen ähnlicher Form, die aber nicht vom .NET-Typ DateTime sind, werden ebenfalls konvertiert.

Die Konvertierung wird nur dann vorgenommen, wenn die Schrägstriche (/) mit Escapezeichen versehen sind (also die JSON-Zeichenfolge wie „\/Date(700000+0500)\/“ aussieht). Aus diesem Grund versieht der JSON-Encoder von WCF (aktiviert durch WebHttpBinding) Schrägstriche immer mit Escapezeichen.

XML in JSON-Zeichenfolgen

XmlElement

Der Typ XmlElement wird ohne Einbindung serialisiert wie er ist. Wenn beispielsweise der Datenmember „x“ des Typs XmlElement den Wert <abc/> enthält, wird er folgendermaßen dargestellt:

{"x":"<abc/>"}

XmlNode-Arrays

Array-Objekte des Typs XmlNode werden in ein Element namens ArrayOfXmlNode im Standardnamespace des Datenvertrags für den Typ eingebunden. Ist "x" ein Array, das den Attributknoten "N" im Namespace "ns" enthält, der seinerseits "value" und den leeren Elementknoten "M" enthält, dann ergibt sich folgende Darstellung.

{"x":"<ArrayOfXmlNode xmlns=\"http://schemas.datacontract.org/2004/07/System.Xml\" a:N=\"value\" xmlns:a=\"ns\"><M/></ArrayOfXmlNode>"}

Attribute in einem leeren Namespace werden am Anfang von XmlNode-Arrays (vor anderen Elementen) nicht unterstützt.

IXmlSerializable-Typen, einschließlich XElement- und DataSet-Typen

ISerializable-Typen teilen sich in "Inhaltstypen", "DataSet-Typen" und "Elementtypen". Definitionen dieser Typen finden Sie unter XML- und ADO.NET-Typen in Datenverträgen.

"Inhalts-" und "DataSet-Typen" werden ähnlich den Array-Objekten von XmlNodeserialisiert, die im vorherigen Abschnitt erläutert wurden. Sie werden in ein Element eingebunden, dessen Name und Namespace dem Datenvertragsnamen und dem Namespace des jeweiligen Typs entsprechen.

„Elementtypen“ wie XElement werden unverändert serialisiert, ähnlich wie das bereits in diesem Thema erläuterte XmlElement.

Polymorphie

Bewahren von Typinformationen

Wie schon vorher festgestellt, wird Polymorphie in JSON mit einigen Einschränkungen unterstützt. JavaScript ist eine schwach typisierte Sprache, und Typidentität stellt normalerweise kein Problem dar. Wird jedoch JSON verwendet, um zwischen einem stark typisierten System (.NET) und einem schwach typisierten System (JavaScript) zu kommunizieren, ist es sinnvoll, die Typidentität beizubehalten. Die Typen mit den Datenvertragsnamen "Square" und "Circle" sind beispielsweise von einem Typ mit dem Datenvertragsnamen "Shape" abgeleitet. Wenn "Circle" von .NET zu JavaScript gesendet und später wieder an eine .NET-Methode übergeben wird, die "Shape" erwartet, ist es für .NET sinnvoll zu wissen, dass das fragliche Objekt ursprünglich ein "Circle" war. Andernfalls gehen eventuell alle für den abgeleiteten Typ spezifischen Informationen (z. B. der Datenmember "radius" von "Circle") verloren.

Um bei der Serialisierung komplexer Typen zu JSON die Typidentität zu bewahren, kann ein "Typhinweis" hinzugefügt werden, den das Deserialisierungsprogramm erkennen und auf den es entsprechend reagieren kann. Der "Typhinweis" ist ein JSON-Schlüssel-Wert-Paar mit dem Schlüsselnamen "__type" (zwei Unterstriche gefolgt von "type"). Der Wert ist eine JSON-Zeichenfolge der Form "DataContractName:DataContractNamespace" (alles vor dem ersten Doppelpunkt bildet den Namen). Bei dem schon früher verwendeten Beispiel kann "Circle" wie folgt serialisiert werden.

{"__type":"Circle:http://example.com/myNamespace","x":50,"y":70,"radius":10}

Der Typhinweis ist dem von der standardmäßigen XML-Schemainstanz definierten und bei der Serialisierung oder Deserialisierung verwendeten xsi:type-Attribut sehr ähnlich.

Datenmember mit dem Namen "__type" sind wegen eines möglichen Konflikts mit dem Typhinweis nicht zulässig.

Reduzieren der Größe von Typhinweisen

Um die Größe von JSON-Nachrichten zu verringern, wird das standardmäßige Namespacepräfix für Datenverträge (http://schemas.datacontract.org/2004/07/) durch das Zeichen „#“ ersetzt. (Damit diese Ersetzung wieder rückgängig gemacht werden kann, gilt eine Regel für die Verwendung von Escapezeichen: Beginnt der Namespace mit den Zeichen "#" oder "\", werden diese Zeichen zusammen mit einem "\"-Zeichen angehängt). Wenn also „Circle“ ein Typ im .NET-Namespace „MyApp.Shapes“ ist, lautet der zugehörige Standardnamespace für Datenverträge http://schemas.datacontract.org/2004/07/MyApp. Shapes und die JSON-Darstellung lautet wie folgt.

{"__type":"Circle:#MyApp.Shapes","x":50,"y":70,"radius":10}

Bei der Deserialisierung werden sowohl die verkürzten (#MyApp.Shapes) als auch die vollständigen (http://schemas.datacontract.org/2004/07/MyApp.Shapes) Namen erkannt.

Position des Typhinweises in JSON-Objekten

Beachten Sie, dass in der JSON-Darstellung der Typhinweis das erste Element sein muss. Dies ist der einzige Fall, wo die Reihenfolge von Schlüssel/Wert-Paaren bei der JSON-Verarbeitung wichtig ist. Folgendes ist beispielsweise keine gültige Angabe des Typhinweises.

{"x":50,"y":70,"radius":10,"__type":"Circle:#MyApp.Shapes"}

Sowohl der von WCF verwendete DataContractJsonSerializer als auch die ASP.NET AJAX-Clientseiten geben zuerst den Typhinweis aus.

Typhinweise gelten nur für komplexe Typen

Es gibt keine Möglichkeit, einen Typhinweis für nicht-komplexe Typen auszugeben. Hat z. B. ein Vorgang einen Object-Rückgabetyp, gibt aber einen Circle-Typ zurück, entspricht die JSON-Darstellung wahrscheinlich der vorher gezeigten, und die Typinformationen werden beibehalten. Wird jedoch ein URI-Typ zurückgegeben, ist die JSON-Darstellung eine Zeichenfolge, und die Tatsache, dass diese Zeichenfolge einen URI-Typ darstellt, geht verloren. Dies gilt nicht nur für primitive Typen, sondern auch für Auflistungen und Arrays.

Wann Typhinweise ausgegeben werden

Typhinweise können die Nachrichtengröße beträchtlich erhöhen. Dieses Problem kann durch die Verwendung kürzerer Datenvertragsnamespaces (wenn möglich) vermieden werden. Deshalb bestimmen die folgenden Regeln, ob Typhinweise ausgegeben werden:

  • Bei Verwendung von ASP.NET AJAX werden Typhinweise nach Möglichkeit ausgegeben, auch wenn keine Zuweisung von Basistypen zu abgeleiteten Typen besteht. Dies gilt auch, wenn beispielsweise ein Circle einem Circle zugewiesen ist. (Dies ist erforderlich, um den Prozess des Aufrufs aus der schwach typisierten JSON-Umgebung in die stark typisierte .NET-Umgebung ohne einen unerwarteten Verlust von Informationen zu ermöglichen.)

  • Bei Verwendung von AJAX-Diensten ohne ASP.NET-Integration werden Typhinweise nur dann ausgegeben, wenn es eine Zuweisung von Basistypen zu abgeleiteten Typen gibt – also wenn Circle einem Shape-Typ oder einem Object zugewiesen ist, nicht aber, wenn Circle einem Circle zugewiesen ist. Dies stellt die zur korrekten Implementierung eines JavaScript-Clients notwendigen Mindestinformationen bereit und verbessert so die Leistung, schützt jedoch nicht vor dem Verlust von Typinformationen in nicht ordnungsgemäß implementierten Clients. Vermeiden Sie Zuweisungen von Basistypen zu abgeleiteten Typen auf dem Server, damit Sie diese Probleme nicht beim Client behandeln müssen.

  • Wenn Sie den DataContractSerializer-Typ verwenden, ermöglicht Ihnen der alwaysEmitTypeInformation-Parameter des Konstruktors, zwischen den beiden genannten Möglichkeiten zu wählen, wobei der Standard auf "false" festgelegt ist (Typhinweise nur wenn erforderlich ausgeben).

Doppelte Datenelementnamen

Im JSON-Objekt sind Informationen des abgeleiteten Typs zusammen mit denen des Basistyps in beliebiger Reihenfolge vorhanden. Zum Beispiel kann Shape wie folgt dargestellt sein.

{"__type":"Shape:#MyApp.Shapes","x":50,"y":70}

Circle wird dagegen möglicherweise wie folgt dargestellt wird.

{"__type":"Circle:#MyApp.Shapes","x":50, "radius":10,"y":70}

Wenn der Basistyp Shape auch einen Datenmember mit dem Namen radius enthält, führt dies zu einer Kollision sowohl bei der Serialisierung (weil JSON-Objekte keine sich wiederholenden Schlüsselnamen enthalten können) als auch bei der Deserialisierung (weil unklar ist, ob sich „radius“ auf Shape.radius oder Circle.radius bezieht). Daher ist das Konzept des "Verbergens von Eigenschaften" (Datenmember mit gleichen Namen in der Basisklassen und in abgeleiteten Klassen), das in Datenvertragsklassen generell nicht empfohlen wird, im Fall von JSON sogar unzulässig.

Polymorphie und IXmlSerializable-Typen

IXmlSerializable-Typen können polymorph einander zugewiesen werden, solange die Anforderungen für bekannte Typen entsprechend den üblichen Datenvertragsregeln eingehalten werden. Die Serialisierung eines IXmlSerializable-Typs statt eines Object-Typs führt zu einem Verlust von Typinformationen, da das Ergebnis eine JSON-Zeichenfolge ist.

Polymorphie und bestimmte Schnittstellentypen

Es ist nicht zulässig, einen Auflistungstyp oder einen Typ, der IXmlSerializable implementiert, zu serialisieren, wenn ein Nicht-Auflistungstyp erwartet wird, der nicht IXmlSerializable ist (ausgenommen Object). Ein Beispiel wäre eine benutzerdefinierte Schnittstelle namens IMyInterface und ein Typ MyType, die beide IEnumerable<T> des Typs int und IMyInterface implementieren. Es ist unzulässig, MyType aus einem Vorgang zurückzugeben, dessen Rückgabetyp IMyInterface lautet. Der Grund dafür ist, dass MyType als ein JSON-Array serialisiert werden muss und einen Typhinweis erfordert. Wie bereits erwähnt, können Sie bei einem Array keinen Typhinweis hinzufügen, dies ist nur bei komplexen Typen möglich.

Bekannte Typen und Konfiguration

Der gesamte vom DataContractSerializer verwendete Mechanismus bekannter Typen wird auf gleiche Weise auch vom DataContractJsonSerializer unterstützt. Beide Serialisierungsmodule lesen dasselbe Konfigurationselement, <dataContractSerializer> in <system.runtime.serialization>, um bekannte Typen zu ermitteln, die über eine Konfigurationsdatei hinzugefügt wurden.

Objekten zugewiesene Auflistungen

Objekten zugewiesene Auflistungen werden so serialisiert als handele es sich um Auflistungen, die IEnumerable<T> implementieren: als JSON-Array, bei dem jeder Eintrag einen Typhinweis besitzt, als wäre er ein komplexer Typ. Ein List<T> des Typs Shape, der Object zugewiesen ist, sieht zum Beispiel wie folgt aus:

[{"__type":"Shape:#MyApp.Shapes","x":50,"y":70},
{"__type":"Shape:#MyApp.Shapes","x":58,"y":73},
{"__type":"Shape:#MyApp.Shapes","x":41,"y":32}]

Wenn es wieder in ein Object deserialisiert wird:

  • Shape muss in der Liste bekannter Typen enthalten sein. Das Vorhandensein von List<T> des Typs Shape in bekannten Typen hat keine Auswirkungen. Beachten Sie, dass Sie in diesem Fall Shape bei der Serialisierung nicht in die bekannten Typen aufnehmen müssen, da dies automatisch geschieht.

  • Die Auflistung wird als Array des Typs Object deserialisiert, das Shape-Instanzen enthält.

Abgeleitete Auflistungen, die Basisauflistungen zugewiesen sind

Wenn eine abgeleitete Auflistung einer Basisauflistung zugewiesen ist, wird die Auflistung normalerweise so serialisiert, als wäre sie eine Auflistung des Basistyps. Kann jedoch der Elementtyp der abgeleiteten Auflistung nicht dem Elementtyp der Basisauflistung zugewiesen werden, wird eine Ausnahme ausgelöst.

Typhinweise und Wörterbücher

Wenn ein Wörterbuch einem Object zugewiesen ist, wird jeder Schlüssel- und Werteintrag des Wörterbuchs so behandelt, als wäre er Object zugewiesen, und erhält einen Typhinweis.

Bei der Serialisierung von Wörterbuchtypen, wird das JSON-Objekt, das die Member "Key" und "Value" enthält, von der alwaysEmitTypeInformation-Einstellung nicht betroffen und erhält nur dann einen Typhinweis, wenn die oben genannten Auflistungsregeln dies erfordern.

Gültige JSON-Schlüsselnamen

Das Serialisierungsprogramm codiert Schlüsselnamen in XML, die keine gültigen XML-Namen sind. Ein Datenmember namens "123" erhält beispielsweise den codierten Namen "_x0031__x0032__x0033_", weil "123" ein ungültiger XML-Elementname ist (er beginnt mit einer Ziffer). Eine ähnliche Situation tritt möglicherweise bei einigen internationalen Zeichensätzen auf, deren Verwendung ungültige XML-Namen ergibt. Eine Erklärung dieser Auswirkung von XML auf die JSON-Verarbeitung finden Sie unter Zuordnung zwischen JSON und XML.

Weitere Informationen