使用Python下的XSLT API进行web开发的简单教程

程序员文章站 2023-12-29 08:12:22

kafka 样式的 soap 端点 christopher dix 所开发的“kafka — xsl soap 工具箱”（请参阅参考资料）是一种用于构造 soap 端点...

kafka 样式的 soap 端点

christopher dix 所开发的“kafka — xsl soap 工具箱”（请参阅参考资料）是一种用于构造 soap 端点的 xslt 框架。它只涵盖了 soap 1.1，但 kafka 端点演示了传递 userland soap 验证器（userland soap validator）的能力，并且根据 soap 1.2 对它进行更新似乎并不太困难。清单 1展示了一个样本 kafka 端点：求两数之和的 soap 服务器（一个典型而简单的 soap 样本）。

清单 1. 求两数之和的 kafka soap 端点

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0"
 xmlns:method="http://www.topxml.com/"
 xmlns:xsl="http://www.w3.org/1999/xsl/transform"
>
  <!-- add.xsl : kafka soap endpoint example, with modifications -->
  <!-- import soap.xsl to use the framework -->
  <xsl:import href="kafka/soap.xsl"/>
  <xsl:output method="xml" encoding="utf-8" omit-xml-declaration="yes"/>
  <!-- define the global variables for the framework -->
  <xsl:variable name="method">add</xsl:variable>
  <xsl:variable name="methodns">http://www.topxml.com/</xsl:variable>
  <!-- add : add two numbers and return the sum -->
  <!-- function add( a as double, b as double ) as double -->
  <xsl:template name="processpayload">
   <xsl:param name="payload"/>
   <xsl:for-each select="$payload">
     <!-- this is how to retrieve parameters from the input -->
     <xsl:variable name="a" select="number(a|method:a)"/>
     <xsl:variable name="b" select="number(b|method:b)"/>
     <!-- the writeparameter template takes the qualified name
       for a response parameter as well as its value and
       a qname specifying the tpe (for the xsi:type attribute) -->
     <xsl:call-template name="writeparameter">
      <xsl:with-param name="p" select="'result'"/>
      <xsl:with-param name="v" select="$a + $b"/>
      <xsl:with-param name="t" select="'xsd:double'"/>
     </xsl:call-template>
   </xsl:for-each>
  </xsl:template>
  
</xsl:stylesheet>

xslt 端点导入 soap 框架（文件 kafka/soap.xsl），然后设置该框架将要使用的参数，并设置它在处理构成 soap 消息的整个 xml 文档的过程中将要分派的模板。全局变量 method 和 methodns 声明了组成消息的 xml 元素。在处理完 soap 信封之后，该框架调用 processpayload 模板，该模板传入了 xml 主体的有效负载。 xsl:for-each 是将上下文切换成想要的节点的标准技巧。参数 a 和 b 是使用简单 xpaths 从这个元素读取的，而框架被再次调用以帮助写出响应参数。 writeparameter 模板让您指定元素名称、数据类型和每个输出参数的值。本示例中的响应值是将两个输入参数相加所得的结果。

将这个端点部署为服务器相当于设置一个 http 侦听器。python 的 basehttpserver 模块向您提供了所需的机制，能够轻而易举地处理该协议的 http 部分。请参阅清单 2。

清单 2. 用于清单 1 中所实现的 kafka soap 端点的 python http 框架

