Технология Web-сервисов - очень серьезная технология в том смысле, что для того, чтобы ее продемонстрировать, необходимо выполнить достаточно много разного рода подготовительных действий.

Как и в других случаях, когда мы знакомились с новой технологией, вначале мы рассмотрим простой пример и на нем проиллюстрируем все основные особенности проектирования и реализации Web-сервисов, и лишь затем перейдем к реализации нашего приложения.

Web-сервисы для своего выполнения требуют определенной среды или сервера приложений. В настоящий момент имеется большое количество таких серверов, как коммерческих, так и общедоступных, обладающих большей или меньшей функциональностью. В приведенных ниже примерах используется один из таких серверов, разработанный фирмой Sun, - Sun Java System Application Server, который может быть загружен с сайта производителя. Соответственно, весь материал, относящийся к развертыванию и конфигурированию Web-сервисов, адаптирован именно для этого сервера приложений. Для других серверов процедуры, которые необходимо провести для выполнения этих действий, могут отличаться.

Инсталляция сервера приложений

Sun Java System Application Server поставляется в виде инсталляционного пакета, сформированного для инсталляции на основных используемых платформах.

Для наших целей вполне подойдет инсталляция с параметрами по умолчанию. Необходимо только обратить внимание на три параметра:

· основной порт, на котором будут приниматься запросы сервером (по умолчанию 8080). Этот порт будет указываться в адресе при вызове методов сервисов;

· порт административной консоли (по умолчанию 4848) - с её помощью мы будем развертывать и тестировать Web-сервис;

· пароль для административной учетной записи - для инсталляции Web-сервиса в сервере приложений нужны административные права.

После установки Sun Java System Application Server может быть запущен с помощью командного файла asadmin (на платформе Windows этот командный файл называется asadmin.bat).

Рис. 3.2. Регистрация в административной консоли

Подробная информация может быть получена при обращении и регистрации в административной консоли (рис. 3.2).

Установка необходимых приложений

Для проекта воспользуемся кодом, поставляемым в составе пакета The Java Web Services Tutorial (он может быть загружен с сайта фирмы Sun). Пакет представляет собой архив, содержащий развернутую документацию по разработке Web-сервисов и несколько примеров. Вот одним из этих примеров, называющимся helloservice, мы и воспользуемся в качестве шаблона для реализации проекта.

Этот пример представляет собой реализацию простейшего Web-сервиса, который содержит единственный метод, принимающий и возвращающий значение типа String. Пример располагается в папке <tutorial.home> /examples/jaxws/helloservice, где <tutorial.home> - директория, в которую был установлен пакет The Java Web Services Tutorial.

Прежде чем компилировать, устанавливать и выполнять пример, необходимо настроить некоторые параметры, которые определены в файле build.properties, лежащем в <tutorial.home>/examples/common. Определить нужно следующие параметры:

· javaee.home - параметр, указывающий на корень установки сервера приложений;

· javaee.tutorial.home - параметр, указывающий на корень установки пакета The Java Web Services Tutorial.

В случае если установка сервера проводилась по умолчанию, никаких других изменений в этом файле делать не нужно. В случае если Sun Java System Application Server установлен в директории H:/Java/AppServer/, а The Java Web Services Tutorial - в директории H:/Java/wstutorial20_new/, файл build.properties будет иметь следующий вид:

javaee.home=H:/Java/AppServer/

]avaee.tutorial.home= H:/Java/jwstutorial20_new/

admin.password.file=${javaee.tutorial.home}/exаmples/common/admin-

password.txt

admin.host=localhost

admin.user=admin

admin.port=4848

https.port=8181

domain.resources="domain.resources"

domain.resources.port=8080

# Database properties are in derby.properties

db.vendor=derby

Листинг 3.1. Файл build.properties

Для того чтобы иметь возможность инсталлировать разработанный Web-сервис в сервер приложений, необходимо также в файле admin-password.txt (находящемся в <tutorial.home>/examples/common/) указать пароль для учетной записи администратора.

Исходный код Web-сервиса

После того, как указанные настройки будут закончены, можно приступить непосредственно к примеру.

Файл с исходным кодом Web-сервиса располагается в директории src, называется Hello.java и имеет следующий вид (пример 3.2):

package helloservice.endpoint;

import javax.jws.WebMethod;

import javax.jws.WebService;

@WebService()

public class Hello {

private String message = new String("Hello, ");

@WebMethod()

public String sayHello(String name) {

return message + name + ".";

}

private static int clientRequestCount=0;

private int A[][] = {{1,2,3}, {4,5,6}, {7,8,9}};

private int B[][] = {{1,2,3}, {4,5,6}, {7,8,9}};

private static int i=0, j=0;

//возврат координат позиции элемента для вычисления

@WebMethod()

public int getIPos() {return i;}

@WebMethod()

public int getJPos() {return j;}

//вычисляем отдельный элемент результирующей матрицы C=A*B

@WebMethod()

public int GetMultMatrixElement() {

int result=0;

clientRequestCount++;

for (int r=0; r<A.length; r++)

result+=A[i][r]*B[r][j];

SetPosition();

return result;

}

/*вычислим номер i,j элемента для вычисления в зависимости от

номера запроса клиента*/

private void SetPosition()

{

if (j>=B.length-1)

{j=0; i++;}

else j++;

//проверка и переход к новому умножению матриц

if (clientRequestCount>A.length*B[0].length-1)

{i=0; j=0; clientRequestCount=0;}

}

}

