CN1956445A - 一种面向Web服务的门户组件的实现方法 - Google Patents

Abstract

本发明公开了一种面向Web服务的门户组件的实现方法，该方法包括以下步骤：1、根据门户组件规范1.0版本构建门户组件；2、利用SOAP附件机制调用Web服务，解析Web服务返回的带有附件的SOAP报文，得到所要的XML文档；3、利用XML文档转换机制生成用户界面。本发明提出的面向Web服务的门户组件的实现方法符合Java标准定制组织提出的Java规范168号请求：门户组件规范1.0版本，符合业界的主流门户组件规范，便于本发明与其它符合上述门户组件规范的信息门户集成使用，为本发明提供了广阔的使用空间。

Description

一种面向Web服务的门户组件的实现方法

技术领域

本发明涉及一种面向Web服务的门户组件的实现方法。

背景技术

目前，互联网应用技术已经从简单的信息浏览发展到了复杂的分布式应用。Web服务的出现加速了现有各种复杂的分布式应用的集成。Web服务与传统的分布式组件技术相比具有更好的封装性，高度的可集成性以及更好的开放性和互操作性，有着广泛的应用前景。但是，由于Web服务本身不包含展现给用户的页面，用户根本无法理解它返回的XML数据，所以，需要给其提供使得用户能够顺利访问其的页面。在互联网环境下，信息门户(Portal)技术就是向用户提供访问多种类型信息的单一入口，用于从广域网/局域网上分散的数据源集成服务或应用，并且提供个性化定制和单点登录机制来更友好的将软件服务提供给用户使用。信息门户的实现又是以门户组件(Portlet)为基本组成单元，通过门户组件的实现体提供用户界面，完成专门的编程工作展现Web服务，门户组件是一种可插式的页面组件，它与服务器端小程序(Servlet)类似。

将信息门户作为一个内容聚集的平台，用此平台来统一访问和展现Web服务，此工作模式正是在上述背景下出现的一种工作模式。为了将Web服务返回的XML数据转换成用户可以直接查看和理解的信息，需要在信息门户中的各个门户组件的实现体里面提供用户界面，进行专门的编程工作来展现Web服务。一种比较简单的方式就是在信息门户中针对各个Web服务进行特定的编码来创建用户界面。在实际应用中，这种方式会带来应用周期长，重复编码多，数据和展现混杂，Web服务客户端和服务端紧耦合现象等问题。另外一种解决Web服务展现的方式就是通过远程门户组件的Web服务(WSRP)规范所提出的展现方式，创建Web服务的用户界面，其原理就是对门户组件进行Web服务的封装，在Web服务端完成所要展现的内容的开发，生成页面片段返回给信息门户供其直接使用即可。远程门户组件的方式增加了Web服务端的工作量和调用过程中传输的数据量，而且需要所使用的信息门户和Web服务容器都能对远程门户组件的Web服务(WSRP)规范提供支持，制约了它的发展和应用。

发明内容

鉴于上述用信息门户作为一个内容聚集的平台来统一访问和展现Web服务的需要，本发明的主要目的是提供一种新型且符合门户组件规范1.0版本要求的面向Web服务的门户组件的实现方法。

为实现上述目的，本发明采用以下技术方案：一种面向Web服务的门户组件的实现方法，该方法包括以下步骤：

第一步：根据门户组件规范1.0版本构建门户组件；

第二步：利用SOAP附件机制调用Web服务，解析Web服务返回的带有附件的SOAP报文，得到所要的XML文档；

第三步：利用XML文档转换机制将XML文档生成用户界面。

附图说明

图1为表示本发明面向Web服务的门户组件的实现方法的步骤流程图

图2为本发明门户组件具体内容示意图

图3为本发明门户组件工作流程图

图4为本发明利用XSLT处理器转换XML过程示意图

图5为本发明门户组件工作过程示意图

图6为本发明门户组件完整生命周期支撑模块的内容和工作原理示意图

具体实施方式

在阐述本发明面向Web服务的门户组件的实现方法之前，先介绍一下现阶段关于门户组件技术的主流技术规范。现阶段业界主流的门户组件规范是Java标准定制组织(Java Community Process，JCP)提出的Java规范请求168号：门户组件规范1.0版本。在此规范提出的信息门户体系架构中主要牵涉到以下三个主要的基本概念：

①信息门户(Portal)：信息门户是一个Web应用程序，它通常提供不同来源的个性化、单点登录的内容集合。

②门户组件容器(Portlet容器)：门户组件容器给门户组件提供所需的运行时环境，并且管理它们的生命周期。

③门户组件(Portlet)：门户组件为可插式的客户界面组件，可产生各种标记(HTML、XHTML、WML)片段并且统一提供给信息门户。门户组件是信息门户的组成单元，一个信息门户是由其所包含的一系列门户组件所构成的。

