Пример строго типизированных расширений

В примере StronglyTypedExtensions для целей примера используется SyndicationFeed класс. Однако шаблоны, показанные в этом примере, можно использовать со всеми классами Синдикации, поддерживающими данные расширения.

Объектная модель Синдикации (SyndicationFeed, SyndicationItem и связанные классы) поддерживает свободно типизированный доступ к данным расширения через свойства AttributeExtensions и ElementExtensions. В этом примере показано, как обеспечить строго типизированный доступ к данным расширения путем реализации настраиваемых производных классов SyndicationFeed и SyndicationItem, которые предоставляют доступ к задаваемым расширениям, специфичным для приложения, в виде строго типизированных свойств.

В этом примере показано, как реализовать элемент расширения, определенный в предлагаемых расширениях Atom Threading Extensions RFC. Это предназначено только для демонстрационных целей, и этот пример не предназначен для полной реализации предлагаемой спецификации.

Пример XML

В следующем примере XML показана запись Atom 1.0 с дополнительным <in-reply-to> элементом расширения.

<entry>
    <id>tag:example.org,2005:1,2</id>
    <title type="text">Another response to the original</title>
    <summary type="text">
         This is a response to the original entry</summary>
    <updated>2006-03-01T12:12:13Z</updated>
    <link href="http://www.example.org/entries/1/2" />
    <in-reply-to p3:ref="tag:example.org,2005:1"
                 p3:href="http://www.example.org/entries/1"
                 p3:type="application/xhtml+xml"
                 xmlns:p3="http://contoso.org/syndication/thread/1.0"
                 xmlns="http://contoso.org/syndication/thread/1.0">
      <anotherElement xmlns="http://www.w3.org/2005/Atom">
                     Some more data</anotherElement>
      <aDifferentElement xmlns="http://www.w3.org/2005/Atom">
                     Even more data</aDifferentElement>
    </in-reply-to>
</entry>

Элемент <in-reply-to> задает три обязательных атрибута (reftypeиhref), а также позволяет использовать дополнительные атрибуты расширения и элементы расширения.

Моделирование элемента In-Reply-To

В этом примере элемент <in-reply-to> смоделирован в виде CLR, который реализует IXmlSerializable, что позволяет использовать его с элементом DataContractSerializer. Он также реализует некоторые методы и свойства для доступа к данным элемента, как показано в следующем примере кода.

[XmlRoot(ElementName = "in-reply-to", Namespace = "http://contoso.org/syndication/thread/1.0")]
public class InReplyToElement : IXmlSerializable
{
    internal const string ElementName = "in-reply-to";
    internal const string NsUri =
                  "http://contoso.org/syndication/thread/1.0";
    private Dictionary<XmlQualifiedName, string> extensionAttributes;
    private Collection<XElement> extensionElements;

    public InReplyToElement()
    {
        this.extensionElements = new Collection<XElement>();
        this.extensionAttributes = new Dictionary<XmlQualifiedName,
                                                          string>();
    }

    public Dictionary<XmlQualifiedName, string> AttributeExtensions
    {
        get { return this.extensionAttributes; }
    }

    public Collection<XElement> ElementExtensions
    {
        get { return this.extensionElements; }
    }

    public Uri Href
    { get; set; }

    public string MediaType
    { get; set; }

    public string Ref
    { get; set; }

    public Uri Source
    { get; set; }
}

Класс InReplyToElement реализует свойства для обязательных атрибутов (HRef, MediaTypeи Source) и коллекций для хранения AttributeExtensions и ElementExtensions.

Класс InReplyToElement реализует IXmlSerializable интерфейс, который позволяет напрямую контролировать, как экземпляры объектов считываются и записываются в XML. Метод ReadXml сначала считывает значения для свойств Ref, HRef, Source, и MediaType из XmlReader, переданного ему. Все неизвестные атрибуты хранятся в AttributeExtensions коллекции. Когда все атрибуты были прочитаны, вызывается ReadStartElement(), чтобы сдвинуть средство чтения к следующему элементу. Так как элемент, моделиируемый этим классом, не имеет необходимых дочерних элементов, дочерние элементы буфериируются в XElement экземпляры и хранятся в коллекции, как показано в ElementExtensions следующем коде.

public void ReadXml(System.Xml.XmlReader reader)
{
    bool isEmpty = reader.IsEmptyElement;

    if (reader.HasAttributes)
    {
        for (int i = 0; i < reader.AttributeCount; i++)
        {
            reader.MoveToNextAttribute();

            if (reader.NamespaceURI == "")
            {
                if (reader.LocalName == "ref")
                {
                    this.Ref = reader.Value;
                }
                else if (reader.LocalName == "href")
                {
                    this.Href = new Uri(reader.Value);
                }
                else if (reader.LocalName == "source")
                {
                    this.Source = new Uri(reader.Value);
                }
                else if (reader.LocalName == "type")
                {
                    this.MediaType = reader.Value;
                }
                else
                {
                    this.AttributeExtensions.Add(new
                                 XmlQualifiedName(reader.LocalName,
                                 reader.NamespaceURI),
                                 reader.Value);
                }
            }
        }
    }

    reader.ReadStartElement();

    if (!isEmpty)
    {
        while (reader.IsStartElement())
        {
            ElementExtensions.Add(
                  (XElement) XElement.ReadFrom(reader));
        }
        reader.ReadEndElement();
    }
}

