目录

WebService1、概述2、Java WebService规范2.1、JAX-WS2.2、JAXM&SAAJ2.3、JAX-RS

3、服务端实现（JAX-WS）4、WSDL5、UDDI6、实现客户端6.1、wsimport生成客户端（JAX-WS）6.2、Service编程调用（JAX-WS）6.3、HttpURLConnection调用6.4、HttpClient调用6.5、Hutool工具包调用

7、注解描述WSDL

WebService

1、概述

Web Service技术， 能使得运行在不同机器上的不同应用无须借助附加的、专门的第三方软件或硬件， 就可相互交换数据或集成。依据Web Service规范实施的应用之间， 无论它们所使用的语言、 平台或内部协议是什么， 都可以相互交换数据。

简单的说，WebService就是一种跨编程语言和跨操作系统平台的远程调用技术。所谓跨编程语言和跨操作平台，就是说服务端程序采用java编写，客户端程序则可以采用其他编程语言编写，反之亦然。跨操作系统平台则是指服务端程序和客户端程序可以在不同的操作系统上运行。 远程调用，就是一台计算机的应用可以调用其他计算机上的应用。例如：支付宝，支付宝并没有银行卡等数据，它只是去调用银行提供的接口来获得数据。还有天气预报等，也是气象局把自己的系统服务以webservice服务的形式暴露出来，让第三方网站和程序可以调用这些服务功能。

WebService原理：

XML,SOAP和WSDL就是构成WebService平台的三大技术 。

WebService采用Http协议来在客户端和服务端之间传输数据。WebService使用XML来封装数据，XML主要的优点在于它是跨平台的。WebService通过HTTP协议发送请求和接收结果时，发送的请求内容和结果内容都采用XML格式封装，并增加了一些特定的HTTP消息头，以说明HTTP消息的内容格式，这些特定的HTTP消息头和XML内容格式就是SOAP协议规定的。WebService服务器端首先要通过一个WSDL文件来说明自己有什么服务可以对外调用。简单的说，WSDL就像是一个说明书，用于描述WebService及其方法、参数和返回值。 WSDL文件保存在Web服务器上，通过一个url地址就可以访问到它。客户端要调用一个WebService服务之前，要知道该服务的WSDL文件的地址。WebService服务提供商可以通过两种方式来暴露它的WSDL文件地址：1.注册到UDDI服务器，以便被人查找；2.直接告诉给客户端调用者。

2、Java WebService规范

Java 中共有三种WebService 规范，分别是<code>JAXM&SAAJ、JAX-WS（JAX-RPC）、JAX-RS。

2.1、JAX-WS

JAX-WS (JavaTM API for XML-Based Web Services) 规范是一组 XML web services 的 JAVA API。JAX-WS 允许开发者可以选择 RPC-oriented 或者 message-oriented 来实现自己的 web services。

在 JAX-WS 中，一个远程调用可以转换为一个基于 XML 的协议例如 SOAP。在使用 JAX-WS 过程中，开发者不需要编写任何生成和处理 SOAP 消息的代码。JAX-WS 的运行时实现会将这些 API 的调用转换成为对应的 SOAP 消息。

在服务器端，用户只需要通过 Java 语言定义远程调用所需要实现的接口 SEI (service endpoint interface)，并提供相关的实现，通过调用 JAX-WS 的服务发布接口就可以将其发布为 WebService 接口。

在客户端，用户可以通过 JAX-WS 的 API 创建一个代理（用本地对象来替代远程的服务）来实现对于远程服务器端的调用。

当然 JAX-WS 也提供了一组针对底层消息进行操作的 API 调用，你可以通过 Dispatch 直接使用 SOAP 消息或 XML 消息发送请求或者使用 Provider 处理 SOAP 或 XML 消息。

通过 web service 所提供的互操作环境，我们可以用 JAX-WS 轻松实现 JAVA 平台与其他编程环境 (.net 等) 的互操作。