Листинг 3.2. Файл Hello.java

Первое, что обращает на себя внимание, - удивительная краткость написанного кода. Но не стоит обольщаться: дело в том, что технология разработки Web-сервисов, которую мы будем использовать, просто скрывает от разработчика большую часть работы по реализации Web-сервиса. Фактически, все, что должен сделать разработчик, - реализовать код самих вызываемых методов; абсолютно всю работу по реализации механизмов, позволяющих вызывать эти методы удаленно, берет на себя используемая нами технология.

Итак, рассмотрим пример подробнее.

Во-первых, определяется пакет, в который будет помещен класс Hello, пакет называется helloservice.endpoint . Затем импортируются две аннотации - javax.jws.WebMethod и javax.jws.WebService. Поскольку механизм аннотаций является в java относительно новым, видимо имеет смысл сказать о нем несколько слов.

Аннотации java предоставляют разработчику механизм, позволяющий включать в код некие метаданные. Метаданные - это дополнительная информация, которая может быть добавлена к классам, интерфейсам, полям и методам - так называемые "данные о данных". Метаданные доступны как на этапе компиляции, так и во время исполнения через механизм рефлексии. Вот эти данные, которые мы можем добавить к классам, интерфейсам, полям и методам, и называются аннотациями.

Для аннотации вводится понятие области видимости, или времени жизни. Область видимости выбирается из перечисления java.lang.annotation. RetentionPolicy и может принимать следующие значения:

· SOURCE - аннотация будет удалена компилятором;

· CLASS - аннотация будет записана в байт-код класса, но не будет использоваться Java-машиной;

· RUNTIME - аннотация будет записана в байт-код и будет доступна во время исполнения через механизм рефлексии.

Одна из замечательных возможностей, которую открывает перед разработчиками механизм аннотаций, заключается в том, что с их помощью могут быть построены средства автоматического внесения в код нужной функциональности.

В нашем конкретном примере аннотации используются именно с этой целью. Ориентируясь на них, специальная утилита wsgen генерирует классы-обертки, выполняющие всю техническую работу.

Первая аннотация, которая используется применительно ко всему классу, - аннотация WebService. Эта аннотация нужна для того чтобы указать, что данный класс в дальнейшем будет опубликован в качестве Web-сервиса. Есть некоторые ограничения, связанные с применением этой аннотации. Методы, которые предполагается опубликовать, должны быть аннотированы как javax.jws.WebMethod, они должны быть объявлены как static или final. В качестве принимаемых и возвращаемых параметров должны использоваться параметры совместимых с JAX-B типов (все примитивные типы могут использоваться в качестве параметров). Класс, реализующий Web-сервис, не может быть объявлен как final, кроме того, он не должен быть абстрактным, должен иметь публичный конструктор по умолчанию и не переопределять метод finalize. Все эти ограничения связаны с тем, что разрабатываемый класс будет выполняться не самостоятельно, а будет, фактически, встроен в сервер, следовательно, сервер должен полностью контролировать процесс его создания (загрузки) и уничтожения. В случае если при загрузке и/или выгрузке объекта необходимо предпринимать какие-то дополнительные действия, могут применяться аннотации javax.annotation.PostConstruct и javax.annotation.PreDestroy. Метод, аннотированный как PostConstruct, будет вызван сервером приложений до того, как объекту первый раз будет передан запрос клиента. Метод, аннотированный как PreDestroy, вызывается перед уничтожением объекта.

Собственно, на этом разработка Web-сервиса заканчивается. Следующее, что необходимо сделать, - откомпилировать его, пропустить через утилиту wsgen для генерации вспомогательных классов, создать war-file, содержащий в себе откомпилированное приложение и необходимые ресурсы, и затем разместить и зарегистрировать его на сервере приложений.

В комплекте с примерами, поставляемыми в пакете The Java Web Services Tutorial, поставляются также скрипты для их компиляции. Эти скрипты предназначены для специального инструментального средства компиляции, которое называется ant (исполняющая часть ant устанавливается вместе с Sun Java System Application Server).

Разработчики примеров для пакета The Java Web Services Tutorial постарались на славу, и теперь для компиляции и установки приложения необходимо выполнить лишь несколько простых команд.

Компиляция и инсталляция на сервере приложений

Итак, первое, что предстоит сделать, - откомпилировать приложение. Для компиляции в настройках сборки определена специальная цель (target) - build.

Набрав в командной строке команду asant build (asant - вызов командного файла, запускающего ant, build - имя цели, которую он должен выполнить), получим следующий вывод:

Buildfile: build.xml

javaee-home-test:

init: и т. д.