Java规范请求168号：门户组件规范1.0版本主要对于门户组件的接口进行了规范，各信息门户提供商可根据自己的需要实现规范，提供一个门户组件容器，或也可以选择购买其他提供商的门户组件容器，信息门户提供商则根据门户组件容器提供的调用接口执行对应的门户组件。门户组件规范包含定义了作为门户组件运行环境的门户组件容器；定义了门户组件容器和门户组件之间的接口；提供了门户组件存储持久性和非持久性数据的机制；提供了门户组件包含服务器端小程序(Servlet)和JSP的机制；定义了门户组件打包，方便部署；保证了门户组件在符合门户组件规范的门户中的移植等内容。

本发明就是根据上述Java标准定制组织提出的Java规范请求168号：门户组件规范1.0版本，设计面向Web服务的门户组件。

本发明的实现方法主要应用于网络环境的系统软件核心技术及运行平台中的信息门户系统中的面向Web服务的门户组件的开发。

一、门户组件的开发

本发明通过采用门户组件技术、利用SOAP附件机制调用Web服务技术和利用XML文档转换机制来生成用户界面完成面向Web服务的门户组件的实现，具体的实现方法是，如图1所示：

第一步：根据门户组件规范1.0版本构建门户组件

本发明根据门户组件规范1.0版本、采用模型--试图--控制的设计模式构建门户组件。如图2所示，该门户组件由门户组件页面文件、门户组件执行文件和门户组件配置文件构成。

根据门户组件规范1.0版本构建门户组件的步骤如下：

①按照此门户组件展现内容编写html文件作为页面文件；

②编写门户组件执行文件定义门户组件参数；

③编写门户组件执行文件实现doView操作；

④判断此门户组件是否支持EDIT模式；如果支持，则编写门户组件执行文件实现doEdit操作，否则，跳到下一步；

⑤判断此门户组件是否支持HELP模式；如果支持，则编写门户组件执行文件实现doHelp操作，否则，跳到下一步；

⑥编写门户组件执行文件实现procession操作；

⑦编写门户组件配置文件。

通过以上步骤，可以开发一个符合门户组件规范1.0版本的门户组件。

第二步：利用SOAP附件机制调用Web服务

构建完成的门户组件利用SOAP附件机制调用Web服务，这是此门户组件工作的核心过程。用户在门户组件页面文件生成的界面上输入自己的请求信息，然后所有的用户请求被封装为标准格式的XML文档，并且将此XML文档作为调用Web服务的参数(SOAP报文的附件)发送给Web服务，并从Web服务处得到结果(也是一个作为SOAP报文附件的XML文档)。如图1、图3所示，上述具体过程如下：

1、获取用户输入的请求信息，参考门户组件对应的Web服务的输入请求的格式文档，构造请求的XML文档，作为调用Web服务的输入参数，并且本地存储；

2、构造SOAP报文，将XML文件作为SOAP报文的附件；

3、访问本门户组件的配置文件，得到本门户组件对应的Web服务的地址信息，调用已经指定好的Web服务，即发送SOAP报文；

4、得到返回的带有附件的SOAP报文，将其附件解析出来，得到所要的XML文档。

第三步：利用XML文档转换机制生成用户界面

如图1、图4所示，具体过程如下：

1、门户组件在得到Web服务返回的结果XML文档之后，依据配置文件中的XSLT样式表文件位置信息，得到此XML文档对应的XSLT样式表文件；

2、将XML文档和XSLT样式表文件送入此门户组件模型模块内嵌的XSLT处理器，利用XML文档转换机制，经过转换处理之后得到相应的用户界面文件(类似HTML文件)，生成用户界面，即此门户组件的界面文件的一个片段，也就是用户所见的输出内容。

利用本发明公开的面向Web服务的门户组件调用和处理Web服务的具体的过程如图5所示：

A、在门户组件初始化阶段访问Web服务，获取其展现逻辑文件并且依据此展现逻辑文件生成Web服务的输入页面；

B、用户在门户组件的输入页面填写并且提交用户请求；

C、门户组件初步处理用户请求，构造Web服务的请求消息SOAP报文，并调用Web服务；

D、得到Web服务的响应消息，提取SOAP报文中的Web服务处理结果数据即XML文档；

E、依据XML文档生成Web服务的输出页面呈现给用户。

二、门户组件的组成定义

此类门户组件由门户组件页面文件、门户组件执行文件和门户组件配置文件构成。门户组件页面文件主要负责展现门户组件的内容和与用户交互的界面，体现为一系列由门户组件执行文件自动生成的用户输入输出页面文件，类似HTML文件；门户组件执行文件主要负责门户组件所要完成的各类操作，主要体现为一系列执行此类门户所要完成操作的JAVA程序，其主要完成对相应的Web服务的调用和根据Web服务返回的结果生成相应的用户界面的过程；门户组件配置文件是记录门户组件特定信息的文件，以此来实现对于门户组件的页面文件和执行文件的相关联，以及对其它门户组件私有信息如名称、简称和日期信息等等的记录。