#http listener code for soap server
import basehttpserver
#the processor class is the core of the xslt api
from ft.xml.xslt import processor
#4xslt uses an inputsource system for reading xml
from ft.xml import inputsource
soap_impl_file = "add.xsl"
class kafkasoaphandler(basehttpserver.basehttprequesthandler):
  def init(cls):
    from ft.lib import uri
    #set up a processor instance to use
    kafkasoaphandler.processor = processor.processor()
    #load it with add.xsl
    add_uri = uri.ospathtouri(soap_impl_file, attemptabsolute=1)
    transform = inputsource.defaultfactory.fromuri(add_uri)
    kafkasoaphandler.processor.appendstylesheet(transform)
    #now the processor is prepped with a transform and can be used
    #over and over for the same transform
    return
  #make init() a static method of the class
  init = classmethod(init)
  def do_post(self):
    clen = self.headers.getheader('content-length')
    if clen:
      clen = int(clen)
    else:
      print 'post error: missing content-length'
      return
    if self.path != '/add':
      self.send_error(404)
    input_body = self.rfile.read(clen)
    #input_body is the request soap envelope and contents
    response_body = self._run_through_kafka(input_body)
    #response_body is the response soap envelope and contents
    self._send_response(200, 'ok', response_body)
    return
  def _run_through_kafka(self, body):
    #in 4suite all inputsources have base uris in case they refer to
    #other uris in some way and resolution is required.
    #the soap messages will not have any such uri references,
    #so use a dummy base uri
    source = inputsource.defaultfactory.fromstring(body, "urn:dummy")
    response = self.processor.run(source)
    return response
  def _send_response(self, code, msg, body):
    #prepare a normal response
    self.send_response(200, 'ok')
    #send standard htp headers
    self.send_header('content-type','text/html; charset=utf-8')
    self.send_header("connection", "close")
    self.send_header("accept-ranges", "bytes")
    self.send_header('content-length', len(body)-1)
    self.end_headers()
    #send the response prepared by the soap end point
    self.wfile.write(body)
    return
 
listen_on_port = 8888
#set up to run on local machine
server_address = ('127.0.0.1', listen_on_port)
kafkasoaphandler.init()
httpd = basehttpserver.httpserver(server_address, kafkasoaphandler)
print "listening on port", listen_on_port
#go into a the main event loop
httpd.serve_forever()

我们详细地注释了该清单，因此它应该是易于理解的。请注意，这段代码非常简单，这是因为它仅需处理该协议的 http 部分，而将 xml 和 soap 部分的工作交由 kafka 框架完成。该服务器专用于一个端点，因此它只须对 xslt 转换进行一次解析和设置，然后它就可以简单地反复为每次新的请求运行该转换。这就是将处理器设置迁移到特殊的类方法中的原因，处理程序一注册到服务器就立即调用该方法。 classmethod 内置方法是 python 2.2 中的新功能，实际上该版本是本例和后面的示例所必需的版本。它提供了隐式类对象 (cls) ，您可以将静态数据（如已准备好的处理器实例）附加到该对象上，然后通常可以通过普通方法上的 self 实例引用来使用该数据。

我们使用 soappy 0.10.1 的最新发行版（请参阅参考资料）测试了该端点，该发行版具有许多很棒的新功能，稍后我们将在本专栏中进行讨论。清单 3是使用该端点的 soappy 客户机。打开一个命令 shell 并为服务器运行 python listing2.py。然后打开另一个 shell 并运行 python listing3.py，该命令将报告正确的响应，形如 add result: 7.0。

清单 3: 用于求两数之和的 soappy 客户机

import soappy
endpoint = "http://localhost:8888/add"
add_ns = "http://www.topxml.com/"
 
remote = soappy.soapproxy(endpoint, namespace=add_ns)
print "add result:", remote.add(a=3, b=4)

使用描述

正如我们先前所说的，不仅 xml 中的有效负载是有用的 web 服务特性，描述也是有用的特性。清单 4是一个用于添加服务的 wsdl 文件，它是根据 christopher dix 的原始文件修改而得到的。它是 wsdl 1.1 版本的。

清单 4. 用于添加服务的 wsdl

