Oracle: ваш первый шаг к web-службам

2004 г.

Oracle: ваш первый шаг к web-службам

Владимир Пржиялковский, преподаватель технологий Oracle

Не покупай каштанов, но бери их на пробу.
К. Прутков

Службы web

Web-службы - пока еще перегретое (точнее - "подогретое") понятие, и поэтому в его объеме и содержании существуют определенные путаница и произвол. Общее определение иногда формулируют так: обмен в сети web сообщениями с узлами в формате XML.

На основе этого общего понятия скоро возникла специфичная разновидность под названием XML-RPC. XML-RPC - возможность запускать на узлах web удаленные процедуры, пользуясь XML для оформления запросов и ответов. Если есть узел web с сервером XML-RPC, то любая клиентская программа может пользуясь специальными правилами составления на XML запроса обратиться к серверу и получить в ответ результат вычислений.

Еще позже у архитекторов разработчиков технологий XML возникло желание построить более универсальную специфичную разновидность простого обмена сообщениями. Захотелось иметь такую службу в web, чтобы она обладала свойствами (а) самоописания и (б) самообнаружения. Реализовано это было под названием SOAP. Клиентская программа может осуществить на XML поиск нужной службы SOAP, запросить ее правила использования и воспользоваться ею.

Несмотря на то, что XML-RPC и SOAP являются воплощениями служб web - относительно изощренными, - простой обмен сообщениями XML (лежащий в основе этих технологий) тоже остается таковым и даже имеет свою самоценность. Самолет - современное средство перемещения, однако в деревню за молоком вы, наверное, поедете на велосипеде.

Ниже будут показаны некоторые способы, позволяющие выполнять такой обмен между БД под управлением Oracle и web, не прибегая к знаниям разного рода хитроумных сокращенний, дополнительных понятий и специальных технологий.

Что нужно для работы

Для проверки примеров в этой статье ничего необычного не потребуется. В качестве инструмента будет служить самая обычная базовая поставка СУБД Oracle. Примеры будут использовать транспортный протокол HTTP как наиболее типичный (другими транспортными протоколами для служб web могут быть FTP, SMTP и некоторые более специфичные), и предполагается, что ПО Oracle установлено вместе с HTTP-сервером. В версии Oracle 10 последний поставляется на отдельном диске, а в версиях 8.1 и 9 - вместе с ПО СУБД.

Для удобства расположение каталогов ПО Oracle и HTTP сервера на винчестере будет считаться умолчательным для версий 8.1 и 9. Например, корневым каталогом для HTTP сервера Apache будет считаться c:\oracle\ora92\Apache\Apache\htdocs (в варианте для Windows), или, для краткости, просто htdocs.

Требуется, чтобы СУБД Oracle и HTTP сервер были запущены.

В примере с XSQL подразумевается, что БД носит название ORCL. В общем случае это, конечно, не обязательно.

Прием сообщений XML в Oracle

Возможность обмена сообщениями в формате XML подразумевает для СУБД Oracle возможность приема таких сообщений с узлов web и возможность их публикации на узлах. Сначала рассмотрим первую возможность. Для этого составим файл mydoc.xml и поместим его в каталог htdocs:

<cover>
   <title>Oracle SQL*Loader</title>
   <author>Jonathan Gennick</author>
   <author>Sanjay Mishra</author>
   <pages>269</pages>
</cover>

Наберем в браузере адрес http://localhost:7778/mydoc.xml (здесь и далее - для версии 9; в версии 8.1 http://localhost/mydoc.xml). В окошке должен появиться текст "опубликованного в web" документа.

Для прочтения СУБД XML сообщений в Oracle есть разные способы. Рассмотрим способ совсем простой: с использованием встроенного пакета UTL_HTTP. В составе этого пакета есть процедуры, позволяющие читать заголовок HTTP ответа с web узла и текст сообщения. Вот пример их использования в SQL*Plus:

SET SERVEROUTPUT ON SIZE 40000

DECLARE
  req     utl_http.req;
  resp    utl_http.resp;
  name    VARCHAR2(256);
  value   VARCHAR2(1024);