JAX-WS 与 JAX-RPC 之间的关系：

Sun 最开始的 web services 的实现是 JAX-RPC 1.1 (JSR 101)。这个实现是基于 Java 的 RPC, 并不完全支持 schema 规范，同时没有对 Binding 和 Parsing 定义标准的实现。

JAX-WS2.0 (JSR 224) 是 Sun 新的 web services 协议栈，是一个完全基于标准的实现。在 binding 层，使用的是 the Java Architecture for XML Binding (JAXB, JSR 222)，在 parsing 层，使用的是 the Streaming API for XML (StAX, JSR 173)，同时它还完全支持 schema 规范。

2.2、JAXM&SAAJ

JAXM（JAVA API For XML Message）主要定义了包含了发送和接收消息所需的API，相当于Web 服务的服务器端，其API 位于javax.messaging.*包，它是Java EE 的可选包，因此你需要单独下载。

SAAJ（SOAP With Attachment API For Java，JSR 67）是与JAXM 搭配使用的API，为构建SOAP 包和解析SOAP 包提供了重要的支持，支持附件传输，它在服务器端、客户端都需要使用。这里还要提到的是SAAJ 规范，其API 位于javax.xml.soap.*包。

JAXM&SAAJ 与JAX-WS 都是基于SOAP 的Web 服务，相比之下JAXM&SAAJ 暴漏了SOAP更多的底层细节，编码比较麻烦，而JAX-WS 更加抽象，隐藏了更多的细节，更加面向对象，实现起来你基本上不需要关心SOAP 的任何细节。那么如果你想控制SOAP 消息的更多细节，可以使用JAXM&SAAJ。

2.3、JAX-RS

JAX-RS 是JAVA 针对REST(Representation State Transfer)风格制定的一套Web 服务规范，由于推出的较晚，该规范（JSR 311，目前JAX-RS 的版本为1.0）并随JDK1.6 一起发行。

基于JAX-RS实现的框架有Jersey，RESTEasy等。这两个框架创建的应用可以很方便地部署到Servlet 容器中，比如Tomcat，JBoss等。值得一提的是RESTEasy是由JBoss公司开发的，所以将用RESTEasy框架实现的应用部署到JBoss服务器上，可以实现很多额外的功能。

3、服务端实现（JAX-WS）

编写SEI(Service Endpoint Interface)，SEI在webservice中称为portType，在java中就是普通接口：

public interface UserService {

public String sayHi(String name);

public String work(String work);

public User getUser(User user);

}

public class User {

private int id;

private String name;

private Date birthday;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public Date getBirthday() {

return birthday;

}

public void setBirthday(Date birthday) {

this.birthday = birthday;

}

@Override

public String toString() {

return "User{" +

"id=" + id +

", name='" + name + '\'' +code>

", birthday=" + birthday +

'}';

}

}

编写SEI实现类，此类作为webservice提供服务类:

//@WebService表示该类是一个服务类，需要发布其中的public方法

@WebService

public class UserServiceImpl implements UserService {

@Override

public String sayHi(String name) {

return "Hi, " + name;code>

}

@Override

public String work(String work) {

return "He is working " + work;

}

@Override

public User getUser(User user) {

user.setName(user.getName() + "-service");

return user;

}

}

发布服务，Endpoint类发布服务，publish方法，两个参数：

服务地址;服务实现类;

public class Server {

public static void main(String[] args) {

//发布WebService

String wsAddress = "http://localhost:8888/demo/ws";

Endpoint endpoint = Endpoint.publish(wsAddress, new UserServiceImpl());

System.out.println("webservice发布成功：" + endpoint.isPublished());

}

}

测试服务是否发布成功，通过阅读wsdl，确定客户端调用的接口、方法、参数和返回值存在，证明服务发布成功:

//浏览器输入 http://localhost:8888/demo/ws?wsdl 来获取wsdl文件进行阅读

//wsdl,是以XML文件形式来描述WebService的”说明书”,有了说明书,我们才可以知道如何使用或是调用这个服务.