Первое, что делается для компиляции программы, - создается специальная директория build, в которую будут помещены откомпилированные модули. Она создается в текущей директории. Затем вызывается компилятор javac, который компилирует наш класс Hello.java, а результат компиляции кладет в директорию build. Поскольку класс Hello определен в пакете helloservice.endpoint, в директории build будет создана соответствующая система каталогов и файл Hello.class будет помещен в каталог ./build/ helloservice/endpoint.

Следующим шагом вызывается утилита wsgen, которая формирует вспомогательные классы. По умолчанию исходные коды этих классов после компиляции уничтожаются, однако, выставив опцию keep=true (эта и другие опции могут быть установлены в файле build.properties), исходные коды можно сохранить. Помещаются они в пакет jaxws того же пакета, которому принадлежит и класс. Соответственно, для нашего примера исходные файлы (а затем и откомпилированные классы) будут располагаться в директории ./build/ helloservice/endpoint/jaxws. После того как утилита wsgen отработала, мы имеем откомпилированный пакет helloservice.endpoint.jaxws, содержащий необходимые вспомогательные классы. На этом шаге компиляция нашего Web-сервиса закончена. Следующим этапом необходимо подготовить модуль развертывания. В нашем случае это делается с помощью команды:

asant create-war

Создается отдельный каталог assemble, в нем создается каталог war, в котором формируется файл hello-jaxws.war. Этот файл представляет собой архив, в который помещены откомпилированные файлы нашего приложения и некоторые вспомогательные файлы. Теперь у нас полностью готов модуль развертывания, который мы можем инсталлировать в сервере приложений. Инсталляция может быть выполнена командой:

asant deploy

Чтобы убедиться в том, что инсталляция приложения прошла успешно, можно воспользоваться консолью администратора:

Рис. 3.3. Проверка инсталляции приложения

В процессе инсталляции, кроме прочего, был сгенерирован WSDL-файл, описывающий установленный Web-сервис. Как уже говорилось, этот файл содержит полное описание Web-сервиса, включая названия его методов, а также количество и типы передаваемых и возвращаемых параметров. Этот файл является важной составляющей частью технологии, поскольку он позволяет строить приложения, осуществляющие динамические вызовы методов Web-сервисов. Кроме того, этот файл может быть использован для автоматической генерации вспомогательных классов (классов-proxy) для обращения к Web-сервису.

WSDL-файл для нашего Web-сервиса может быть получен по адресу http://localhost:8080/helloservice/hello?wsdl

<!-- Published by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.1.3.1-hudson-417-SNAPSHOT. --><!-- Generated by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.1.3.1-hudson-417-SNAPSHOT. --><definitions targetNamespace="http://endpoint.helloservice/" name="HelloService"><types><xsd:schema><xsd:import namespace="http://endpoint.helloservice/" schemaLocation="http://localhost:8080/helloservice/hello?xsd=1"/></xsd:schema></types><message name="sayHello"><part name="parameters" element="tns:sayHello"/></message><message name="sayHelloResponse"><part name="parameters" element="tns:sayHelloResponse"/></message><message name="GetMultMatrixElement"><part name="parameters" element="tns:GetMultMatrixElement"/></message><message name="GetMultMatrixElementResponse"><part name="parameters" element="tns:GetMultMatrixElementResponse"/></message><message name="getIPos"><part name="parameters" element="tns:getIPos"/></message><message name="getIPosResponse"><part name="parameters" element="tns:getIPosResponse"/></message><message name="getJPos"><part name="parameters" element="tns:getJPos"/></message><message name="getJPosResponse"><part name="parameters" element="tns:getJPosResponse"/></message><portType name="Hello"><operation name="sayHello"><input message="tns:sayHello"/><output message="tns:sayHelloResponse"/></operation><operation name="GetMultMatrixElement"><input message="tns:GetMultMatrixElement"/><output message="tns:GetMultMatrixElementResponse"/></operation><operation name="getIPos"><input message="tns:getIPos"/><output message="tns:getIPosResponse"/></operation><operation name="getJPos"><input message="tns:getJPos"/><output message="tns:getJPosResponse"/></operation></portType><binding name="HelloPortBinding" type="tns:Hello"><soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/><operation name="sayHello"><soap:operation soapAction=""/><input><soap:body use="literal"/></input><output><soap:body use="literal"/></output></operation><operation name="GetMultMatrixElement"><soap:operation soapAction=""/><input><soap:body use="literal"/></input><output><soap:body use="literal"/></output></operation><operation name="getIPos"><soap:operation soapAction=""/><input><soap:body use="literal"/></input><output><soap:body use="literal"/></output></operation><operation name="getJPos"><soap:operation soapAction=""/><input><soap:body use="literal"/></input><output><soap:body use="literal"/></output></operation></binding><service name="HelloService"><port name="HelloPort" binding="tns:HelloPortBinding"><soap:address location="http://localhost:8080/helloservice/hello"/></port></service></definitions>

Листинг 3.3. WSDL-файл Web-сервиса Hello

Тестирование Web-сервиса