webservice,数据接口规范

webservice,数据接口规范篇一：webservice 技术在数据接口方面的应用Webservice 技术在数据接口方面的应用 一，项目的需求和背景： 1.具备客户资料管理系统的省公司，原有客户资料管理系统能够提供满足客户及业务查询需求的系统接口。 2.根据本规范中关于客户资料查询接口的要求，改造本省客户资料管理系统，提供符合规范要求的WebService 接口，供集团故障单管理系统访问。 3.各省公司需使本省客户资料管理系统（或数据库服务器）提供通过 DCN 的访问方式。 二，为何使用webservice 技术： 1.全国集中的信息化建设项目具备的一个最主要的特点是各个省市地区技术力量，数据库环境不尽相同，在这种分散的异构数据环境下实施数据集成项目的开发，如果采用数据库直联 dblink 等方式取得数据困难相对较大。 2.对于业务密集型的项目和集团方提供的相对明确和稳定的数据需求，由于 webservice 技术有很好的封装性，集成性，数据传输透明性，框架稳定性，而且技术发展也比较成熟，适合使用 webservice 技术来规避在实施项目过程中由于各个省业务模型的异构造成的项目间复杂性和依赖性。 综上，并根据项目的需求结合我们黑龙江省的实际情况适合采用 webservice 技术。 三，入门背景知识： 一.Web Service 简介 1.定义 由两部分组成 SOAP-Web Service 之间的基本通信协议。 WSDL-Web Service 描述语言，它定义了 Web Service 做什么，怎么做和查询的信息。 2.简单的 Web Service 实现 包含四个基本步骤 创建 Web Service 的商业逻辑（通常是一些 Java类） 将这些 Java 类部署到一个 SOAP 服务器上生成客户访问代码 部署客户应用 注意：WSDL 等文件的生成通常是利用厂商提供的工具来完成 解析 WSDL 描述语言一般包含三部分 What 部分-包括了 type、message 和 portType 元素 Type：定义了 Web Service 使用的数据结构（使用XML Schema 定义） Message：一个 Message 是 SOAP 的基本通信元素。每个 Message 可以有一个或多个 Part，每个 Part 代表一个参数。 PortType：消息汇总为不同的操作并归入到一个被称为 portType 的实体中。一个 portType 代表一个接口（Web Service 支 持的操作集合） ，每个 Web Service 可以有多个接口，它们都使用 portType 表示。每个操作又包含了input 和 output 部分。 How 部分-包含 binding 元素 binding 元素将 portType 绑定到特定的通信协议上（如 HTTP 上的 SOAP 协议） Where 部分-由 service 元素组成 它将 portType,binding 以及 Web Service 实际的位置（URI）放在一起描述 4.客户端 通常 Web Service 可以有三种类型的客户 商业伙伴（Business Partner）-包括分发商，零售商以及大型消费者） 此类客户通过 SOAP、WSDL、ebXML、UDDI 等 XML 技术与 Web Service 连接 瘦客户-包括 Web 浏览器、PDA 以及无线设备 该类客户通常经由轻量协议(如 HTTP)与 Web Service连接 肥客户-包括 Applet、各类应用以及现存 通常使用重量级协议（如 IIOP）连接 Web Service 二，JDOM 简介 JDOM 是一个开源项目，它基于树型结构，利用纯JAVA 的技术对 XML 文档实现解析、生成、序列化以及多种操作。JDOM 直接为 JAVA 编程服务。它利用更为强有力的JAVA 语言的诸多特性（方法重载、集合概念以及映射） ，把SAX 和 DOM 的功能有效地结合起来。在使用设计上尽可能地隐藏原来使用 XML 过程中的复杂性。利用 JDOM 处理 XML 文档将是一件轻松、简单的事。 DOM 的缺点主要是来自于由于 Dom 是一个接口定义语言（IDL）,它的任务是在不同语言实现中的一个最低的通用标准，并不是为 JAVA 特别设计的。这标志着 JDOM 成为了 JAVA 平台组成的一部分。 四，接口的实现： Webservice 开发环境的配置和准备： 配置 webservice 的 java 开发环境我们只需要安装 jdk,开发工具就可以了。当前的流行开发工具基本都支持针对于webservice 的 IDE。本次项目我选用了 jbuilder。要获得运行的 Web service，必须有一个能驻留该服务的应用服务器。Web service 可以选择在任何公共的UDDI（Universal Description, Discovery and Integration，统一描述、发现和集成协议）注册库注册，或在驻留在应用服务器上的本地 UDDI 注册库注册。UDDI 向潜在的业务客户机提供地址薄功能；它允许客户机定位特定服务，并描述了哪种 API 可用。如果没有 UDDI 注册库，业务客户机可以（并且常常会）直接转向一个 Web service URL 并请求 WSDL（Web Service Definition Language，Web service 描述语言）文档，文档中同样包含有关提供了哪些 API 的详细描述。WSDL 是驻留在应用服务器中的 XML 文档。 Web service 以 Web 应用程序的形式驻留在应用服务器上的 Web service 容器中。任何感兴趣的客户机都可以启动常规 HTTP 会话与其交互。我们将使用 BEA WebLogic应用服务器来建立 Web service，它是业内的主流平台之一。若用于开发，BEA WebLogic 应用服务器可以免费使用，用于生产则需要许可证。作为替代方案，也可以使用免费的Tomcat 应用服务器和 Axis 工具箱，或者使用 Jetty 应用服务器和 Axis 工具箱。当然还有其他应用服务器，典型的应用服务器如 JBoss、Sun Microsystems 的 SunOne、IBM 的WebSphere。 配置第一步：配置应用服务器 配置第二步：创建项目 配置第三步：创建 Web 服务 配置第四步：将代码公开为Web service开发过程一共分为三步： 第一步，分解需求，梳理需求规格说明书里面的处理流程和数据项。并构造用例文档和 ER 模型。 第二步，构造框架，根据用例模型和 ER 模型，构造出程序处理流程，生成各个实体和用例类的基本框架结构属性和方法。框架分为三部分：业务处理层次，接口封装实现层次，元数据流模型构造层次。 第三步，逐步实现求精。对于经过构造框架分解后得到的三个处理层次逐步求精。并拼装各 个层次的实现。这样就完成了 webservice 的构建过程。五，技术难点： 1.如何解析数据并对数据加封装并越过解析器的过滤问题： 对于数据加密和传输过程中携带数据的封装问题经过研究把这个难题顺利的攻关。 如下的代码就是解决这个问题的关键所在： DocumentBuilderFactorydbf=(); DocumentBuilderdb=(); Documentdoc=(newFileInputStream(“); Elemente=(); NodeListnl=(); for(inti=0;i Noden=(i); if()=_SECTION_NODE) (); 2.如何利用好 JDOM 做数据流分析： 在实施过程中遇到如何用 java 语言实现这项技术。在经过一番甄选之后我们得出结论适合于本项目开发的java 分布式对象模型技术实现方案，那就是 JDOM。 它有如下好处可以被我们利用： 是一个开源项目，它基于树型结构，利用纯 JAVA 的技术对 XML 文档实现解析、生成、序列化以及多种操作。 直接为 JAVA 编程服务。它利用更为强有力的 JAVA语言的诸多特性（方法重载、集合概念以及映射） ，把 SAX和 DOM 的功能有效地结合起来。 3.在使用设计上尽可能地隐藏原来使用 XML 过程中的复杂性。利用 JDOM 处理 XML 文档将是一件轻松、简单的事。如果你想对这个开发工具了解更多我们可以参照 http:/ 篇二：WebService 接口说明篇三：Web Services 业务接口规范说明书 XXXX 系统 Web Services 业务接口规范说明书 拟 制审 核 会 签 批 准 【公司名称】 版本历史目 录1. 范围 . 1 2. 术语、定义和缩略语 . 1 术语、定义 . 1 缩略语 . 1 3. 接口设计 . 1 接口公共参数 . 1 请求参数 . 1 返回参数 . 2 业务功能接口 . 3 业务模块 1 .3 4. MD5 加密 . 6 5. 参考文献 . 6 1. 范围本规范文档主要适用于 XXXX 系统和其它业务系统信息数据的接入。 2. 术语、定义和缩略语 术语、定义 缩略语3. 接口设计接口公共参数 接口服务器通过：http:/IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的 xml 格式进行封装。 请求参数 1. 请求类型为 String 类型 2. 头部参数体 head 定义 请求参数的头部参数体 header 格式固定，定义如下：3. 请求参数体 param 定义参数体 param 中的具体请求参数，根据不同的业务而不同