JavaScriptTypeResolver Třída

Definice

Obor názvů:: System.Web.Script.Serialization

Sestavení:: System.Web.Extensions.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Poskytuje abstraktní základní třídu pro implementaci vlastního překladače typů.

public ref class JavaScriptTypeResolver abstract

public abstract class JavaScriptTypeResolver

type JavaScriptTypeResolver = class

Public MustInherit Class JavaScriptTypeResolver

Dědičnost: Object
JavaScriptTypeResolver

Odvozené: System.Web.Script.Serialization.SimpleTypeResolver

Příklady

Následující příklad ukazuje, jak vytvořit vlastní JavaScriptTypeResolver a jak jej použít k serializaci nebo deserializaci objektu.

using System;
using System.Linq;
using System.Web.Script.Serialization;

namespace SampleApp
{
   class Program
   {
       static void Main(string[] args)
       {
           // The object array to serialize.
           Person[] people = new Person[]
           {
               new Person()
               {
                   Name = "Kristen Solstad",
                   Age = 15,
                   HomeAddress = new Address()
                   {
                       Street1 = "123 Palm Ave",
                       City = "Some City",
                       StateOrProvince = "ST",
                       Country = "United States",
                       PostalCode = "00000"
                   }
               },
               new Adult()
               {
                   Name = "Alex Johnson",
                   Age = 39,
                   Occupation = "Mechanic",
                   HomeAddress = new Address()
                   {
                       Street1 = "445 Lorry Way",
                       Street2 = "Unit 3A",
                       City = "Some City",
                       Country = "United Kingdom",
                       PostalCode = "AA0 A00"
                   }
               }
           };

           // Serialize the object array, then write it to the console.
           string serializedData = SerializePeopleArray(people);
           Console.WriteLine("Serialized:");
           Console.WriteLine(serializedData);
           Console.WriteLine();

           // Now deserialize the object array.
           Person[] deserializedArray = DeserializePeopleArray(serializedData);
           Console.WriteLine("Deserialized " + deserializedArray.Length + " people.");
           foreach (Person person in deserializedArray)
           {
               Console.WriteLine(person.Name + " (Age " + person.Age + ") [" + person.GetType() + "]");
           }
       }

       static string SerializePeopleArray(Person[] people)
       {
           // The custom type resolver to use.
           // Note: Except for primitives like int and string, *every* type that
           // we might see in the object graph must be listed here.
           CustomTypeResolver resolver = new CustomTypeResolver(
               typeof(Person),
               typeof(Adult),
               typeof(Address));

           // Instantiate the serializer.
           JavaScriptSerializer serializer = new JavaScriptSerializer(resolver);

           // Serialize the object array, then return it.
           string serialized = serializer.Serialize(people);
           return serialized;
       }

       static Person[] DeserializePeopleArray(string serializedData)
       {
           // The custom type resolver to use.
           // Note: This is the same list that was provided to the Serialize routine.
           CustomTypeResolver resolver = new CustomTypeResolver(
               typeof(Person),
               typeof(Adult),
               typeof(Address));

           // Instantiate the serializer.
           JavaScriptSerializer serializer = new JavaScriptSerializer(resolver);

           // Deserialize the object array, then return it.
           Person[] deserialized = serializer.Deserialize<Person[]>(serializedData);
           return deserialized;
       }
   }

   public class Person
   {
       public string Name { get; set; }
       public int Age { get; set; }
       public Address HomeAddress { get; set; }
   }

   public class Adult : Person
   {
       public string Occupation { get; set; }
   }

   public class Address
   {
       public string Street1 { get; set; }
       public string Street2 { get; set; }
       public string City { get; set; }
       public string StateOrProvince { get; set; }
       public string Country { get; set; }
       public string PostalCode { get; set; }
   }

   // A custom JavaScriptTypeResolver that restricts the payload
   // to a set of known good types.
   class CustomTypeResolver : JavaScriptTypeResolver
   {
       private readonly Type[] _allowedTypes;

       public CustomTypeResolver(params Type[] allowedTypes)
       {
           if (allowedTypes == null)
           {
               throw new ArgumentNullException("allowedTypes");
           }

           // Make a copy of the array the caller gave us.
           _allowedTypes = (Type[])allowedTypes.Clone();
       }

       public override Type ResolveType(string id)
       {
           // Iterate over all of the allowed types, looking for a match
           // for the 'id' parameter. Calling Type.GetType(id) is dangerous,
           // so we instead perform a match on the Type.FullName property.
           foreach (Type allowedType in _allowedTypes)
           {
               if (allowedType.FullName == id)
               {
                   return allowedType;
               }
           }

           // The caller provided a type we don't recognize. This could be
           // dangerous, so we'll fail the operation immediately.
           throw new ArgumentException("Unknown type: " + id, "id");
       }