<?xml version="1.0" encoding="utf-8"?>
<definitions name="adder"
 targetnamespace="http://www.topxml.com/"
 xmlns:tns="http://www.topxml.com/"
 xmlns:xsd="http://www.w3.org/1999/xmlschema"
 xmlns="http://schemas.xmlsoap.org/wsdl/">
 <message name="add">
  <part name="a" type="xsd:double" />
  <part name="b" type="xsd:double" />
 </message>
 <message name="addresponse">
  <part name="param" type="xsd:double" />
 </message>
 <porttype name="adder-port-type">
  <operation name="add">
   <input message="tns:add" />
   <output message="tns:addresponse" />
  </operation>
 </porttype>
 <binding name="adder-soap-binding" type="tns:adder-port-type"
      xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
  <soap:binding transport="http://schemas.xmlsoap.org/soap/http"
         style="rpc"/>
  <operation name="add">
   <soap:operation soapaction="http://tempuri.org/"/>
   <input>
    <soap:body use="encoded" namespace="http://www.topxml.com/"
     encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"/>
   </input>
   <output>
    <soap:body use="encoded" namespace="http://www.topxml.com/"
     encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"/>
   </output>
  </operation>
 </binding>
 <service name="adder-service">
  <port name="adder-port" binding="tns:adder-soap-binding">
   <soap:address location="http://127.0.0.1:8888/add"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
  </port>
 </service>
</definitions>

清单 5提供了一个为端点用户呈现有用信息的 xslt 脚本。它是从先前的 developerworks 文章“wsdl processing with xslt”（请参阅参考资料）中所开发的一个转换改编而来的。它使用了许多*方式（liberty）和快捷方式（尤其是在它处理 wsdl 上下文中的限定名时），但它也许可用于目前使用的大多数 wsdl 1.1 文件。

清单 5. xslt 脚本

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0'
  xmlns:xsl="http://www.w3.org/1999/xsl/transform"
  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
>
 <xsl:output method='html'/>
 <!-- lookup tables for messages, porttypes, bindings and services -->
 <xsl:key name='message' match="wsdl:definitions/wsdl:message"
      use='@name'/>
 <xsl:key name='port-type' match="wsdl:definitions/wsdl:porttype"
      use='@name'/>
 <xsl:key name='binding' match="wsdl:definitions/wsdl:binding"
      use='@name'/>
 <xsl:key name='service' match="wsdl:definitions/wsdl:service"
      use='@name'/>
 <xsl:template match='/'>
  <html>
  <head>
   <title>
service summary: <xsl:value-of select='wsdl:definitions/@name'/>
   </title>
   <meta http-equiv="content-type" content="text/html"
      charset="utf-8"/>
  </head>
  <body>
    <h1>
service summary: <xsl:value-of select='wsdl:definitions/@name'/>
    </h1>
    <p><xsl:value-of select='wsdl:definitions/@documentation'/></p>
    <xsl:apply-templates select="wsdl:definitions/wsdl:service"/>
  </body>
   </html>
  </xsl:template>
  <xsl:template match='wsdl:service'>
   <div style="background: #ccffff">
    service "<xsl:value-of select='@name'/>" hosted at
   <code>
    <xsl:value-of select='wsdl:port/soap:address/@location'/>
   </code>
    <xsl:variable name="binding"
     select="key('binding',
           substring-after(wsdl:port/@binding, ':'))"
    />
    <xsl:variable name="port-type"
     select="key('port-type',
           substring-after($binding/@type, ':'))"
    />
    <xsl:apply-templates select="$port-type/wsdl:operation"/>
   </div>
  </xsl:template>
 <xsl:template match='wsdl:operation'>
  <p>operation "<b><xsl:value-of select='@name'/></b>" message details:</p>
  <!-- yes, should sue css, but keep this example simple -->
  <table border="1" width="50%">
   <tbody>
    <xsl:if test="wsdl:input">
     <xsl:call-template name='message-role'>
      <xsl:with-param name="role-node" select="wsdl:input"/>
     </xsl:call-template>
    </xsl:if>
    <xsl:if test="wsdl:output">
     <xsl:call-template name='message-role'>
      <xsl:with-param name="role-node" select="wsdl:output"/>
     </xsl:call-template>
    </xsl:if>
    <xsl:if test="wsdl:fault">
     <xsl:call-template name='message-role'>
      <xsl:with-param name="role-node" select="wsdl:fault"/>
     </xsl:call-template>
    </xsl:if>
   </tbody>
  </table>
 </xsl:template>
 <xsl:template name='message-role'>
  <xsl:param name="role-node"/>
  <xsl:variable name="role-name"
         select="local-name($role-node)"/>
  <xsl:variable name="message"
   select="key('message',
       substring-after($role-node/@message, ':'))"
   />
  <tr>
   <td><xsl:value-of select='$role-name'/></td>
   <td>
    <table width="100%">
     <xsl:apply-templates select="$message/wsdl:part"/>
    </table>
   </td>
  </tr>
 </xsl:template>
 <xsl:template match='wsdl:part'>
  <tr>
   <td width="50%"><b><xsl:value-of select='@name'/></b></td>
   <td><xsl:value-of select='@type'/></td>
  </tr> 
 </xsl:template>