BEGIN
  req := utl_http.begin_request
('http://localhost:7778/mydoc.xml');
  resp := utl_http.get_response(req);

  dbms_output.put_line('HTTP response status code:
 ' || resp.status_code);
  dbms_output.put_line('HTTP response reason: '
 || resp.reason_phrase);

  dbms_output.put_line('-----');

  FOR i IN 1 .. utl_http.get_header_count(resp) 
  LOOP
    utl_http.get_header(resp, i, name, value);
    dbms_output.put_line(name || ': ' || value);
  END LOOP;

  dbms_output.put_line('-----');

  LOOP
    utl_http.read_line(resp, value, TRUE);
    dbms_output.put_line(value);
  END LOOP;

EXCEPTION
  WHEN utl_http.end_of_body THEN
 utl_http.end_response(resp);
END;
/

Результат будет примерно такой:

HTTP response status code: 200
HTTP response reason: OK
--
Date: Fri, 28 May 2004 13:01:49 GMT
Server: Oracle HTTP Server Powered by Apache/1.3.22

(Win32) mod_plsql/3.0.9.8.3b PHP/4.3.0 mod_ssl/2.8.5

OpenSSL/0.9.6b mod_fastcgi/2.2.12 mod_oprocmgr/1.0 mod_perl/1.25
Last-Modified: Thu, 13 May 2004 15:15:47 GMT
ETag: "0-98-40a39123"
Accept-Ranges: bytes
Content-Length: 152
Connection: close
Content-Type: text/xml
--
<cover>
<title>Oracle SQL*Loader</title>
<author>Jonathan Gennick</author>
<author>Sanjay Mishra</author>
<pages>269</pages>
</cover>

Процедура PL/SQL успешно завершена.

SQL> ...

Построить процедуру получения XML документа на основе текста выше - дело техники. Разумно включить в процедуру проверку поля Content-Type ответа HTTP. Получится примерно следующее:

DECLARE
xmldoc VARCHAR2(4000) := '';
ok BOOLEAN := FALSE;

PROCEDURE readxml(url IN VARCHAR2,
 doc OUT VARCHAR2, success OUT BOOLEAN)
IS
  req   utl_http.req;
  resp  utl_http.resp;
  name  VARCHAR2(256);
  value VARCHAR2(1024);

BEGIN
  doc := '';
  req := utl_http.begin_request(url);
  resp := utl_http.get_response(req);

  success := resp.status_code = 200;
  IF success THEN
     FOR i IN 1 .. utl_http.get_header_count(resp) 
     LOOP utl_http.get_header(resp, i, name, value);
          success := name = 'Content-Type' AND
 value = 'text/xml';
          EXIT WHEN success;
     END LOOP;

     IF success THEN
        LOOP utl_http.read_line(resp, value, TRUE);
             doc := doc || value;
        END LOOP;
     END IF;
  END IF;

EXCEPTION
  WHEN utl_http.end_of_body THEN 
utl_http.end_response(resp);
END;

BEGIN
   readxml('http://localhost:7778/mydoc.xml',
 xmldoc, ok);
   IF ok THEN dbms_output.put_line(xmldoc);
   ELSE dbms_output.put_line('Not XML
 or bad URL');
   END IF;
END;
/

Более практично использовать для считываемого документа тип CLOB, а не VARCHAR2. Но это бы усложнило пример, а к сути не относится, и поэтому здесь не рассматривается. Так же ради простоты не рассматриваются технические вопросы форматирования текста документа.

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

То же самое можно в Oracle делать не только в PL/SQL, но и на Java.

Опубликование XML-данных в web

Здесь тоже можно действовать по-разному. Ниже будут рассмотрены только два варианта: (1) базовый вариант опубликования через сервлет на Java и (2) более абстрактный, с помощью XSQL. Простейший вариант размещения в htdocs файла XML (что можно в Oracle делать программно, прибегнув к пакету UTL_FILE или через Java) рассматриваться не будет.

Опубликование через Java-сервлет

В консольном окошке ОС выполним следующие установки (разновидность соответствует версии 9 и Windows):

set ORACLE_HOME=c:\oracle\ora92
PATH=%PATH%;%ORACLE_HOME%\jdk\bin
set CLASSPATH=%ORACLE_HOME%\lib\servlet.jar;.

Составим текст сервлета (программы на Java) в файле ServletForXML.java:

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletForXML extends HttpServlet {

    public void service (HttpServletRequest request,
			HttpServletResponse response)
			throws ServletException, IOException {

	response.setContentType("text/xml");	

	PrintWriter out = response.getWriter();

	out.println("<cover>");
	out.println("<title>Oracle SQL*Loader</title>");
	out.println("<author>Jonathan Gennick</author>");
	out.println("<author>Sanjay Mishra</author>");
	out.println("<pages>269</pages>");
	out.println("<</cover>");
    }
}

Странслируем сервлет и перенесем файл class в условное (по умолчанию) место для контейнера сервлетов (в данном случае - JServ от Apache):

javac ServletForXML.java
move /y ServletForXML.class %ORACLE_HOME%\Apache\Jserv\servlets

В том, что документ опубликован, можно убедиться, обратившись из браузера по адресу http://localhost:7778/servlet/ServletForXML.

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

Разумеется, текст сервлета можно усложнить и добавить в него обращение к БД через JDBC и остальное, что позволяет Java.

Выдача данных из БД с помощью XSQL

В версии Oracle 9.2 появилась еще одна возможность опубликования в web документов в формате XML на основе данных их БД. Хотя технически она основывается на использовании сервлета так, как это было описано только что, она не требует от потребителя знания Java, но зато может потребовать более досконального знания технологий XML. Эта возможность носит название XSQL.

В каталогах ПО Oracle в результате типовой установки образуется каталог c:\oracle\ora92\xdk\demo\java\xsql. Создадим там свой рабочий каталог myxsql. Заведем файл с именем emps.xsql:

<?xml version="1.0"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
<xsql:include-request-params/>
<xsql:query  tab="EMP" null-indicator="yes" >

       SELECT * 
       FROM {@tab}

</xsql:query>
</page>

Обратимся из браузера по адресу http://localhost:7778/xsql/myxsql/emps.xsql?tab=emp. Данные из Oracle опубликованы в web.

Упражнение. Замените в адресе tab=emp на tab=dept, потом на tab=bonus; наблюдайте результат. Уберите из адреса параметр запроса (знак вопроса и все, что справа от него). Наблюдайте результат.

Может возникнуть вопрос: как Oracle распознает, что запрашивать следует таблицы в схеме SCOTT, если мы нигде этого не указали ? На самом деле указали. Обратите внимание на фрагмент connection="demo" в тексте выше. Ссылка на БД и схему спрятана под именем demo. Обратитесь к файлу XSQLConfig.xml в каталоге с:\oracle\ora92\xdk\admin и найдите определение этой ссылки. Это будет БД ORCL и схема SCOTT. При желании эту ссылку можете переопределить, или добавить собственную.

Сервлет, который фактически обрабатывает запросы формата XSQL, интересен тем, что умеет обрабатывать поля типов XMLTYPE и объектов, а также типа коллекции, в том числе вложенные, и иерархии вложенных курсоров (на последние обстоятельства мое внимание обратил А. М. Левиус). Например, подправим таблицу EMP следующим образом:

CREATE TYPE typ_va IS VARRAY(10) OF VARCHAR(20);
/

CREATE TYPE typ_obj IS OBJECT 
             (city VARCHAR2(20), street VARCHAR2(20));
/

ALTER TABLE emp ADD (xmlc XMLTYPE, vac typ_va, addr typ_obj);

UPDATE emp 
SET xmlc = XMLTYPE(<a>bbb</a>)
  , vac = typ_va('Alice', 'Bob') 
  , addr = typ_obj('Ленинград', 'Невский')
WHERE ename='SMITH';

COMMIT;

Результат можно наблюдать по старому адресу http://localhost:7778/xsql/myxsql/emps.xsql. Обратите внимание на отсутствие проблем с русскими буквами.

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