Procédure : exposer un flux en tant que flux Atom et flux RSS

Article
02/27/2011

Windows Communication Foundation (WCF) vous permet de créer un service qui expose un flux de syndication. Cette rubrique explique comment créer un service de syndication qui expose un flux de syndication à l'aide d'Atom 1.0 et de RSS 2.0. Ce service expose un point de terminaison qui peut retourner l'un ou l'autre format de syndication. Pour simplifier, le service utilisé dans cet exemple est auto-hébergé. Dans un environnement de production, un service de ce type serait hébergé sous IIS ou WAS. Pour plus d'informations sur le sujet suivant les différentes options d'hébergement WCF, consultez Hébergement.

Pour créer un service de syndication de base

Définissez un contrat de service utilisant une interface marquée avec l'attribut WebGetAttribute. Chaque opération exposée comme un flux de syndication retourne un objet SyndicationFeedFormatter. Remarquez les paramètres de l'attribut WebGetAttribute. UriTemplate spécifient l'URL utilisée pour appeler cette opération de service. La chaîne pour ce paramètre contient des littéraux et une variable entre accolades ({format}). Cette variable correspond au paramètre format de l'opération de service. Pour plus d'informations, consultez UriTemplate. BodyStyle affecte la façon dont les messages que cette opération de service envoie et reçoit sont écrits. Bare spécifie que les données envoyées vers et depuis cette opération de service ne sont pas renvoyées à la ligne par les éléments XML définis dans l'infrastructure. Pour plus d'informations, consultez WebMessageBodyStyle.
```
<ServiceContract()> _
<ServiceKnownType(GetType(Atom10FeedFormatter))> _
<ServiceKnownType(GetType(Rss20FeedFormatter))> _
Public Interface IBlog
    <OperationContract()> _
    <WebGet(UriTemplate:="GetBlog?format={format}")> _
    Function GetBlog(ByVal format As String) As SyndicationFeedFormatter
End Interface
```
```
[ServiceContract]
[ServiceKnownType(typeof(Atom10FeedFormatter))]
[ServiceKnownType(typeof(Rss20FeedFormatter))]
public interface IBlog
{
    [OperationContract]
    [WebGet(UriTemplate = "GetBlog?format={format}")]
    SyndicationFeedFormatter GetBlog(string format);
}
```
Remarque :

Utilisez ServiceKnownTypeAttribute pour spécifier les types retournés par les opérations de service dans cette interface.

Remarque :
Utilisez ServiceKnownTypeAttribute pour spécifier les types retournés par les opérations de service dans cette interface.

Implémentez le contrat de service.

Public Class BlogService
    implements IBlog

    Public Function GetBlog(ByVal format As String) As SyndicationFeedFormatter Implements IBlog.GetBlog
        Dim feed As New SyndicationFeed("My Blog Feed", "This is a test feed", New Uri("http://SomeURI"))
        feed.Authors.Add(New SyndicationPerson("someone@microsoft.com"))
        feed.Categories.Add(New SyndicationCategory("How To Sample Code"))
        feed.Description = New TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF")
        Dim item1 As New SyndicationItem( _
            "Item One", _
            "This is the content for item one", _
            New Uri("https://localhost/Content/One"), _
            "ItemOneID", _
            DateTime.Now)

        Dim item2 As New SyndicationItem( _
            "Item Two", _
            "This is the content for item two", _
            New Uri("https://localhost/Content/Two"), _
            "ItemTwoID", _
            DateTime.Now)

        Dim item3 As New SyndicationItem( _
            "Item Three", _
            "This is the content for item three", _
            New Uri("https://localhost/Content/three"), _
            "ItemThreeID", _
            DateTime.Now)
        Dim items As New List(Of SyndicationItem)()
        items.Add(item1)
        items.Add(item2)
        items.Add(item3)

        feed.Items = items

        If (format = "rss") Then
            Return New Rss20FeedFormatter(feed)
        Else
            Return New Atom10FeedFormatter(feed)
        End If
    End Function
End Class