</xsl:stylesheet>

通常在 web 服务本身所在的主机上提供该服务人性化的 wsdl 描述是很方便的。清单 6是清单 2的变体，它也完成这一任务。它实际上提供三种功能：

对于端口 9000 上的 get 请求：提供该 web 服务调用消息的易于理解的描述
对于端口 8888 上的 get 请求：提供未经处理的 wsdl 文件
对于端口 8888 上的 post 请求：执行 soap 请求。

清单 6. 清单 2 的变体

#http listener code for soap server
import basehttpserver
#the processor class is the core of the xslt api
from ft.xml.xslt import processor
#4xslt uses an inputsource system for reading xml
from ft.xml import inputsource
soap_impl_file = "add.xsl"
wsdl_file = "listing4.xml"
html_view_transform = "listing5.xslt"
class kafkasoaphandler(basehttpserver.basehttprequesthandler):
  def init(cls):
    from ft.lib import uri
    #set up a processor instance to use
    cls.processor = processor.processor()
    #load it with add.xsl
    add_uri = uri.ospathtouri(soap_impl_file, attemptabsolute=1)
    transform = inputsource.defaultfactory.fromuri(add_uri)
    cls.processor.appendstylesheet(transform)
    #now the processor is prepped with a transform and can be used
    #over and over for the same transform
    #prep for wsdl requests
    cls.wsdl = open(wsdl_file).read()
    return
  #make init() a static method of the class
  init = classmethod(init)
  def do_post(self):
    clen = self.headers.getheader('content-length')
    if clen:
      clen = int(clen)
    else:
      print 'post error: missing content-length'
      return
    if self.path != '/add':
      self.send_error(404)
    input_body = self.rfile.read(clen)
    #input_body is the request soap envelope and contents
    response_body = self._run_through_kafka(input_body)
    #response_body is the response soap envelope and contents
    _send_response(self, 200, 'ok', response_body)
    return
  def do_get(self):
    #response_body is the wsdl file
    _send_response(self, 200, 'ok', self.wsdl)
    return
  
  def _run_through_kafka(self, body):
    #in 4suite all inputsources have base uris in case they refer to
    #other uris in some way and resolution is required.
    #the soap messages will not have any such uri references,
    #so use a dummy base uri
    source = inputsource.defaultfactory.fromstring(body, "urn:dummy")
    response = self.processor.run(source)
    return response
class htmlhandler(basehttpserver.basehttprequesthandler):
  def init(cls):
    from ft.lib import uri
    #perform the transform once and store the result
    processor = processor.processor()
    html_desc_uri = uri.ospathtouri(html_view_transform,
                    attemptabsolute=1)
    transform = inputsource.defaultfactory.fromuri(html_desc_uri)
    processor.appendstylesheet(transform)
    wsdl_uri = uri.ospathtouri(wsdl_file, attemptabsolute=1)
    source = inputsource.defaultfactory.fromuri(wsdl_uri)
    cls.html_desc = processor.run(source)
    return
  #make init() a static class method
  init = classmethod(init)
  def do_get(self):
    #response_body is the wsdl file
    _send_response(self, 200, 'ok', self.html_desc)
    return