4、WSDL

<code>public class DateUtils {

/**

* 将Date类转换为XMLGregorianCalendar

*

* @param date

* @return

*/

public static XMLGregorianCalendar dateToXmlDate(Date date){

Calendar cal = Calendar.getInstance();

cal.setTime(date);

DatatypeFactory dtf = null;

try {

dtf = DatatypeFactory.newInstance();

XMLGregorianCalendar dateType = dtf.newXMLGregorianCalendar();

dateType.setYear(cal.get(Calendar.YEAR));

//由于Calendar.MONTH取值范围为0~11,需要加1

dateType.setMonth(cal.get(Calendar.MONTH)+1);

dateType.setDay(cal.get(Calendar.DAY_OF_MONTH));

dateType.setHour(cal.get(Calendar.HOUR_OF_DAY));

dateType.setMinute(cal.get(Calendar.MINUTE));

dateType.setSecond(cal.get(Calendar.SECOND));

return dateType;

} catch (DatatypeConfigurationException e) {

e.printStackTrace();

}

return null;

}

/**

* 将XMLGregorianCalendar转换为Date

*

* @param cal

* @return

*/

public static Date xmlDate2Date(XMLGregorianCalendar cal){

return cal.toGregorianCalendar().getTime();

}

}

客户端：

public class Client {

public static void main(String[] args) {

//1. 创建一个webservice的客户端

UserServiceImplService userService = new UserServiceImplService();

//2, 获取远程服务实现对象

UserServiceImpl us = userService.getUserServiceImplPort();

//3. 直接调用远程服务实现对象的方法

String hi = us.sayHi("tom");

System.out.println(hi);

String work = us.work("Java");

System.out.println(work);

User user = new User();

user.setId(100);

user.setName("jerry");

user.setBirthday(DateUtils.dateToXmlDate(new Date()));

User u = us.getUser(user);

System.out.println(u.getId() + "," + u.getName() + "," + u.getBirthday());

}

}

输出：

Hi, tom

He is working Java

100,jerry-service,2023-12-20T21:10:49+08:00

6.2、Service编程调用（JAX-WS）

该种方式可以自定义命名空间，服务视图名等元素，方便以后维护，是一种标准的开发方式 。

服务接口：

//指明portType元素的的name属性值

@WebService(name = "UserServiceImpl")

public interface UserService {

public String sayHi(String name);

public String work(String work);

public User getUser(User user);

}

客户端：

public class Client2 {

public static void main(String[] args) throws IOException {

//创建WSDL文件的URL

URL wsdlDocumentLocation = new URL("http://localhost:8888/demo/ws?wsdl");

//创建服务名称

//1. namespaceURI-命名空间地址即definitions元素的targetNamespace属性值

//2. localPart 服务名即service元素的name属性值

QName serviceName = new QName("http://server.demo.zhang.pers/", "UserServiceImplService");

Service service = Service.create(wsdlDocumentLocation, serviceName);

//获取服务实现类 UserService接口中需要@WebService(name = "UserServiceImpl")指明portType的name

UserService us = service.getPort(UserService.class);

//调用方法

String tom = us.sayHi("tom");

System.out.println(tom);

String work = us.work("Java");

System.out.println(work);

User user = new User();

user.setId(100);

user.setName("jerry");

user.setBirthday(new Date());

User u = us.getUser(user);

System.out.println(u.getId() + "," + u.getName() + "," + u.getBirthday());

}

}

输出：

Hi, tom

He is working Java

100,jerry-service,Wed Dec 20 22:59:26 CST 2023

6.3、HttpURLConnection调用

这种方式是由自己编写客户端，手动拼接请求体，不再由工具生成，比较麻烦:

第一步：创建服务地址第二步：打开一个通向服务地址的连接第三步：设置参数第四步：组织SOAP数据，发送请求第五步：接收服务端响应

