ЯЗЫК ПРОГРАММИРОВАНИЯ С# 2005 И ПЛАТФОРМА .NET 2.0. 3-е издание - Эндрю Троелсен
Шрифт:
Интервал:
Закладка:
WebDev.Webserver /port:4000 /path:"C:HelloWorldWebService"
После запуска Web-сервера откройте любой браузер и укажите в его окне имя своего файла *.asmx, используя соответствующий номер порта.
http://localhost:4000/HelloWorldWebService.asmx
Вам будет показан список всех Web-методов, доступных по этому адресу URL (рис. 25.2).
Рис. 25.2. Тестирование Web-сервиса XML
Если в окне браузера вы щелкнете на ссылке HelloWorld, откроется другая страница, которая позволит вызвать [WebMethod], только что выбранный вами. В результате вызова HelloWorld() будет возвращена не буквальная строка .NET System.String, a XML-представление текстовых данных, возвращаемых Web-методом HelloWorld().
‹?xml version="1.0" encoding="utf-8"?›
‹string xmlns="bttp://tempuri.org/"›Hello!‹/string›
Тестирование Web-сервиса XML с помощью IIS
Теперь, когда вы проверили свой Web-сервис XML с помощью WebDev. WebServer.exe, перенесите файл *.asmx в виртуальный каталог IIS. Используя инструкции, предложенные в главе 23, создайте новый виртуальный каталог с именем HelloWS, который будет отображаться в физическую папку, содержащую файл HelloWorldWebServiсe.asmx. После этого вы получите возможность проверить свой Web-сервис с помощью ввода следующего значения URL в строке Web-браузера.
http://localhost/HelloWS/HelloWorldWebService.asmx
Просмотр WSDL-документа
Как уже упоминалось, WSDL является метаязыком, описывающим многочисленные особенности Web-методов, доступных по данному адресу URL. Обратите внимание на то, что при проверке Web-сервиса XML автоматически генерируемая страница тестирования предлагает ссылку Service Description (Описание сервиса). В результате щелчка на этой ссылке к текущему запросу присоединяются символы ?wsdl. Когда среда выполнения ASP.NET получает запрос для файла *.asmx с таким прикрепленным суффиксом, она автоматически возвращает соответствующий WSDL-код, открывающий каждый доступный Web-метод.
В настоящий момент вам не следует беспокоиться о природе WSDL-кода или формате WSDL-документа. Пока что важно только понимать, что WSDL-код описывает то, как Web-методы могут вызываться с помощью имеющихся протоколов связи Web-сервиса XML.
Автоматически генерируемая страница тестирования
Как вы только что убедились, работоспособность Web-сервисов XML можно проверить с помощью автоматически генерируемой HTML-страницы в браузере. Когда обнаруживается HTTP-запрос, указывающий на данный файл *.asmx, среда выполнения ASP.NET использует файл с именем DefaultWsdlHelpGenerator.aspx, чтобы создать HTML-страницу, позволяющую вызвать Web-методы, доступные по данному URL. Этот файл *.aspx можно найти в следующем каталоге (здесь, конечно, блок ‹версия› следует заменить на номер вашей текущей версии .NET Framework).
C:WindowsMicrosoft.NETFramework‹версия›CONFIG
Создание пользовательской страницы тестирования
Если вы хотите, чтобы среда выполнения ASP.NET применяла пользовательский файл *.aspx для проверки ваших Web-сервисов XML, вы можете встроить в эту страницу дополнительную информацию (например, фирменный знак компании, дополнительные описания сервиса, ссылки на файлы справки и т.д.). Чтобы упростить себе задачу, большинство разработчиков сначала копируют существующий файл DefaultWsdlHelpGenerator.aspx в проект, а затем, используя этот файл в качестве исходного, нужным образом изменяют оригинальный HTML-документ и программный код C#.
Скопируйте файл DefaultWsdlHelpGenerator.aspx в каталог, содержащий HelloWorldWebService.asmx (например, C:HelloWorldWebService). Переименуйте полученную копию в MyCustomWsdlHelpGenerator.aspx и измените какой-нибудь фрагмент HTML-кода, скажем, в области дескриптора ‹title›. Например, измените имеющийся код разметки
‹title›‹%#ServiceName + " " + GetLocalizedText("WebService'')%›‹/title›
на следующий.
‹title›Мой собственный
‹%#ServiceName + " " + GetLocalizedText("WebService") %›
‹/title›
После изменения HTML-содержимого создайте файл Web.config и сохраните его в текущем каталоге. Следующие XML-элементы дают указание среде выполнения использовать ваш пользовательский файл *.aspx, а не DefaultWsdlHelpGenerator.aspx.
‹!--Здесь указывается пользовательский файл *.aspx --›
‹configuration›
‹system.web›
‹webServices›
‹wsdlHelpGenerator href="MyCustomWsdlHelpGenerator.aspx" /›
‹/webServices›
‹/system.web›
‹/configuration›
При запросе своего Web-сервиса вы увидите, что строка заголовка браузера изменится в соответствии с указанным вами пользовательским содержимым. Кстати, если вы захотите отключить генерирование страницы помощи для данного Web-сервиса, вы можете сделать это с помощью элемента ‹remove› в файле Web.config.
‹!-- Отмена генерирования страницы помощи --›
‹configuration›
‹system.web›
‹webServices›
‹protocols›
‹!-- Этот элемент отменяет генерирование WSDL-документа --›
‹remove name="Documentation"/›
‹/protocols›
‹/webServices›
‹/system.web›
‹/configuration›
Исходный код. Файлы примера HelloWorldWebService размещены в подкаталоге, соответствующем главе 25.
Создание Web-сервиса XML в Visual Studio 2005
Создав Web-сервис XML вручную, давайте посмотрим, как это делается в Visual Studio 2005. Выбрав File→New→Web Site из меню, создайте новый C#-проект Web-сервиса XML с именем MagicEightBallWebService и сохраните этот проект на своем локальном диске (рис. 25.3).
Замечание. Как и в случае Web-узла ASP.NET, файлы *.sln проектов Web-сервисов XML, созданных в Visual Studio 2005, размещаются в папке Мои документыVisual Studio 2005 Projects.
Рис. 25.3. Проект Web-сервиса XML в Visual Studio 2005
После щелчка на кнопке OK в окне создания сервиса Visual Studio 2005 будет сгенерирован файл Service.asmx, определяющий следующую директиву ‹%@WebService%›.
‹%@ WebService Language="C#" CodeBehind="~/App_Code/Servicе.cs" Class="Service" %›
Обратите внимание на то, что здесь используется атрибут CodeBehind, чтобы указать имя файла с программным кодом C#, определяющим соответствующий тип класса (этот файл по умолчанию размещается в каталоге App_Code проекта). По умолчанию Service.cs определяется так.
using System;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;
[WebService(Namespace="http://tempuri.org/")]
[WebServiceBinding(ConformsTo=WsiProfiles.BasicProfile1_1)]
public class Service: System.Web.Services.WebService {
public Service() { }
public string HelloWorld() {
return "Hello World";
}
}
В отличие от предыдущего примера HelloWorldWebService, здесь класс Service получается из базового класса System.Web.Services.WebService. Члены, определенные этим типом, будут рассмотрены чуть позже, а здесь достаточно подчеркнуть, что получать класс Service именно из этого базового класса совсем не обязательно.
Также обратите внимание на то, что класс Service имеет два (также необязательных) атрибута, [WebService] и [WebServiceBinding]. Роль этих атрибутов тоже будет рассмотрена немного позже.
Реализация Web-метода TellFortune()
Ваш Web-сервис XML MagicEightBall будет имитировать классическую говорящую игрушку, сообщающую предсказания. Для этого добавьте в класс Service следующий метод (существующий Web-метод HelloWorld() можно удалить).
[WebMethod]
public string TellFortune(string вопросПользователя) {
string[] answers = {"Будущее неоднозначно", "Да", "Нет", "Вряд ли", "Спросите еще раз", "Определенно" };
// Возвращение случайного ответа на вопрос.
Random r = new Random();
return string.Format("{0}? {1}", вопросПользователя, answers[r.Next(answers.Length)]);
}
Для проверки нового Web-сервиса XML просто запустите проект на выполнение (или для отладки) в Visual Studio 2005. Поскольку для метода ТеllFortune() требуется один входной параметр, автоматически генерируемая HTML-страница тестирования обеспечивает необходимое поле ввода (рис. 25.4).
Рис. 25.4. Вызов Web-метода TellFortune()
Вот возможный ответ на вопрос "Будет ли отремонтирован водосток в выходные?"
‹?xml version="1.0" encoding="utf-8"?›
‹string xmlns="http://tempuri.org/"›"Будет ли отремонтирован водосток в выходные? Вряд ли
‹/string›
Итак, к этому моменту вы создали два простых Web-сервиса XML: один вручную, а другой – с помощью Visual Studio 2005. Теперь у вас есть хорошая основа для углубленного обсуждения соответствующих вопросов, и начнем мы это обсуждение с рассмотрения роли базового класса
Исходный код. Файлы примера MagicEightBallWebService размещены в подкаталоге, соответствующем главе 25.
Роль базового класса WebService
В процессе разработки сервиса HelloWorldWebService вы имели возможность убедиться том, что Web-сервис можно получить непосредственно из System.Object. Но по умолчанию Web-сервисы, созданные в Visual Studio 2005, автоматически получаются из базового класса System.Web.Services.WebService. Описания основных членов этого типа класса предлагаются в табл. 25.3.