#turn _send_response into a global function
#for sharing between the classes
def _send_response(handler, code, msg, body):
    #prepare a normal response
    handler.send_response(200, 'ok')
    #send standard htp headers
    handler.send_header('content-type', 'text/html; charset=utf-8')
    handler.send_header("connection", "close")
    handler.send_header("accept-ranges", "bytes")
    handler.send_header('content-length', len(body)-1)
    handler.end_headers()
    #send the response prepared by the soap end point
    handler.wfile.write(body)
    return
 
def soap_listener_function():
  listen_on_port = 8888
  #set up to run on local machine
  server_address = ('127.0.0.1', listen_on_port)
  kafkasoaphandler.init()
  httpd = basehttpserver.httpserver(server_address, kafkasoaphandler)
  print "listening for get and post on port", listen_on_port
  #go into a the main event loop
  httpd.serve_forever()
def html_listener_function():
  listen_on_port = 9000
  #set up to run on local machine
  server_address = ('127.0.0.1', listen_on_port)
  htmlhandler.init()
  httpd = basehttpserver.httpserver(server_address, htmlhandler)
  print "listening for get on port", listen_on_port
  #go into a the main event loop
  httpd.serve_forever()
  return
import time
from threading import thread
soap_thread = thread(none, soap_listener_function)
html_thread = thread(none, html_listener_function)
soap_thread.start()
#pause before spawning the next thread
time.sleep(1)
html_thread.start()

通过在服务器上定义 do_get 和 do_post ，您可以在单个服务器实例上处理 get 和 post 请求，但是因为所使用的简单事件循环的性质，您可以使用线程技术在不同端口上进行侦听。这让您同时运行两个服务器实例。线程技术是方法之一，而使用异步事件处理程序是另一种方法。python 2.2 为更轻松地支持后一种技术而引入了 asyncore 模块，我们在本专栏的上一篇文章中介绍了这种方法（请参阅参考资料）。这一次我们将举例说明线程技术的用法。关于使用线程技术还是使用异步技术的问题，python 2.2 文档提出了很好的建议。

仅当您的程序很大程度上受 i/o 限制时，[异步方法才是] 真正实用的。如果您的程序受处理器限制，那么抢先式调度的线程可能是您所真正需要的。但是，网络服务器很少受处理器限制。

图 1显示了易于理解的 web 服务描述的浏览器视图。

使用Python下的XSLT API进行web开发的简单教程

结束语

请将这一切都看作实验素材。kafka 已经相当落伍了 — 它似乎从 2001 年以来就没有得到过维护，并且它使用了相当差劲的 xslt 样式（其作者坦率地承认自己是个 xslt 菜鸟）。但其思想是非常有用的，并且很有价值。只需要作很小的努力就可以将它更新到 soap 1.2 并扩展其能力。我们所提供的 wsdl 表示转换也只是一个起点。也可以将它更新到 wsdl 1.2 并可扩展它以显示关于 web 服务的更多信息。还应该更新它以利用名称空间轴和其它 xslt 功能以便进行更为正确的处理。

xslt 是一个沙箱，使用各种语言和环境的开发人员都可以在其中施展身手。kafka 是由一位坚定的 .net 开发人员开发的，但我们也可以很快地学会它和利用它。这就是拥有一种既可以处理 xml 也可处理 web 服务的通用语言（lingua franca）的威力。我们预计可以使用用于 web 服务的 xslt 模块的领域将继续扩展。如果是这样，本文所提供的基本技术可能会促使 python 程序员们马上使用这些有用的技术。

使用Python下的XSLT API进行web开发的简单教程