В WriteXml методе InReplyToElement сначала записываются значения свойств Ref, HRef, Source и MediaType в виде XML-атрибутов (WriteXml не отвечает за запись самого внешнего элемента Ref, так как это делает вызывающий элемент ). Он также записывает содержимое AttributeExtensions и ElementExtensions в объект записи, как показано в следующем коде.

public void WriteXml(System.Xml.XmlWriter writer)
{
    if (this.Ref != null)
    {
        writer.WriteAttributeString("ref", InReplyToElement.NsUri,
                                            this.Ref);
    }
    if (this.Href != null)
    {
        writer.WriteAttributeString("href", InReplyToElement.NsUri,
                                                this.Href.ToString());
    }
    if (this.Source != null)
    {
        writer.WriteAttributeString("source", InReplyToElement.NsUri,
                                              this.Source.ToString());
    }
    if (this.MediaType != null)
    {
        writer.WriteAttributeString("type", InReplyToElement.NsUri,
                                                    this.MediaType);
    }

    foreach (KeyValuePair<XmlQualifiedName, string> kvp in
                                             this.AttributeExtensions)
    {
        writer.WriteAttributeString(kvp.Key.Name, kvp.Key.Namespace,
                                                   kvp.Value);
    }

    foreach (XElement element in this.ElementExtensions)
    {
        element.WriteTo(writer);
    }
}

ThreadedFeed и ThreadedItem

В примере SyndicationItems с InReplyTo расширениями моделироваются классом ThreadedItem . Аналогично, ThreadedFeed является классом, у которого все элементы являются экземплярами SyndicationFeed.

Класс ThreadedFeed наследует от SyndicationFeed и переопределяет OnCreateItem, чтобы вернуть ThreadedItem. Он также реализует метод для доступа к Items коллекции, как ThreadedItems, показано в следующем коде.

public class ThreadedFeed : SyndicationFeed
{
    public ThreadedFeed()
    {
    }

    public IEnumerable<ThreadedItem> ThreadedItems
    {
        get
        {
            return this.Items.Cast<ThreadedItem>();
        }
    }

    protected override SyndicationItem CreateItem()
    {
        return new ThreadedItem();
    }
}

Класс ThreadedItem наследует от SyndicationItem и делает InReplyToElement строго типизированным свойством. Это обеспечивает удобный InReplyTo программный доступ к данным расширения. Он также реализует TryParseElement и WriteElementExtensions для чтения и записи данных расширения, как показано в следующем коде.

public class ThreadedItem : SyndicationItem
{
    private InReplyToElement inReplyTo;
    // Constructors
        public ThreadedItem()
        {
            inReplyTo = new InReplyToElement();
        }

        public ThreadedItem(string title, string content, Uri itemAlternateLink, string id, DateTimeOffset lastUpdatedTime) : base(title, content, itemAlternateLink, id, lastUpdatedTime)
        {
            inReplyTo = new InReplyToElement();
        }

    public InReplyToElement InReplyTo
    {
        get { return this.inReplyTo; }
    }

    protected override bool TryParseElement(
                        System.Xml.XmlReader reader,
                        string version)
    {
        if (version == SyndicationVersions.Atom10 &&
            reader.NamespaceURI == InReplyToElement.NsUri &&
            reader.LocalName == InReplyToElement.ElementName)
        {
            this.inReplyTo = new InReplyToElement();

            this.InReplyTo.ReadXml(reader);

            return true;
        }
        else
        {
            return base.TryParseElement(reader, version);
        }
    }

    protected override void WriteElementExtensions(XmlWriter writer,
                                                 string version)
    {
        if (this.InReplyTo != null &&
                     version == SyndicationVersions.Atom10)
        {
            writer.WriteStartElement(InReplyToElement.ElementName,
                                           InReplyToElement.NsUri);
            this.InReplyTo.WriteXml(writer);
            writer.WriteEndElement();
        }

        base.WriteElementExtensions(writer, version);
    }
}

Настройка, сборка и запуск примера

  1. Убедитесь, что вы выполнили процедуру настройки One-Time для образцов Windows Communication Foundation.

  2. Чтобы создать версию решения на C# или Visual Basic .NET, следуйте инструкциям по сборке примеров Windows Communication Foundation .

  3. Чтобы запустить пример в конфигурации с одним или несколькими компьютерами, следуйте инструкциям в запуска примеров Windows Communication Foundation.

  • Last updated on