首先需要查看请求体的xml结构定义，即schemaLocation的地址。访问http://localhost:8888/demo/ws?xsd=1：

<code>public class Client3 {

public static void main(String[] args) throws Exception {

//第一步：创建服务地址，不是WSDL地址

URL url = new URL("http://localhost:8888/demo/ws");

//第二步：打开一个通向服务地址的连接

HttpURLConnection connection = (HttpURLConnection) url.openConnection();

//第三步：设置参数

//3.1发送方式设置：POST必须大写

connection.setRequestMethod("POST");

//3.2设置数据格式：content-type

connection.setRequestProperty("content-type", "text/xml;charset=UTF-8");

//3.3设置输入输出，因为默认新创建的connection没有读写权限，

connection.setDoInput(true);

connection.setDoOutput(true);

//第四步：组织SOAP数据，发送请求

User user = new User();

user.setId(100);

user.setName("jerry");

user.setBirthday(new Date());

String soapXML = getUserXML(user);

OutputStream os = connection.getOutputStream();

os.write(soapXML.getBytes());

//第五步：接收服务端响应，打印，解析

int responseCode = connection.getResponseCode();

if(200 == responseCode){ //表示服务端响应成功

InputStream is = connection.getInputStream();

//将字节流转换为字符流

InputStreamReader isr = new InputStreamReader(is,"utf-8");

//使用缓存区

BufferedReader br = new BufferedReader(isr);

StringBuilder sb = new StringBuilder();

String temp = null;

while(null != (temp = br.readLine())){

sb.append(temp);

}

//输出响应体xml

System.out.println(sb.toString());

//解析xml

DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();

DocumentBuilder db = dbf.newDocumentBuilder();

Document doc = db.parse(new ByteArrayInputStream(sb.toString().getBytes()));

NodeList nodeList = doc.getElementsByTagName("return").item(0).getChildNodes();

System.out.println("解析User：");

System.out.println("birthday:" + nodeList.item(0).getFirstChild().getNodeValue());

System.out.println("id:" + nodeList.item(1).getFirstChild().getNodeValue());

System.out.println("name:" + nodeList.item(2).getFirstChild().getNodeValue());

is.close();

isr.close();

br.close();

}

os.close();

}

public static String getSayHiXML(String name){

String soapXML = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"

+"<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"

+"<soap:Body>"

+"<ns2:sayHi xmlns:ns2=\"http://server.demo.zhang.pers/\">"

+ "<arg0>" + name + "</arg0>"

+"</ns2:sayHi>"

+"</soap:Body>"

+"</soap:Envelope>";

return soapXML;

}

public static String getWorkXML(String name){

String soapXML = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"

+"<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"

+"<soap:Body>"

+"<ns2:work xmlns:ns2=\"http://server.demo.zhang.pers/\">"

+ "<arg0>" + name + "</arg0>"

+"</ns2:work>"

+"</soap:Body>"

+"</soap:Envelope>";

return soapXML;

}

public static String getUserXML(User user){

String soapXML = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"

+"<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"

+"<soap:Body>"

+"<ns2:getUser xmlns:ns2=\"http://server.demo.zhang.pers/\">"

+ "<arg0>"

+ "<birthday>" + DateUtils.dateToXmlDate(user.getBirthday()) + "</birthday>"

+ "<id>" + user.getId() + "</id>"

+ "<name>" + user.getName() + "</name>"

+ "</arg0>"

+"</ns2:getUser>"

+"</soap:Body>"

+"</soap:Envelope>";

return soapXML;

}

}

输出：

<?xml version="1.0" ?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><ns2:getUserResponse xmlns:ns2="http://server.demo.zhang.pers/"><return><birthday>2023-12-21T14:55:41+08:00</birthday><id>100</id><name>jerry-service</name></return></ns2:getUserResponse></S:Body></S:Envelope>code>

解析User：

birthday:2023-12-21T14:55:41+08:00

id:100

name:jerry-service

6.4、HttpClient调用