Как создать RSS-канал с ASP.NET

В этом руководстве мы рассмотрим, как создать RSS-канал с помощью платформы ASP.NET . В последние годы наличие RSS-канала для вашего сайта стало необходимостью. Благодаря частому обновлению блогов или новостных сайтов и огромному количеству блогов и новостных сайтов RSS позволяет читателям следить за новым контентом, не заставляя его посещать. Завершив этот урок, вы узнаете, как создать RSS-канал с ASP.NET и как отображать XML-документы на веб-страницах ASP.NET.

Шаг 0: RSS 2.0 Введение

RSS — это формат синдикации веб-контента. Он расшифровывается как «Действительно простая синдикация» и написан на XML. Все RSS-файлы должны соответствовать спецификации XML 1.0 , опубликованной Консорциумом World Wide Web (W3C). С помощью RSS можно распространять актуальный веб-контент с одного веб-сайта среди тысяч других по всему миру. Чтобы упростить термин, RSS позволяет быстро просматривать новости и обновления.

Синтаксические правила RSS 2.0 довольно просты, хотя и строги. Вот простой документ RSS:

Первая строка в документе — декларация XML — определяет версию XML и кодировку символов, используемую в документе. В этом случае документ соответствует спецификации 1.0 XML и использует набор символов utf-8 . Следующая строка — это декларация RSS, которая указывает, что это на самом деле документ RSS (точнее, версия RSS 2.0).

Следующая строка содержит элемент <channel> . Этот элемент используется для описания RSS-канала. Элемент <channel> имеет три обязательных дочерних элемента:

• <title> — Определяет заголовок канала (например, название вашего сайта)
• <link> — определяет гиперссылку на канал (например, http://www.yourdomain.com).
• <description> — Описывает канал (например, бесплатный учебник RSS)

Каждый элемент <channel> может иметь один или несколько <item> . Каждый <item> определяет статью или «историю» в ленте RSS.

Элемент <item> требует трех дочерних элементов:

• <title> — Определяет заголовок элемента (например, первая статья)
• <link> — определяет гиперссылку на элемент (например, http://www.yourdomain.com/article.aspx?ID=1).
• <description> — описывает элемент (например, описание первой статьи)

При просмотре в Firefox приведенный выше документ RSS должен выглядеть примерно так:

Шаг 1: Начало работы

Чтобы следовать этому руководству, представьте, что вы работаете веб-разработчиком и создаете новостной веб-сайт, где все новостные материалы хранятся в базе данных Microsoft SQL Server. В частности, статьи хранятся в таблице под названием News , которая содержит следующие поля:

• ArticleID — целочисленное поле первичного ключа с автоматическим приращением, уникально идентифицирующее каждую статью
• Заголовок — nvarchar(256) , с указанием заголовка статьи
• Автор — varchar(50) , с указанием автора статьи
• Описание — varchar(500) , обеспечивающий более глубокое описание статьи
• DatePublished — дата и время с указанием даты публикации статьи

Обратите внимание, что в таблице News могут быть и другие поля, но перечисленные выше — единственные, которые нам интересны — по крайней мере, для целей RSS-канала.

Мы будем использовать Visual Studio, чтобы закончить пример. Если у вас нет полной версии VS, вы можете получить бесплатную Express Edition .

Шаг 2: Создание страницы rss.aspx

Нашим следующим шагом будет создание веб-страницы ASP.NET ( rss.aspx ), которая будет отображать список самых последних новостей в виде правильно отформатированного документа RSS 2.0. В Solution Explorer щелкните правой кнопкой мыши имя проекта и выберите « Add New Item . В этом диалоговом окне в разделе «Установленные шаблоны Visual Studio» щелкните « Web Form .

В поле Name введите имя новой веб-страницы ( rss.aspx ) и нажмите кнопку Add . Новая веб-страница ASP.NET ( rss.aspx ) создается и отображается соответственно.

Поскольку мы хотим, rss.aspx страница rss.aspx производила вывод XML, первое, что мы должны сделать, это удалить все разметки HTML или веб-элементы управления со страницы, а затем установить для свойства @page директивы @page значение « text/xml ».

После очистки всей разметки HTML со страницы rss.aspx добавьте элемент управления Repeater на страницу. Мы будем использовать элемент управления Repeater для отображения документа RSS на странице rss.aspx.

Вот исходный вид страницы rss.aspx после того, как мы внесли некоторые изменения:

Шаг 3: Настройка строки подключения

Далее мы хотим настроить строку подключения источника данных в файле Web.config . Сохраняя информацию о строке подключения, мы избежим необходимости жестко кодировать ее в файле code-behind. Это упрощает ситуацию, если информация о строке подключения изменится в будущем. Поместите его в раздел <connectionStrings> под элементом конфигурации , например:

Мы получим доступ к этой информации из файла code-behind позже, когда мы хотим извлечь данные из базы данных.

Шаг 4. Удаление недопустимых символов из документа XML

Некоторые символы имеют особое значение в XML . Если вы поместите символ, такой как «<», в элемент XML, он сгенерирует ошибку, потому что синтаксический анализатор интерпретирует его как начало нового элемента. Чтобы избежать этой ошибки, замените символ «<» его entity reference (& lt;).

В XML есть пять предопределенных ссылок на сущности:

Чтобы наш RSS-канал не выдавал ошибку, мы должны заменить все недопустимые символы в документе RSS на ссылки на их сущности. Добавьте следующий код в файл code-behind страницы rss.aspx.cs ( rss.aspx.cs ):

 защищенная строка RemoveIllegalCharacters (ввод объекта)
 {
     // приведем ввод к строке
     string data = input.ToString ();      

     // заменить недопустимые символы в документах XML их ссылками на сущности
     data = data.Replace ("&", "& amp;");
     data = data.Replace ("\" "," & quot; ");
     data = data.Replace ("'", "& amp;");
     data = data.Replace ("<", "& lt;");
     data = data.Replace (">", "& gt;");

     вернуть данные;
 }

Функция RemoveIllegalCharacters() выполняет несколько простых замен строк, если это необходимо. Мы будем вызывать эту функцию со страницы rss.aspx ближайшее время.

Шаг 5: Получение данных из базы данных

Добавьте следующий код в обработчик событий Page_Load :

 защищенная пустота Page_Load (отправитель объекта, EventArgs e)
 {
     // Получить строку подключения из файла web.config
     string connString = ConfigurationManager.ConnectionStrings ["ConnectionString"]. ConnectionString;

     // Создать объект SqlConnection
     SqlConnection sqlConn = new SqlConnection ();
     sqlConn.ConnectionString = connString;

     // SQL-запрос для извлечения данных из базы данных
     string sqlQuery = "ВЫБЕРИТЕ ТОП 10 ArticleID, Title, Author, Description, DatePublished FROM News ORDER BY DatePublished DESC";

     // Создать объект SqlCommand
     SqlCommand cmd = new SqlCommand ();
     cmd.Connection = sqlConn;
     cmd.CommandType = CommandType.Text;
     cmd.CommandText = sqlQuery;

     // открываем соединение и затем привязываем данные в элемент управления RepeaterRSS
     sqlConn.Open ();
     RepeaterRSS.DataSource = cmd.ExecuteReader ();
     RepeaterRSS.DataBind ();
     sqlConn.Close ();
 }

Приведенный выше код будет пытаться получить десять самых последних новостей из вашей базы данных. Затем он будет привязывать их к Repeater управления RepeaterRSS ( RepeaterRSS ) при загрузке страницы.

Шаг 6: рендеринг данных

Это наш последний шаг. Пришло время рендерить элементы из таблицы News в соответствующий файл синдикации RSS 2.0. Самый простой и быстрый способ отобразить данные базы данных в виде XML — это использовать элемент управления RepeaterRSS ( RepeaterRSS ). В частности, Repeater отобразит теги элементов, связанных с <rss> , <channel> и веб-сайтом, в своих HeaderTemplate и FooterTemplate , а также элементы <item> в шаблоне ItemTemplate . Не забудьте вызвать вспомогательную RemoveIllegalCharacters() чтобы заменить ненужные символы из строкового вывода.

Ниже приведена HTML-часть нашей веб-страницы ASP.NET ( rss.aspx ):

Первое, на что стоит обратить внимание, это то, что файл rss.aspx приведенный выше, содержит только элемент управления RepeaterRSS ( RepeaterRSS ) и никаких других HTML-разметок или веб-элементов управления. Это потому, что мы хотим, чтобы страница излучала только вывод XML. Мы установили для @Page директивы @Page значение "text/xml" чтобы указать, что выходные rss.aspx страницы rss.aspx являются документом XML.

В шаблоне HeaderTemplate элемента управления Repeater мы размещаем элементы <rss> и <channel> .

Далее, в ItemTemplate мы ItemTemplate элементы <item> , которые содержат элементы <title> , <link> , <author> , <pubDate> и <description> , как место для полей базы данных. Мы вызываем RemoveIllegalCharacters() при добавлении полей базы данных Title , Author и Description к выводу XML . Помните, эта функция просто заменяет любые недопустимые символы XML их ссылками на сущности.

Наконец, DatePublished базы данных DatePublished , введенное в элемент <pubDate> , форматируется с использованием метода String.Format . Стандартный спецификатор формата R форматирует значение DatePublished соответствующим образом в соответствии с RFC 822, Спецификация даты и времени . Это начинается с необязательного трехбуквенного сокращения дня и запятой, за которым следует обязательный день, трехбуквенный сокращенный месяц, а затем год, за которым следует время с названием часового пояса, например, Thu, 04 Nov 2010 20:50:26 GMT .

Результат

И там у нас это есть! С минимальными усилиями мы создали специальный RSS-канал для приложения ASP.NET.

Полный код

Файл rss.aspx

Файл rss.aspx.cs

 используя Систему;
 использование System.Collections;
 используя System.Configuration;
 используя System.Data;
 использование System.Linq;
 использование System.Web;
 использование System.Web.Security;
 использование System.Web.UI;
 использование System.Web.UI.HtmlControls;
 использование System.Web.UI.WebControls;
 использование System.Web.UI.WebControls.WebParts;
 использование System.Xml.Linq;
 using System.Data.SqlClient;

 пространство имен NettutsTutorial2
 {
     открытый частичный класс rss: System.Web.UI.Page
     {
         защищенная пустота Page_Load (отправитель объекта, EventArgs e)
         {
             // Получить строку подключения из файла web.config
             string connString = ConfigurationManager.ConnectionStrings ["ConnectionString"]. ConnectionString;

             // Создать объект SqlConnection
             SqlConnection sqlConn = new SqlConnection ();
             sqlConn.ConnectionString = connString;

             // SQL-запрос для извлечения данных из базы данных
             string sqlQuery = "ВЫБЕРИТЕ ТОП 10 ArticleID, Title, Author, Description, DatePublished FROM News ORDER BY DatePublished DESC";

             // Создать объект SqlCommand
             SqlCommand cmd = new SqlCommand ();
             cmd.Connection = sqlConn;
             cmd.CommandType = CommandType.Text;
             cmd.CommandText = sqlQuery;

             // открываем соединение и затем привязываем данные в элемент управления RepeaterRSS
             sqlConn.Open ();
             RepeaterRSS.DataSource = cmd.ExecuteReader ();
             RepeaterRSS.DataBind ();
             sqlConn.Close ();
         }

         защищенная строка RemoveIllegalCharacters (ввод объекта)
         {
             // приведем ввод к строке
             string data = input.ToString ();

             // заменить недопустимые символы в документах XML их ссылками на сущности
             data = data.Replace ("&", "& amp;");
             data = data.Replace ("\" "," & quot; ");
             data = data.Replace ("'", "& amp;");
             data = data.Replace ("<", "& lt;");
             data = data.Replace (">", "& gt;");

             вернуть данные;
         }
     }
 }

Файл Web.config

Вывод

Создать RSS-ленту с ASP.NET довольно просто, не так ли? Нам нужно только понять спецификацию RSS 2.0. Кроме того, используя элемент управления .NET Repeater , мы можем рендерить элементы из базы данных в документ RSS. Большинство систем управления контентом будут иметь эту возможность по умолчанию. Однако, если вы разработчик и создаете веб-сайт ASP.NET с нуля, у вас теперь есть навыки для создания своего собственного фида.

Удачного кодирования!