门户组件的核心部分就是门户组件执行文件，它的核心功能就是将输入输出的参数(XML文档)在共享的数据结构中传递，以及调用Web服务。此执行文件要实现规范中提出的门户组件接口，编程实现以下的内容：

1、门户组件参数：①$renderRequest、②$renderResponse、③$portletConfig、④$actionURL、⑤$renderURL、⑥$namespace，这些参数分别对应了对于此门户组件的请求和响应，以及一些门户组件私有的身份信息。

2、如下的门户组件模式：

①VIEW模式：门户组件的内容显示模式；

②EDIT模式：门户组件相关设置的编辑模式；

③HELP模式：寻求门户组件相关帮助的帮助模式。

3、针对上述门户组件模式，门户组件的操作：

①doView操作：显示显示门户组件缺省视图缺省的浏览视图；

②doEdit操作：如果支持编辑视图的话，显示门户组件编辑视图；

③doHelp操作：如果支持帮助视图的话，显示门户组件帮助视图；

④processAction操作：对于任何视图模式，在门户组件页面文件向执行文件提交请求时触发的操作。

4、门户组件的窗口状态：

①NORMAL状态：还原门户组件窗口；

②MAXIMIZED状态：最大化门户组件窗口；

③MINMIZED状态：最小化门户组件窗口。

在不同的门户组件模式和窗口状态的组合下此门户组件的实现模块可执行的操作如下表所列：

通过实现了上述门户组件的各个部分，也就是门户组件页面文件、门户组件执行文件和门户组件配置文件这三类文件，就可以生成一个可以用来利用SOAP附件机制调用Web服务、利用XML文档转换机制生成用户界面的门户组件。

基于以上内容，本发明还对要访问的Web服务展现界面的资源进行划分，并对面向Web服务的门户组件的生命周期的各阶段进行支持。

三、对于Web服务展现界面的资源划分

Web服务按照传统的定义本身是不包含展现界面的，其传递的只是标准的XML文档，本身在没有响应规则的解释之下是无法提供给用户查看的，所以，我们需要对Web服务所包含的资源进行扩充，在一个Web服务所包含的内容之中加入其展现界面的内容。

Web服务展现界面的资源以一系列格式标准文件的形式，在Web服务里面存放并且可由Web服务向其调用者提供。根据上述的工作过程，展现界面主要使用在两个阶段：用户在调用Web服务之前在门户组件的页面文件上填写并且提交用户请求和用户在门户组件的页面文件上查看Web服务的返回结果。展现界面上要展现的内容就是作为Web服务输入输出的XML文档，但是我们需要为其添加上包括展现内容的XSLT样式表。根据以上的分析，Web服务展现界面的内容包括输入格式和输出格式：输入格式包括要求填入业务数据的XML文档和输入处理格式的输入XSLT样式表文件；输出格式包括返回结果XML文档和输出处理格式的输出XSLT样式表文件。

格式标准文件从来源和内容的角度可以划分为：

1、格式标准文件从来源来说分为输入文件和输出文件；

2、格式标准文件从内容来说分为数据文件和样式文件。

格式标准文件的划分如下表所示：

四、对于面向Web服务的门户组件的生命周期的各阶段的支持

门户组件完整生命周期包括以下各个阶段：门户组件的开发、门户组件的部署、门户组件的运行、门户组件的维护。上述的这四个过程构成了一个门户组件完整的生命周期，可以对门户组件进行全面的和全方位的支持。

门户组件的开发就是门户组件的生成模块根据用户的选择和输入信息生成一个门户组件部署单元的过程。此过程的最终结果就是一个可被发布的门户组件部署单元。信息门户提供给用户访问服务发布与发现(UDDI)服务器的界面，依据用户的选择和输入信息来得到所需要访问的Web服务的相关信息；再通过访问上述选定的Web服务，调用Web服务提供的方法来获取此门户组件的数据和格式文件；再依据和用户的交互信息和格式文件生成一个门户组件所需要的各类资源，包括上述所定义的门户组件模型层、视图层以及记录门户组件相关信息的配置文件等等；最后将上述门户组件资源打包为一个门户组件的部署单元。

门户组件的部署就是将一个门户组件部署单元所定义的门户组件在信息门户中进行发布和注册，使得信息门户的用户可以订制和使用此门户组件的过程。部署过程首先将门户组件部署单元进行解压；将其中的门户组件资源做正确的配置；并且还要在信息门户的注册表中对于此门户组件进行注册，以提供给信息门户的用户来订制和使用。

