Конструктор, заданный по умолчанию
Заданный по умолчанию конструктор агента "жестко" определяет значение URL удаленного Web-сервиса и запоминает это значение в наследуемом свойстве Url.
public CalculatorWebService() {
this.Url = "http://localhost/CalcServicе/Service.asmx";
}
Очевидным недостатком такого подхода является то, что при переименовании или перемещении Web-сервиса XML класс агента приходится обновлять и перекомпилировать. Для построения более гибкого типа агента wsdl.exe предлагает использовать флаг /appsettingurlkey (который можно сократить до /urlkey). Если указать в командной строке этот флаг, конструктор агента будет содержать программную логику для чтения URL с помощью ключа, содержащегося в файле *.config клиента.
wsdl /out:proxy.cs /n:СаlcClient /urlkey:CalcUrl http://localhost/CalcService/Serviсе.asmx?wsdl
Если теперь проверить конструктор агента, заданный по умолчанию, вы обнаружите следующий программный код (заметьте, что если подходящий ключ не будет найден, в качестве резервного будет использоваться заданное конкретное значение URL).
public CalculatorWebService() {
string urlSetting = System.Configuration.ConfigurationManager.AppSettings["CalcUrl"];
if ((urlSetting != null)) {
this.Url = urlSetting;
} else {
this.Url = "http://localhost./CalcService/Service.asmx";
}
}
Соответствующий файл app.config на стороне клиента будет примерно таким.
‹?xml version="1.0" encoding="utf-8"?›
‹configuration›
‹appSettings›
‹add key="CalcUrl" value="http://localhost/CalcService/Service.asmx" /›
‹/appSettings›
‹/configuration›
Поддержка синхронного вызова
Генерируемый агент определяет также поддержку синхронного вызова Web-методов. Например, синхронный вариант метода Subtract() реализуется так.
public int Subtract(int x, int y) {
object[] results = this.invoke("Subtract", new object[] {x, y});
return ((int)(results[0]));
}
Обратите внимание на то, что вызывающая сторона передает два параметра, "упакованные" в массив System.Object. Используя динамическое связывание, метод Invoke() передаст эти аргументы методу вычитания, размещенному по указанному адресу URL. По завершении этого (блокирующего) вызова будет обработан поступающий XML-код и результат будет возвращен вызывающей стороне в виде System.Int32 после соответствующего преобразования.
Поддержка асинхронного вызова
Поддержка асинхронного вызова Web-методов в .NET 2.0 сильно изменилась по сравнению с .NET 1.x. По своему предыдущему опыту вы можете знать, что агенты .NET 1.1 использовали методы BeginXXX()/EndXXX() для вызова Web-методов во вторичном потоке выполнения. Рассмотрите, например, следующие методы BeginSubtract() и EndSubtract().
public System.IAsyncResult BeginSubtract(int x, int y, System.AsyncCallback callback, object asyncState) {
return this.BeginInvoke("Subtract", new object[] {x, y}, callback, asyncState);
}
public int EndSubtract (System.IAsyncResult asyncResult) {
object[] results = this.EndInvoke(asyncResult);
return ((int) (results[0]));
}
Хотя wsdl.exe все еще генерирует эти знакомые методы Begin/End, в .NET 2.0 они считаются устаревшими, поскольку заменены новыми методами XXXAsync().
public void SubtractAsync(int x, int y) {
this.SubtractAsync(x, y, null);
}
Новые методы XXXAsync() (как и связанный с ними метод CancelAsync()) работают в паре с автоматически генерируемым вспомогательным методом (являющимся перегруженной версией некоторого специального метода XXXAsync()), который обрабатывает асинхронные операции, используя синтаксис событий C#. Если рассмотреть программный код агента, вы увидите, что wsdl.exe генерирует (для каждого Web-метода) пользовательский делегат, пользовательское событие и пользовательский класс "event args", чтобы получить соответствующий результат.
Создание приложения клиента
Теперь, когда вы лучше понимаете внутреннюю композицию генерируемого агента, давайте попытаемся его использовать. Создайте новое консольное приложение с именем CalculatorClient, добавьте в проект файл proxy.cs с помощью выбора Project→Add Existing Item из меню и добавьте ссылку на компоновочный блок System.Web.Services.dll. Затем измените метод Main() так, как предлагается ниже.
class Program {
static void Main(string[] args) {
Console.WriteLine("***** Забавы c агентами WS *****n");
// Создание агента.
CalculatorWebService ws = new CalculatorWebService();
// Синхронный вызов метода Add().
Console.WriteLine("10 + 10= {0}", ws.Add(10, 10));
// Асинхронный вызов метода Subtract с помощью
// нового подхода .NET 2.0 на основе событий.
ws.SubtractCompleted += new SubtractCompleteEventHandler(ws_SubtractCompleted);
ws.SubtractAsync(50, 45);
// Продолжение работы консоли для гарантии получения
// результата вычитания.
Console.RеаdLine();
}
static void ws_SubtractCompleted(object sender, SubtractCompletedEventArgs e) {
Console.WriteLine("Baш ответ: {0} ", e.Result);
}
}
Обратите внимание на то, что новая логика асинхронного вызова в .NET 2.0 непосредственно отображается в синтаксис событий C#, который, согласитесь, является более аккуратным по сравнению с использованием методов BeginXXX()/EndXXX(), интерфейса IAsyncResult и делегата AsyncCallback.
Исходный код. Проект CalculatorClient размещен в подкаталоге, соответствующем главе 25.
Генерирование программного кода агента в Visual Studio 2005
Утилита wsdl.exe, конечно, предлагает целый ряд аргументов командной строки, которые позволяют контролировать результат генерирования класса агента, но Visual Studio 2005 позволяет быстро сгенерировать файл агента, используя диалоговое окно Add Web Reference (Добавление Web-ссылки), которое можно вызвать из Меню Project. Как видно из рис. 26.6, в этом окне вы можете получить ссылки на существующие Web-сервисы XML, размещенные в самых разных местах.
Замечание. Диалоговое окно Add Web Reference не позволяет ссылаться на Web-сервисы XML, которые обслуживаются WebDev.WebServer.exe.
Рис. 25.6. Диалоговое окно Add Web Reference
Обратите внимание на то, что вы имеете возможность не только получить список Web-сервисов на своей локальной машине, но и запросить различные каталоги UDDI (соответствующие вопросы будут обсуждаться в конце главы). Так или иначе, в результате ввода в строку URL подходящего значения, указывающего на действительный файл *.wsdl или *.asmx, вы добавите в проект новый класс агента. Заметьте, что пространство имен агента (зависящее от URL источника) будет вложено в рамки пространства имен вашего клиента .NET. Так, если для клиента с именем MyClientApp добавляется ссылка на Web-сервис, размещенный на вашей локальной машине, вы должны указать C#-директиву using следующего вида.
using MyClientApp.localhost;
Замечание. В Visual Studio 2005 диалоговое окно Add Web Reference автоматически либо добавляет в проект новый файл app.config, содержащий значения URL ссылок на Web-сервисы XML, либо обновляет уже существующий.
Доступ к пользовательским типам Web-методов
В заключительном примере этой главы мы с вами выясним, как строить Web-сервисы, предлагающие доступ к пользовательским типам, а также к более "экзотическим" типам из библиотек базовых классов .NET. Для примера мы создадим новый Web-сервис XML, который будет способен обрабатывать массивы, пользовательские типы и объекты DataSet ADO.NET. Сначала создайте новый Web-сервис XML с именем CarSalesInfoWS, размещенный в виртуальном каталоге IIS.
Создайте Web-метод GetSalesTagLines(), который возвращает массив строк, представляющих данные текущих продаж различных автомобилей, и метод SortCarMakes(), который позволит вызывающей стороне передать массив несортированных строк, чтобы обратно получить новый массив отсортированных строк.
[WebService(Namespace="http://IntertechTraining.com/", Description="Автомобильный Web-сервис", Name="CarSalesInfoWS")]
[WebServiceBinding(ConformsTo=WsiProfiles.BasicProfile1_1)]
public class Service: System.Web.Services.WebService {
[WebMethod(Description="Получение рекламных скидок")]
public string[] GetSalesTagLines() {
string[] currentDeals = {
"Цены на Colt снижены на 50%",
"Bce BMW комплектуются 8-канальным звуком",
"Caravan бесплатно… спросите у дилера!"
};
return currentDeals;
}
[WebMethod(Description = "Сортировки списка марок")]
public string[] SortCarMakes(string[] theCarsToSort) {
Array.Sort(theCarsToSort);
return theCarsToSort;
}
}
Замечание. Страница тестирования, генерируемая с помощью DefaultWsdlHelpGenerator.aspx, не может вызывать методы, использующие в качестве параметров массивы типов.