       public override string ResolveTypeId(Type type)
       {
           // Before we serialize data, quickly double-check to make
           // sure we're allowed to deserialize the data. Otherwise it's
           // no good serializing something if we can't deserialize it.
           if (_allowedTypes.Contains(type))
           {
               return type.FullName;
           }

           throw new InvalidOperationException("Cannot serialize an object of type " + type + ". Did you forget to add it to the allow list?");
       }
   }
}

Předchozí aplikace vypíše do konzoly následující výstup, který je formátovaný tak, aby byl čitelný.

Serialized:
[
    {
        "__type": "SampleApp.Person",
        "Name": "Kristen Solstad",
        "Age": 15,
        "HomeAddress": {
            "__type": "SampleApp.Address",
            "Street1": "123 Palm Ave",
            "Street2": null,
            "City": "Some City",
            "StateOrProvince": "ST",
            "Country": "United States",
            "PostalCode": "00000"
        }
    },
    {
        "__type": "SampleApp.Adult",
        "Occupation": "Mechanic",
        "Name": "Alex Johnson",
        "Age": 39,
        "HomeAddress": {
            "__type": "SampleApp.Address",
            "Street1": "445 Lorry Way",
            "Street2": "Unit 3A",
            "City": "Some City",
            "StateOrProvince": null,
            "Country": "United Kingdom",
            "PostalCode": "AA0 A00"
        }
    }
]

Deserialized 2 people.
Kristen Solstad (Age 15) [SampleApp.Person]
Alex Johnson (Age 39) [SampleApp.Adult]

V předchozí ukázce Adult typ podtřídy Person typu typ. Vlastní JavaScriptTypeResolver se používá k zahrnutí informací o typu jako součást vygenerované datové části JSON. To umožňuje omezit polymorfismus při deserializaci datové části JSON zpět do grafu objektu .NET. Datová část může řídit, jestli se má vrátit základní Person instance nebo odvozená Adult instance zpět volajícímu.

Tato ukázka je bezpečná, protože používá allow-list mechanismus k řízení deserializace. Kód:

Inicializuje CustomTypeResolver explicitní seznam povolených typů.
Omezuje proces deserializace pouze na schválený seznam typů. Toto omezení zabraňuje útokům deserializace, kdy vzdálený klient určuje škodlivé v __type datové části JSON a triky serveru do deserializace nebezpečného typu.

I když aplikace očekává Person pouze deserializaci a Adult instance v rámci pole nejvyšší úrovně, je stále nutné přidat Address do seznamu povolených položek:

Serializace objektu Person nebo Adult také serializuje Address jako součást grafu objektu.
Všechny typy, které mohou být přítomné v grafu objektů, musí být v seznamu povolených účtů. Primitivy jako int a string není nutné je zadávat.

Warning

V rámci Type.GetType(id) metody nevolejteResolveType. To by mohlo do aplikace zavést zabezpečení vunerability. Místo toho iterujte seznam povolených typů a porovnejte jejich Type.FullName vlastnost s příchozím id, jak je znázorněno v předchozím vzorku.

Poznámky

Třída JavaScriptTypeResolver poskytuje služby pro:

Převod informací o spravovaném typu na řetězcovou hodnotu prostřednictvím ResolveTypeId metody.
Přeloží hodnotu řetězce zpět na příslušný spravovaný typ prostřednictvím ResolveType metody.

JavaScriptSerializer Když objekt serializuje vlastní typy, může volitelně zahrnout do serializovaného javascriptového objektového zápisu (JSON) hodnotu, která obsahuje informace o typu. Během deserializace pak může odkazovat na tuto řetězcovou hodnotu a určit odpovídající spravovaný typ, JavaScriptSerializer na který se řetězec JSON převede.

Pokud do instance zadáte překladač JavaScriptSerializer typů, serializátor použije ResolveTypeId metody a ResolveType metody k mapování mezi spravovaným typem a řetězcovou hodnotou během procesu serializace a deserializace.

Třída JavaScriptTypeResolver je základní třídou třídy SimpleTypeResolver , která poskytuje implementaci překladače typu, který používá kvalifikovaný název sestavení spravovaného typu.

Note

Při použití objektu JavaScriptTypeResolverjson obsahuje výsledná datová část JSON speciální __type vlastnost. Tato vlastnost zahrnuje úplný název typu, včetně oboru názvů, cílového typu. Před použitím vlastního překladače ověřte, že úplný název cílového typu neobsahuje citlivé ani privilegované informace.

Poznámky pro implementátory

Při implementaci překladače typů musí řetězec vrácený metodou ResolveTypeId(Type) mapovat zpět na stejný spravovaný typ při předání řetězcové hodnoty metodě ResolveType(String) .

Konstruktory

Name	Description
JavaScriptTypeResolver()	Inicializuje novou instanci JavaScriptTypeResolver třídy.

Metody

Name	Description
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ResolveType(String)	Při přepsání v odvozené třídě vrátí Type objekt, který je přidružen k zadanému názvu typu.
ResolveTypeId(Type)	Při přepsání v odvozené třídě vrátí název typu pro zadaný Type objekt.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Platí pro

Váš názor

Byla tato stránka užitečná?