public class BlogService : IBlog
{
    public SyndicationFeedFormatter GetBlog(string format)
    {
        SyndicationFeed feed = new SyndicationFeed("My Blog Feed", "This is a test feed", new Uri("http://SomeURI"));
        feed.Authors.Add(new SyndicationPerson("someone@microsoft.com"));
        feed.Categories.Add(new SyndicationCategory("How To Sample Code"));
        feed.Description = new TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF");
        SyndicationItem item1 = new SyndicationItem(
            "Item One",
            "This is the content for item one",
            new Uri("https://localhost/Content/One"),
            "ItemOneID",
            DateTime.Now);

        SyndicationItem item2 = new SyndicationItem(
            "Item Two",
            "This is the content for item two",
            new Uri("https://localhost/Content/Two"),
            "ItemTwoID",
            DateTime.Now);

        SyndicationItem item3 = new SyndicationItem(
            "Item Three",
            "This is the content for item three",
            new Uri("https://localhost/Content/three"),
            "ItemThreeID",
            DateTime.Now);
        List<SyndicationItem> items = new List<SyndicationItem>();
        items.Add(item1);
        items.Add(item2);
        items.Add(item3);

        feed.Items = items;

        if (format == "rss")
            return new Rss20FeedFormatter(feed);
        else if (format == "atom")
            return new Atom10FeedFormatter(feed);
        else return null;
    }
}

Créez un objet SyndicationFeed et ajoutez un auteur, une catégorie et une description.

Dim feed As New SyndicationFeed("My Blog Feed", "This is a test feed", New Uri("http://SomeURI"))
feed.Authors.Add(New SyndicationPerson("someone@microsoft.com"))
feed.Categories.Add(New SyndicationCategory("How To Sample Code"))
feed.Description = New TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF")

SyndicationFeed feed = new SyndicationFeed("My Blog Feed", "This is a test feed", new Uri("http://SomeURI"));
feed.Authors.Add(new SyndicationPerson("someone@microsoft.com"));
feed.Categories.Add(new SyndicationCategory("How To Sample Code"));
feed.Description = new TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF");

Créez plusieurs objets SyndicationItem.

Dim item1 As New SyndicationItem( _
    "Item One", _
    "This is the content for item one", _
    New Uri("https://localhost/Content/One"), _
    "ItemOneID", _
    DateTime.Now)

Dim item2 As New SyndicationItem( _
    "Item Two", _
    "This is the content for item two", _
    New Uri("https://localhost/Content/Two"), _
    "ItemTwoID", _
    DateTime.Now)

Dim item3 As New SyndicationItem( _
    "Item Three", _
    "This is the content for item three", _
    New Uri("https://localhost/Content/three"), _
    "ItemThreeID", _
    DateTime.Now)

SyndicationItem item1 = new SyndicationItem(
    "Item One",
    "This is the content for item one",
    new Uri("https://localhost/Content/One"),
    "ItemOneID",
    DateTime.Now);

SyndicationItem item2 = new SyndicationItem(
    "Item Two",
    "This is the content for item two",
    new Uri("https://localhost/Content/Two"),
    "ItemTwoID",
    DateTime.Now);

SyndicationItem item3 = new SyndicationItem(
    "Item Three",
    "This is the content for item three",
    new Uri("https://localhost/Content/three"),
    "ItemThreeID",
    DateTime.Now);

Ajoutez les objets SyndicationItem au flux.

Dim items As New List(Of SyndicationItem)()
items.Add(item1)
items.Add(item2)
items.Add(item3)

feed.Items = items

List<SyndicationItem> items = new List<SyndicationItem>();
items.Add(item1);
items.Add(item2);
items.Add(item3);

feed.Items = items;

Utilisez le paramètre de format pour retourner le format demandé.

If (format = "rss") Then
    Return New Rss20FeedFormatter(feed)
Else
    Return New Atom10FeedFormatter(feed)
End If

if (format == "rss")
    return new Rss20FeedFormatter(feed);
else if (format == "atom")
    return new Atom10FeedFormatter(feed);
else return null;

Pour héberger le service

Créez un objet WebServiceHost. La classe WebServiceHost ajoute automatiquement un point de terminaison à l'adresse de base du service, sauf si un point est spécifié dans le code ou la configuration. Dans cet exemple, aucun point de terminaison n'est spécifié. De ce fait, c'est le point de terminaison par défaut qui est exposé.
```
Dim address As New Uri("https://localhost:8000/BlogService/")
Dim svcHost As New WebServiceHost(GetType(BlogService), address)
```
```
Uri address = new Uri("https://localhost:8000/BlogService/");
WebServiceHost svcHost = new WebServiceHost(typeof(BlogService), address);
```

