WebService接口WSDL及Java调用流程
一、WebService接口WSDL是什么
WebService接口WSDL(Web Services Description Language)是一种用于描述Web服务的语言,它基于XML语言,描述了如何访问一个Web服务以及Web服务的参数和数据类型等信息。使用WSDL语言可以方便开发人员快速构建Web服务。一个WSDL文件包含了Web服务的全部描述信息,可以视为Web服务的契约,客户端通过WSDL文档描述文件可以了解到WebService所提供的服务内容、调用方式和参数等信息。
二、Java调用WebService接口WSDL的流程
Java调用WebService接口WSDL分为以下几个步骤:
- 导入WebService接口WSDL文件
- 创建SOAP请求消息
- 发送SOAP请求消息
- 解析SOAP响应消息
三、导入WebService接口WSDL文件
在Java中,我们可以通过JAX-WS工具将WSDL文件导入为一个Java类,用于WebService的调用。导入WSDL文件的方式有两种:
- 使用
wsimport
工具命令自动生成Java类wsimport -p com.example.webservice.client -keep http://localhost:8080/HelloWorld?wsdl
- 手工编写Java类 手工编写Java类需要根据WSDL文件中的信息,手动构建WebService客户端。构建客户端的主要步骤是:创建服务(Service)、创建端口(Port)、创建绑定(Binding)、创建QName、创建请求参数等。
四、创建SOAP请求消息
SOAP消息格式分为请求和响应两个部分,通过构造SOAP消息的XML格式提供请求及响应的信息,其中请求XML格式遵照SOAP协议规范,XML必须包含SOAP消息头和SOAP消息体两个部分。SOAP消息体根据WebService服务器端需要调用的接口方法及方法的参数进行组装,SOAP消息头包含一些必须的标记和客户端自定义的标记,用于描述请求及响应的消息属性信息。
// 创建 service 实例
HelloWorldService service = new HelloWorldService();
// 从 service 中获取 port 实例
HelloWorld port = service.getHelloWorldPort();
// 组装请求消息
BindingProvider bp = (BindingProvider) port;
SOAPMessage requestMsg = MessageFactory.newInstance().createMessage();
SOAPPart soapPart = requestMsg.getSOAPPart();
SOAPEnvelope soapEnvelope = soapPart.getEnvelope();
SOAPBody soapBody = soapEnvelope.getBody();
QName bodyName = new QName(service.getNamespaceURI(), "getHelloWorldAsString", "ns1");
SOAPBodyElement bodyElement = soapBody.addBodyElement(bodyName);
五、发送SOAP请求消息
使用JDK提供的HttpURLConnection
或Apache提供的HttpClient
等HTTP请求工具向WebService服务端发送SOAP消息请求,获取SOAP响应消息,将响应消息转化为Java对象,以供调用者使用。
// 发送请求,并获取响应
URL endpoint = new URL("http://localhost:8080/HelloWorld");
HttpURLConnection conn = (HttpURLConnection) endpoint.openConnection();
ByteArrayOutputStream bout = new ByteArrayOutputStream();
requestMsg.writeTo(bout);
byte[] bytes = bout.toByteArray();
conn.setRequestProperty("Content-Length", String.valueOf(bytes.length));
conn.setRequestProperty("Content-Type", "text/xml;charset=UTF-8");
conn.setRequestProperty("SOAPAction", service.getNamespaceURI() + "getHelloWorldAsString");
conn.setDoOutput(true);
conn.getOutputStream().write(bytes);
ByteArrayInputStream bi = new ByteArrayInputStream(getBytes(conn));
SOAPMessage responseMsg = MessageFactory.newInstance().createMessage(null, bi);
conn.disconnect();
六、解析SOAP响应消息
解析响应SOAP消息的过程就是将一个XML格式的SOAP响应消息转换为Java对象,从中提取需要的业务数据。SOAP响应消息同样包含SOAP消息头和SOAP消息体。
// 解析响应消息
SOAPEnvelope resEnvelope = responseMsg.getSOAPPart().getEnvelope();
SOAPBody resBody = resEnvelope.getBody();
Iterator iterator = resBody.getChildElements(bodyName);
if (iterator.hasNext()) {
SOAPBodyElement bodyElement = (SOAPBodyElement) iterator.next();
String retStr = bodyElement.getTextContent();
}
七、总结
以上是Java调用WebService接口WSDL的详细流程,通过了解WSDL文件的定义、创建SOAP请求、发送SOAP请求以及解析SOAP响应等步骤,我们能够更加方便地实现WebService客户端的开发。