门户组件的运行主要是对各个门户组件的各个实例进行提供运行时的支持和管理，主要是对Java规范请求168号：门户组件规范1.0版本所提出的门户组件运行时的基本功能的支持，包括对于一个标准的Portlet的3种Portlet模式(VIEW、EDIT和HELP)，3种Portlet操作(doView、doEdit、doHelp和processAction)和4种Portlet的windows状态(NORMAL、MAXIMIZED和MINMIZED)的支持。

门户组件的维护就是对于门户组件的信息进行修改以及当相应的门户组件的资源发生更改，对于此门户组件重新进行自动化的开发和部署以将依据新的资源而重新生成的新的门户组件提供给信息门户的用户使用的过程。门户组件的维护过程对于信息门户用户而言都是透明的。

对门户组件完整生命周期的支撑模块的内容和简单工作原理如图6所示。

本发明提出的面向Web服务的门户组件的实现方法具有以下特点：

1、符合Java标准定制组织提出的Java规范168号请求：门户组件规范1.0版本，符合业界的主流门户组件规范，便于本发明与其它符合上述门户组件规范的信息门户集成使用，为本发明提供了广阔的使用空间。

2、本发明构建的门户组件采用模型-试图-控制的设计模式，具有很好的清晰的层次性、良好强壮性和弹性以及易于维护性。

3、本发明提供了便捷的、透明的在信息门户中访问和展现符合此类门户组件扩充规范的Web服务；同时也对此类Web服务的开发提供模板和类库的支持。

4、提供对此门户组件完整的生命周期开发的支持，使得使用此门户组件的信息门户平台可以方便快捷的维护此类门户组件完整的生命周期。便于信息门户平台管理人员的开发、部署、配置、使用和维护此类门户组件。

Claims (5)

1、一种面向Web服务的门户组件的实现方法，该方法包括以下步骤：

第一步：根据门户组件规范1.0版本构建门户组件；

第二步：利用SOAP附件机制调用Web服务，解析Web服务返回的带有附件的SOAP报文，得到所要的XML文档；

第三步：利用XML文档转换机制将XML文档生成用户界面。

2、根据权利要求1所述的一种面向Web服务的门户组件的实现方法，其特征在于：所述的门户组件由门户组件页面文件、门户组件执行文件和门户组件配置文件构成；

所述门户组件页面文件主要负责展现门户组件的内容和与用户交互的界面，体现为一系列由门户组件执行文件自动生成的用户输入输出页面文件；

所述门户组件执行文件主要负责门户组件所要完成的各类操作，为一系列执行此类门户所要完成操作的JAVA程序，其主要完成对相应的Web服务的调用和根据Web服务返回的结果生成相应的用户界面的过程；

所述门户组件配置文件是记录门户组件特定信息的文件，以此来实现对于门户组件的页面文件和执行文件的相关联，以及对其它门户组件私有信息如名称、简称和日期信息等等的记录。

3、根据权利要求2所述的面向Web服务的门户组件的实现方法，其特征在于：所述根据门户组件规范1.0版本构建门户组件的步骤如下：

(1)、按照此门户组件展现内容编写html文件作为页面文件；

(2)、编写门户组件执行文件定义门户组件参数；

(3)、编写门户组件执行文件实现doView操作；

(4)、判断此门户组件是否支持EDIT模式；如果支持，则编写门户组件执行文件实现doEdit操作，否则，跳到下一步；

(5)、判断此门户组件是否支持HELP模式；如果支持，则编写门户组件执行文件实现doHelp操作，否则，跳到下一步；

(6)、编写门户组件执行文件实现procession操作；

(7)、编写门户组件配置文件。

4、根据权利要求3所述的面向Web服务的门户组件的实现方法，其特征在于：所述第二步具体包括以下步骤：

(1)、获取用户输入的请求信息，参考门户组件格式文档XSLT样式表文件，构造请求的XML文档，作为调用Web服务的输入参数，并且本地存储；

(2)、构造SOAP报文，将XML文件作为SOAP报文的附件；

(3)、访问本门户组件的配置文件，得到本门户组件对应的Web服务的地址信息，调用已经指定好的Web服务，即发送SOAP报文；

(4)、得到返回的带有附件的SOAP报文，将其附件解析出来，得到所要的XML文档。

5、根据权利要求4所述的面向Web服务的门户组件的实现方法，其特征在于：所述第三步具体包括以下步骤：

(1)、门户组件在得到Web服务返回的结果XML文档之后，依据配置文件中的XSLT样式表文件位置信息，得到此XML文档对应的XSLT样式表文件；

(2)、将XML文档和XSLT样式表文件送入此门户组件模型模块内嵌的XSLT处理器，利用XML文档转换机制，经过转换处理之后得到相应的用户界面文件，生成用户界面。

Images