Класс System.Runtime.Serialization.DataContractAttribute

В этой статье приводятся дополнительные замечания к справочной документации по этому API.

Применяйте атрибут DataContractAttribute к типам (классам, структурам или перечислениям), используемым в операциях сериализации и десериализации средством DataContractSerializer. При отправке или получении сообщений с помощью инфраструктуры Windows Communication Foundation (WCF) также следует применять DataContractAttribute к любым классам, которые хранят и управляют данными, отправленными в сообщениях. Дополнительные сведения о контрактах данных см. в разделе "Использование контрактов данных".

Также необходимо применить атрибут DataMemberAttribute ко всем полям, свойствам или событиям, содержащим сериализуемые значения. Применение атрибута DataContractAttribute явно разрешает DataContractSerializer выполнять сериализацию и десериализацию данных.

Внимание

Атрибут DataMemberAttribute можно применять к закрытым полям. Необходимо помнить, что возвращаемые полем данные (даже если поле закрытое) сериализуются и десериализуются, и, следовательно, могут быть просмотрены или перехвачены злоумышленником или процессом.

Дополнительные сведения о контрактах данных см. в разделах, перечисленных в разделе "Использование контрактов данных".

Контракты данных

Контракт данных — это абстрактное описание набора полей с именем и типом данных для каждого поля. Контракт данных существует вне любых реализаций, что делает возможным взаимодействие служб на разных платформах. Поскольку данные, передаваемые между службами, соответствуют одному и тому же контракту, все службы могут обработать данные. Эта обработка также называется слабо связанной системой. Контракт данных похож на интерфейс в том, что контракт указывает, каким образом должны подаваться данные, чтобы они могли быть обработаны приложением. Например, контракт данных может вызвать тип данных "Person", имеющий два текстовых поля "FirstName" и "LastName". Чтобы создать контракт данных, примените атрибут DataContractAttribute к классу и атрибут DataMemberAttribute ко всем полям или свойствам, которые требуется сериализовать. После сериализации данные соответствуют контракту данных, неявно встроенному в этот тип.

Примечание.

Поведение контракта данных при наследовании существенно отличается от поведения реального интерфейса. Интерфейсы наследуются любыми производными типами. Если применить атрибут DataContractAttribute к базовому классу, производные типы не будут наследовать атрибут или поведение. Но если у производного типа есть контракт данных, элементы данных базового класса сериализуются. Однако необходимо применить атрибут DataMemberAttribute к новым членам производного класса, чтобы сделать их сериализуемыми.

Документы схемы XML и средство SvcUtil

При обмене данными с другими службами необходимо описать контракт данных. Чтобы определить контракты данных для текущей версии DataContractSerializer, можно использовать схему XML. (Другие формы метаданных и описания могут использоваться для той же цели.) Чтобы создать xml-схему из приложения, используйте средство служебной программы метаданных ServiceModel (Svcutil.exe) с параметром командной строки /dconly . Если на вход средства передана сборка, по умолчанию средство создает набор схем XML, определяющий все типы контрактов данных этой сборки. И наоборот, можно использовать средство Svcutil.exe для создания определений классов Visual Basic или C#, соответствующих требованиям схем XML, использующих конструкторы, которые могут быть выражены посредством контрактов данных. В этом случае параметр командной строки /dconly не требуется.

Если на вход средства Svcutil.exe передана схема XML, по умолчанию средство создает набор классов. При рассмотрении этих классов можно заметить, что был применен атрибут DataContractAttribute. Эти классы можно использовать для создания нового приложения обработки данных, которыми требуется обмениваться с другими службами.

Вы также можете запустить средство в конечной точке, которая возвращает документ языка описания веб-служб (WSDL), чтобы автоматически создать код и конфигурацию для создания клиента Windows Communication Foundation (WCF). Созданный код включает типы, отмеченные атрибутом DataContractAttribute.

Повторное использование существующих типов

Существует два основных требования контракта данных: наличие постоянного имени и наличие списка элементов. Постоянное имя состоит из универсального кода ресурса (URI) пространства имен и локального имени контракта. По умолчанию при применении DataContractAttribute к классу в качестве локального имени используется имя класса и пространство имен класса (префикс с префиксом) "http://schemas.datacontract.org/2004/07/"в качестве URI пространства имен. Значения по умолчанию можно переопределить, задав свойства Name и Namespace. Можно также изменить пространство имен, применив атрибут ContractNamespaceAttribute к пространству имен. Используйте эту возможность, когда существует тип, обрабатывающий данные необходимым образом, но его пространство имен и имя класса отличаются от контракта данных. Переопределив значения по умолчанию, можно повторно использовать этот существующий тип и обеспечить соответствие сериализованных данных контракту данных.

Примечание.

В любом коде можно использовать слово DataContract вместо длинного DataContractAttribute.

Управление версиями

Контракт данных также может размещать свои более поздние версии. То есть в случае, когда более поздняя версия контракта включает дополнительные данные, эти данные хранятся и возвращаются отправителю без изменений. Для этого реализуйте интерфейс IExtensibleDataObject.

Дополнительные сведения об использовании версий см. в разделе "Управление версиями контракта данных".