Ouvrez l'hôte de service, chargez le flux à partir du service, affichez le flux et attendez que l'utilisateur appuie sur ENTRÉE.

svcHost.Open()
Console.WriteLine("Service is running")

Console.WriteLine("Loading feed in Atom 1.0 format.")
Dim atomReader As XmlReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=atom")
Dim atomFeed As SyndicationFeed = SyndicationFeed.Load(atomReader)
Console.WriteLine(atomFeed.Title.Text)
Console.WriteLine("Items:")
For Each item As SyndicationItem In atomFeed.Items
    Console.WriteLine("Title: {0}", item.Title.Text)
    Console.WriteLine("Content: {0}", CType(item.Content, TextSyndicationContent).Text)
Next

Console.WriteLine("Loading feed in RSS 2.0 format.")
Dim rssReader As XmlReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=rss")
Dim rssFeed As SyndicationFeed = SyndicationFeed.Load(rssReader)
Console.WriteLine(rssFeed.Title.Text)
Console.WriteLine("Items:")
For Each item As SyndicationItem In rssFeed.Items
    Console.WriteLine("Title: {0}", item.Title.Text)
    Console.WriteLine("Content: {0}", CType(item.Content, TextSyndicationContent).Text)
Next


Console.WriteLine("Press <ENTER> to quit...")
Console.ReadLine()
svcHost.Close()

svcHost.Open();
Console.WriteLine("Service is running");

Console.WriteLine("Loading feed in Atom 1.0 format.");
XmlReader atomReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=atom");
SyndicationFeed atomFeed = SyndicationFeed.Load(atomReader);
Console.WriteLine(atomFeed.Title.Text);
Console.WriteLine("Items:");
foreach (SyndicationItem item in atomFeed.Items)
{
    Console.WriteLine("Title: {0}", item.Title.Text);
    Console.WriteLine("Content: {0}", ((TextSyndicationContent)item.Content).Text);
}

Console.WriteLine("Loading feed in RSS 2.0 format.");
XmlReader rssReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=rss");
SyndicationFeed rssFeed = SyndicationFeed.Load(rssReader);
Console.WriteLine(rssFeed.Title.Text);
Console.WriteLine("Items:");
foreach (SyndicationItem item in rssFeed.Items)
{
    Console.WriteLine("Title: {0}", item.Title.Text);
    // Notice we are using item.Summary here instead of item.Content. This is because
    // of the differences between Atom 1.0 and RSS 2.0 specs.
    Console.WriteLine("Content: {0}", ((TextSyndicationContent)item.Summary).Text);
}

Console.WriteLine("Press <ENTER> to quit...");
Console.ReadLine();
svcHost.Close();

Pour appeler GetBlog avec un HTTP GET

Ouvrez Internet Explorer, tapez l'URL suivante et appuyez sur ENTRÉE. https://localhost:8000/BlogService/GetBlog

