如何从 Java 类调用 SOAP Web 服务？
Posted
技术标签:
【中文标题】如何从 Java 类调用 SOAP Web 服务？【英文标题】：How to do a SOAP Web Service call from Java class? 【发布时间】：2013-04-03 03:26:41 【问题描述】：我对 web 服务世界比较陌生，我的研究似乎让我感到困惑而不是启发我，我的问题是我得到了一个库（jar），我必须用一些 web 服务功能扩展它。
这个库将共享给其他开发人员，并且 jar 中的类将是具有调用 web 服务的方法的类（本质上设置类的属性，执行一些业务逻辑，例如将对象存储在一个数据库等，并用这些修改发回对象）。我想让对这个服务的调用尽可能简单，希望尽可能简单，以便使用该类的开发人员只需要这样做。
Car c = new Car("Blue");
c.webmethod();
我一直在研究在服务器上使用 JAX-WS，但在我看来，我不需要在服务器上创建 wsimport，也不需要在客户端上创建 wsimport，因为我知道两者都有类，我只需要在服务器和客户端共享的类之间进行一些交互。你认为在课堂上做 web 服务和调用有什么意义？
【问题讨论】：
你的问题有点不清楚。您要创建的方法将 (1) 从 Web 服务获取对象； (2) 稍微处理一下对象； (3) 将其发布回 Web 服务。是这样吗？ 不，对象会在客户端创建，在调用中会发送给ws，ws会设置一个变量，比如currentTime，做一些业务逻辑之类的存储在里面一个 db，然后用现在设置的 currentTime 将对象发送回客户端。希望我能更好地解释自己。谢谢。 【参考方案1】：我了解您的问题归结为如何从 Java 调用 SOAP (JAX-WS) Web 服务并获取其返回对象。在这种情况下，您有两种可能的方法：
-
通过
wsimport生成Java类并使用；或
创建一个 SOAP 客户端：
-
将服务的参数序列化为 XML；
通过HTTP操作调用web方法；和
将返回的 XML 响应解析回对象。
关于第一种方法（使用wsimport）：
我看到您已经拥有服务（实体或其他）业务类，事实上wsimport 生成了一组全新的类（它们在某种程度上与您已有的类重复）。
不过，恐怕在这种情况下，您只能：
调整（编辑）wsimport 生成的代码以使其使用您的业务类（这很困难，而且不知何故不值得 - 请记住，每次 WSDL 更改时，您都必须重新生成并重新调整代码）；或
放弃并使用wsimport 生成的类。 （在这个解决方案中，您的业务代码可以“使用”生成的类作为来自另一个架构层的服务。）
关于第二种方法（创建您的自定义 SOAP 客户端）：
为了实现第二种方法，您必须：
-
拨打电话：
使用 SAAJ（SOAP with Attachments API for Java）框架（见下文，Java SE 1.6 或更高版本随附）进行调用；或
您也可以通过
java.net.HttpUrlconnection 进行操作（以及一些java.io 处理）。
将对象与 XML 相互转换：
使用 OXM（对象到 XML 映射）框架（例如 JAXB）将 XML 序列化/反序列化到对象中
或者，如果必须，手动创建/解析 XML（如果接收到的对象与发送的对象只有一点点不同，这可能是最好的解决方案）。
使用经典的java.net.HttpUrlConnection 创建一个 SOAP 客户端并不难（但也不是那么简单），您可以在 this link 中找到一个非常好的起始代码。
我推荐你使用 SAAJ 框架：
SOAP with Attachments API for Java (SAAJ) 主要用于直接处理在任何 Web 服务 API 中发生在幕后的 SOAP 请求/响应消息。它允许开发人员直接发送和接收肥皂消息，而不是使用 JAX-WS。
请看下面一个使用 SAAJ 的 SOAP Web 服务调用的工作示例（运行它！）。它调用this web service。
import javax.xml.soap.*;
public class SOAPClientSAAJ
// SAAJ - SOAP Client Testing
public static void main(String args[])
/*
The example below requests from the Web Service at:
https://www.w3schools.com/xml/tempconvert.asmx?op=CelsiusToFahrenheit
To call other WS, change the parameters below, which are:
- the SOAP Endpoint URL (that is, where the service is responding from)
- the SOAP Action
Also change the contents of the method createSoapEnvelope() in this class. It constructs
the inner part of the SOAP envelope that is actually sent.
*/
String soapEndpointUrl = "https://www.w3schools.com/xml/tempconvert.asmx";
String soapAction = "https://www.w3schools.com/xml/CelsiusToFahrenheit";
callSoapWebService(soapEndpointUrl, soapAction);
private static void createSoapEnvelope(SOAPMessage soapMessage) throws SOAPException
SOAPPart soapPart = soapMessage.getSOAPPart();
String myNamespace = "myNamespace";
String myNamespaceURI = "https://www.w3schools.com/xml/";
// SOAP Envelope
SOAPEnvelope envelope = soapPart.getEnvelope();
envelope.addNamespaceDeclaration(myNamespace, myNamespaceURI);
/*
Constructed SOAP Request Message:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:myNamespace="https://www.w3schools.com/xml/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<myNamespace:CelsiusToFahrenheit>
<myNamespace:Celsius>100</myNamespace:Celsius>
</myNamespace:CelsiusToFahrenheit>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
*/
// SOAP Body
SOAPBody soapBody = envelope.getBody();
SOAPElement soapBodyElem = soapBody.addChildElement("CelsiusToFahrenheit", myNamespace);
SOAPElement soapBodyElem1 = soapBodyElem.addChildElement("Celsius", myNamespace);
soapBodyElem1.addTextNode("100");
private static void callSoapWebService(String soapEndpointUrl, String soapAction)
try
// Create SOAP Connection
SOAPConnectionFactory soapConnectionFactory = SOAPConnectionFactory.newInstance();
SOAPConnection soapConnection = soapConnectionFactory.createConnection();
// Send SOAP Message to SOAP Server
SOAPMessage soapResponse = soapConnection.call(createSOAPRequest(soapAction), soapEndpointUrl);
// Print the SOAP Response
System.out.println("Response SOAP Message:");
soapResponse.writeTo(System.out);
System.out.println();
soapConnection.close();
catch (Exception e)
System.err.println("\nError occurred while sending SOAP Request to Server!\nMake sure you have the correct endpoint URL and SOAPAction!\n");
e.printStackTrace();
private static SOAPMessage createSOAPRequest(String soapAction) throws Exception
MessageFactory messageFactory = MessageFactory.newInstance();
SOAPMessage soapMessage = messageFactory.createMessage();
createSoapEnvelope(soapMessage);
MimeHeaders headers = soapMessage.getMimeHeaders();
headers.addHeader("SOAPAction", soapAction);
soapMessage.saveChanges();
/* Print the request message, just for debugging purposes */
System.out.println("Request SOAP Message:");
soapMessage.writeTo(System.out);
System.out.println("\n");
return soapMessage;
关于使用 JAXB 进行序列化/反序列化，很容易找到有关它的信息。你可以从这里开始：http://www.mkyong.com/java/jaxb-hello-world-example/。
【讨论】：
如何使用上述方法设置soap版本？ 我能够使用您的方法，并且当我使用您的 URI 时它有效，但是对于我自己的 SOAP 请求，我得到了一个响应，其中没有一个值按预期显示，即<xsd:element name="Incident_Number" type="xsd:string"/>。如您所见，该元素已关闭，并且没有从 WS 生成任何信息。
致路人：如果上面的代码（示例 SOAP Web 服务端点）停止工作或开始出现错误（如 500、503 等），请告诉我，以便我可以修复它。
如何在包含用户名和密码的标头中的同一请求中添加另一个节点（AuthHeader）？例如：或者只使用Apache CXF's wsdl2java 来生成您可以使用的对象。
它包含在二进制包中，您可以从他们的网站下载。您可以简单地运行如下命令：
$ ./wsdl2java -p com.mynamespace.for.the.api.objects -autoNameResolution http://www.someurl.com/DefaultWebService?wsdl
它使用 wsdl 生成对象，您可以像 this 一样使用它（对象名称也是从 wsdl 中获取的，因此您的名称会有所不同）：
DefaultWebService defaultWebService = new DefaultWebService();
String res = defaultWebService.getDefaultWebServiceHttpSoap11Endpoint().login("webservice","dadsadasdasd");
System.out.println(res);
甚至还有一个 Maven 插件可以生成源代码：https://cxf.apache.org/docs/maven-cxf-codegen-plugin-wsdl-to-java.html
注意：如果您使用 CXF 和 IDEA 生成源代码，您可能需要查看以下内容：https://***.com/a/46812593/840315
【讨论】：
我的应用程序中有 30 多个 wsdl。在为仅 1 个 wsdl（有 5 个soapAction）准备资源时，我的 Eclipse IDE 挂起并生成了大约 100+ MB 的类/对象。【参考方案3】：我找到了一种更简单的生成肥皂消息的替代方法。 给定一个 Person 对象：
import com.fasterxml.jackson.annotation.JsonInclude;
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Person
private String name;
private int age;
private String address; //setter and getters below
下面是一个简单的 Soap 消息生成器：
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
@Slf4j
public class SoapGenerator
protected static final ObjectMapper XML_MAPPER = new XmlMapper()
.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL)
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)
.registerModule(new JavaTimeModule());
private static final String SOAP_BODY_OPEN = "<soap:Body>";
private static final String SOAP_BODY_CLOSE = "</soap:Body>";
private static final String SOAP_ENVELOPE_OPEN = "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">";
private static final String SOAP_ENVELOPE_CLOSE = "</soap:Envelope>";
public static String soapWrap(String xml)
return SOAP_ENVELOPE_OPEN + SOAP_BODY_OPEN + xml + SOAP_BODY_CLOSE + SOAP_ENVELOPE_CLOSE;
public static String soapUnwrap(String xml)
return StringUtils.substringBetween(xml, SOAP_BODY_OPEN, SOAP_BODY_CLOSE);
您可以通过以下方式使用：
public static void main(String[] args) throws Exception
Person p = new Person();
p.setName("Test");
p.setAge(12);
String xml = SoapGenerator.soapWrap(XML_MAPPER.writeValueAsString(p));
log.info("Generated String");
log.info(xml);
【讨论】：
【参考方案4】：可能对将 xml 请求作为字符串的人有所帮助。 如果您有 WSDL，您可以使用该 WSDL 文件在 SoapUI 中创建一个新的 soap 请求。 它会自动为输入请求生成结构/XML。
如果您有来自 SoapUI 的输入请求 xml，则可以使用以下 Java 代码的一些简单版本来调用 Soap 服务：
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
public class SimpleSoapClient
public static void main(String args[]) throws IOException
String address="Hyderabad";
/* place your xml request from soap ui below with necessary changes in parameters*/
String xml="<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ws=\"http://www.YourUrlAsPerWsdl.com/\">\r\n" +
" <soapenv:Header/>\r\n" +
" <soapenv:Body>\r\n" +
" <ws:callRest>\r\n" +
" <name>"+"Hello"+"</name>\r\n" +
" <address>"+address+"</address>\r\n" +
" </ws:callRest>\r\n" +
" </soapenv:Body>\r\n" +
"</soapenv:Envelope>";
String responseF=callSoapService(xml);
System.out.println(responseF);
static String callSoapService(String soapRequest)
try
String url = "https://gogle.com/service/hello"; // replace your URL here
URL obj = new URL(url);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
// change these values as per soapui request on top left of request, click on RAW, you will find all the headers
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type","text/xml; charset=utf-8");
con.setDoOutput(true);
DataOutputStream wr = new DataOutputStream(con.getOutputStream());
wr.writeBytes(soapRequest);
wr.flush();
wr.close();
String responseStatus = con.getResponseMessage();
System.out.println(responseStatus);
BufferedReader in = new BufferedReader(new InputStreamReader(
con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null)
response.append(inputLine);
in.close();
// You can play with response which is available as string now:
String finalvalue= response.toString();
// or you can parse/substring the required tag from response as below based your response code
finalvalue= finalvalue.substring(finalvalue.indexOf("<response>")+10,finalvalue.indexOf("</response>")); */
return finalvalue;
catch (Exception e)
return e.getMessage();
【讨论】：
我终于找到了一个真正有效的例子......非常感谢！以上是关于如何从 Java 类调用 SOAP Web 服务？的主要内容，如果未能解决你的问题，请参考以下文章