L'URL contient l'adresse de base du service (https://localhost:8000/BlogService), l'adresse relative du point de terminaison et l'opération de service à appeler.

Pour appeler GetBlog() à partir d'un code

Créez un XmlReader avec l'adresse de base et la méthode que vous appelez.

Dim atomReader As XmlReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=atom")

XmlReader reader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=atom");

Appelez la méthode Load statique, en passant dans le XmlReader que vous venez de créer.
```
Dim feed As SyndicationFeed = SyndicationFeed.Load(atomReader)
```
```
SyndicationFeed feed = SyndicationFeed.Load(reader);
```
Cela appelle l'opération de service et remplit un nouvel objet SyndicationFeed avec le module de formatage retourné à partir de l'opération de service.

Accédez à l'objet de flux.

Console.WriteLine(feed.Title.Text)
Console.WriteLine("Items:")
For Each item As SyndicationItem In feed.Items
    Console.WriteLine("Title: {0}", item.Title.Text)
    Console.WriteLine("Content: {0}", (CType(item.Content, TextSyndicationContent).Text))
Next

Console.WriteLine(feed.Title.Text);
Console.WriteLine("Items:");
foreach (SyndicationItem item in feed.Items)
{
    Console.WriteLine("Title: {0}", item.Title.Text);
    Console.WriteLine("Content: {0}", ((TextSyndicationContent)item.Content).Text);
}

Exemple

Les éléments suivants représentent l'intégralité du code pour cet exemple.

using System;
using System.Xml;
using System.Collections.Generic;
using System.ServiceModel;
using System.ServiceModel.Description;
using System.ServiceModel.Syndication;
using System.ServiceModel.Web;
namespace Service
{
    [ServiceContract]
    [ServiceKnownType(typeof(Atom10FeedFormatter))]
    [ServiceKnownType(typeof(Rss20FeedFormatter))]
    public interface IBlog
    {
        [OperationContract]
        [WebGet(UriTemplate = "GetBlog?format={format}")]
        SyndicationFeedFormatter GetBlog(string format);
    }

    public class BlogService : IBlog
    {
        public SyndicationFeedFormatter GetBlog(string format)
        {
            SyndicationFeed feed = new SyndicationFeed("My Blog Feed", "This is a test feed", new Uri("http://SomeURI"));
            feed.Authors.Add(new SyndicationPerson("someone@microsoft.com"));
            feed.Categories.Add(new SyndicationCategory("How To Sample Code"));
            feed.Description = new TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF");
            SyndicationItem item1 = new SyndicationItem(
                "Item One",
                "This is the content for item one",
                new Uri("https://localhost/Content/One"),
                "ItemOneID",
                DateTime.Now);

            SyndicationItem item2 = new SyndicationItem(
                "Item Two",
                "This is the content for item two",
                new Uri("https://localhost/Content/Two"),
                "ItemTwoID",
                DateTime.Now);

            SyndicationItem item3 = new SyndicationItem(
                "Item Three",
                "This is the content for item three",
                new Uri("https://localhost/Content/three"),
                "ItemThreeID",
                DateTime.Now);
            List<SyndicationItem> items = new List<SyndicationItem>();
            items.Add(item1);
            items.Add(item2);
            items.Add(item3);

            feed.Items = items;

            if (format == "rss")
                return new Rss20FeedFormatter(feed);
            else if (format == "atom")
                return new Atom10FeedFormatter(feed);
            else return null;
        }
    }

    public class Host
    {
        static void Main(string[] args)
        {
            Uri address = new Uri("https://localhost:8000/BlogService/");
            WebServiceHost svcHost = new WebServiceHost(typeof(BlogService), address);
            try
            {
                svcHost.Open();
                Console.WriteLine("Service is running");

                Console.WriteLine("Loading feed in Atom 1.0 format.");
                XmlReader atomReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=atom");
                SyndicationFeed atomFeed = SyndicationFeed.Load(atomReader);
                Console.WriteLine(atomFeed.Title.Text);
                Console.WriteLine("Items:");
                foreach (SyndicationItem item in atomFeed.Items)
                {
                    Console.WriteLine("Title: {0}", item.Title.Text);
                    Console.WriteLine("Content: {0}", ((TextSyndicationContent)item.Content).Text);
                }

                Console.WriteLine("Loading feed in RSS 2.0 format.");
                XmlReader rssReader = XmlReader.Create("https://localhost:8000/BlogService/GetBlog?format=rss");
                SyndicationFeed rssFeed = SyndicationFeed.Load(rssReader);
                Console.WriteLine(rssFeed.Title.Text);
                Console.WriteLine("Items:");
                foreach (SyndicationItem item in rssFeed.Items)
                {
                    Console.WriteLine("Title: {0}", item.Title.Text);
                    // Notice we are using item.Summary here instead of item.Content. This is because
                    // of the differences between Atom 1.0 and RSS 2.0 specs.
                    Console.WriteLine("Content: {0}", ((TextSyndicationContent)item.Summary).Text);
                }

                Console.WriteLine("Press <ENTER> to quit...");
                Console.ReadLine();
                svcHost.Close();
            }
            catch (CommunicationException ce)
            {
                Console.WriteLine("An exception occurred: {0}", ce.Message);
                svcHost.Abort();
            }
        }
    }
}

Compilation du code

Lors de la compilation du code précédent, référencez System.ServiceModel.dll et System.ServiceModel.Web.dll.

Voir aussi

Référence

WebHttpBinding
WebGetAttribute

Partager via