使用 JAX-WS 跟蹤 XML 請求/響應

Question

是否有一種簡單的方法（又名：不使用代理）來訪問使用 JAX-WS 參考實現（包含在 JDK 1.5 和更好的版本中）發布的 Web 服務的原始請求/響應 XML？ 能夠通過代碼做到這一點是我需要做的。 僅通過巧妙的日志記錄配置將其記錄到文件中就很好，但已經足夠了。

我知道存在其他更復雜和完整的框架可以做到這一點，但我希望它盡可能簡單，axis、cxf 等都增加了我想避免的相當大的開銷。

謝謝！

Answer 1

以下選項可以將所有通信記錄到控制台（從技術上講，您只需要其中之一，但這取決於您使用的庫，因此設置所有四個是更安全的選項）。 您可以像示例一樣在代碼中設置它，或者使用 -D 作為命令行參數，或者作為 Upendra 編寫的環境變量。

System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dumpTreshold", "999999");

有關詳細信息，請參閱出現錯誤時使用 JAX-WS 跟蹤 XML 請求/響應的問題。

Answer 2

這是原始代碼中的解決方案（感謝 stjohnroe 和 Shamik）：

Endpoint ep = Endpoint.create(new WebserviceImpl());
List<Handler> handlerChain = ep.getBinding().getHandlerChain();
handlerChain.add(new SOAPLoggingHandler());
ep.getBinding().setHandlerChain(handlerChain);
ep.publish(publishURL);

SOAPLoggingHandler 在哪里（從鏈接示例中提取）：

package com.myfirm.util.logging.ws;

import java.io.PrintStream;
import java.util.Map;
import java.util.Set;

import javax.xml.namespace.QName;
import javax.xml.soap.SOAPMessage;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;

/*
 * This simple SOAPHandler will output the contents of incoming
 * and outgoing messages.
 */
public class SOAPLoggingHandler implements SOAPHandler<SOAPMessageContext> {

    // change this to redirect output if desired
    private static PrintStream out = System.out;

    public Set<QName> getHeaders() {
        return null;
    }

    public boolean handleMessage(SOAPMessageContext smc) {
        logToSystemOut(smc);
        return true;
    }

    public boolean handleFault(SOAPMessageContext smc) {
        logToSystemOut(smc);
        return true;
    }

    // nothing to clean up
    public void close(MessageContext messageContext) {
    }

    /*
     * Check the MESSAGE_OUTBOUND_PROPERTY in the context
     * to see if this is an outgoing or incoming message.
     * Write a brief message to the print stream and
     * output the message. The writeTo() method can throw
     * SOAPException or IOException
     */
    private void logToSystemOut(SOAPMessageContext smc) {
        Boolean outboundProperty = (Boolean)
            smc.get (MessageContext.MESSAGE_OUTBOUND_PROPERTY);

        if (outboundProperty.booleanValue()) {
            out.println("\nOutbound message:");
        } else {
            out.println("\nInbound message:");
        }

        SOAPMessage message = smc.getMessage();
        try {
            message.writeTo(out);
            out.println("");   // just to add a newline
        } catch (Exception e) {
            out.println("Exception in handler: " + e);
        }
    }
}

Answer 3

在啟動 tomcat 之前，在 Linux envs 中設置JAVA_OPTS如下。 然后啟動Tomcat。 您將在catalina.out文件中看到請求和響應。

export JAVA_OPTS="$JAVA_OPTS -Dcom.sun.xml.ws.transport.http.client.HttpTransportPipe.dump=true"

Answer 4

將SOAPHandler注入端點接口。 我們可以跟蹤 SOAP 請求和響應

使用編程實現 SOAPHandler

ServerImplService service = new ServerImplService();
Server port = imgService.getServerImplPort();
/**********for tracing xml inbound and outbound******************************/
Binding binding = ((BindingProvider)port).getBinding();
List<Handler> handlerChain = binding.getHandlerChain();
handlerChain.add(new SOAPLoggingHandler());
binding.setHandlerChain(handlerChain);

聲明加入@HandlerChain(file = "handlers.xml")標注你的端點接口。

處理程序.xml

<?xml version="1.0" encoding="UTF-8"?>
<handler-chains xmlns="http://java.sun.com/xml/ns/javaee">
    <handler-chain>
        <handler>
            <handler-class>SOAPLoggingHandler</handler-class>
        </handler>
    </handler-chain>
</handler-chains>

SOAPLoggingHandler.java

/*
 * This simple SOAPHandler will output the contents of incoming
 * and outgoing messages.
 */


public class SOAPLoggingHandler implements SOAPHandler<SOAPMessageContext> {
    public Set<QName> getHeaders() {
        return null;
    }

    public boolean handleMessage(SOAPMessageContext context) {
        Boolean isRequest = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
        if (isRequest) {
            System.out.println("is Request");
        } else {
            System.out.println("is Response");
        }
        SOAPMessage message = context.getMessage();
        try {
            SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
            SOAPHeader header = envelope.getHeader();
            message.writeTo(System.out);
        } catch (SOAPException | IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return true;
    }

    public boolean handleFault(SOAPMessageContext smc) {
        return true;
    }

    // nothing to clean up
    public void close(MessageContext messageContext) {
    }

}

Answer 5

設置以下系統屬性，這將啟用 xml 日志記錄。 您可以在 java 或配置文件中設置它。

static{
        System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dumpTreshold", "999999");
    }

控制台日志：

INFO: Outbound Message
---------------------------
ID: 1
Address: http://localhost:7001/arm-war/castService
Encoding: UTF-8
Http-Method: POST
Content-Type: text/xml
Headers: {Accept=[*/*], SOAPAction=[""]}
Payload: xml
--------------------------------------
INFO: Inbound Message
----------------------------
ID: 1
Response-Code: 200
Encoding: UTF-8
Content-Type: text/xml; charset=UTF-8
Headers: {content-type=[text/xml; charset=UTF-8], Date=[Fri, 20 Jan 2017 11:30:48 GMT], transfer-encoding=[chunked]}
Payload: xml
--------------------------------------

Answer 6

如其他答案中所述，有多種以編程方式執行此操作的方法，但它們是非常具有侵入性的機制。 但是，如果您知道您正在使用 JAX-WS RI（又名“Metro”），那么您可以在配置級別執行此操作。 有關如何執行此操作的說明，請參見此處。 無需弄亂您的應用程序。

Answer 7

// 此解決方案提供了一種以編程方式向 Web 服務客戶端添加處理程序的方法，無需 XML 配置

// 在此處查看完整文檔： http : //docs.oracle.com/cd/E17904_01//web.1111/e13734/handlers.htm#i222476

// 創建實現 SOAPHandler 的新類

public class LogMessageHandler implements SOAPHandler<SOAPMessageContext> {

@Override
public Set<QName> getHeaders() {
    return Collections.EMPTY_SET;
}

@Override
public boolean handleMessage(SOAPMessageContext context) {
    SOAPMessage msg = context.getMessage(); //Line 1
    try {
        msg.writeTo(System.out);  //Line 3
    } catch (Exception ex) {
        Logger.getLogger(LogMessageHandler.class.getName()).log(Level.SEVERE, null, ex);
    } 
    return true;
}

@Override
public boolean handleFault(SOAPMessageContext context) {
    return true;
}

@Override
public void close(MessageContext context) {
}
}

// 以編程方式添加您的 LogMessageHandler

   com.csd.Service service = null;
    URL url = new URL("https://service.demo.com/ResService.svc?wsdl");

    service = new com.csd.Service(url);

    com.csd.IService port = service.getBasicHttpBindingIService();
    BindingProvider bindingProvider = (BindingProvider)port;
    Binding binding = bindingProvider.getBinding();
    List<Handler> handlerChain = binding.getHandlerChain();
    handlerChain.add(new LogMessageHandler());
    binding.setHandlerChain(handlerChain);

Answer 8

我發布了一個新答案，因為我沒有足夠的聲譽來評論Antonio提供的答案（請參閱： https : //stackoverflow.com/a/1957777 ）。

如果您希望將 SOAP 消息打印在文件中（例如通過 Log4j），您可以使用：

OutputStream os = new ByteArrayOutputStream();
javax.xml.soap.SOAPMessage soapMsg = context.getMessage();
soapMsg.writeTo(os);
Logger LOG = Logger.getLogger(SOAPLoggingHandler.class); // Assuming SOAPLoggingHandler is the class name
LOG.info(os.toString());

請注意，在某些情況下，方法調用 writeTo() 可能不會按預期運行（請參閱： https ://community.oracle.com/thread/1123104?tstart =0或https://www.java.net/node /691073 ），因此以下代碼將起作用：

javax.xml.soap.SOAPMessage soapMsg = context.getMessage();
com.sun.xml.ws.api.message.Message msg = new com.sun.xml.ws.message.saaj.SAAJMessage(soapMsg);
com.sun.xml.ws.api.message.Packet packet = new com.sun.xml.ws.api.message.Packet(msg);
Logger LOG = Logger.getLogger(SOAPLoggingHandler.class); // Assuming SOAPLoggingHandler is the class name
LOG.info(packet.toString());

Answer 9

您需要實現一個 javax.xml.ws.handler.LogicalHandler，然后需要在處理程序配置文件中引用該處理程序，該文件又由您的服務端點（接口或實現）中的 @HandlerChain 注釋引用。 然后，您可以通過 system.out 或 processMessage 實現中的記錄器輸出消息。

見

http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/twbs_jaxwshandler.html

http://java.sun.com/mailers/techtips/enterprise/2006/TechTips_June06.html

Answer 10

此處列出的指導您使用SOAPHandler是完全正確的。 這種方法的好處是它適用於任何 JAX-WS 實現，因為 SOAPHandler 是 JAX-WS 規范的一部分。 但是，SOAPHandler 的問題在於它隱式地嘗試在內存中表示整個 XML 消息。 這可能會導致大量內存使用。 JAX-WS 的各種實現為此添加了自己的解決方法。 如果您處理大型請求或大型響應，那么您需要研究一種專有方法。

由於您詢問“JDK 1.5 或更高版本中包含的那個”，我將回答正式稱為 JAX-WS RI（又名 Metro）的內容，它包含在 JDK 中。

JAX-WS RI 對此有一個特定的解決方案，它在內存使用方面非常有效。

請參閱https://javaee.github.io/metro/doc/user-guide/ch02.html#efficient-handlers-in-jax-ws-ri 。 不幸的是，該鏈接現已損壞，但您可以在 WayBack Machine 上找到它。 我將在下面列出重點：

Metro 人員早在 2007 年就引入了一個額外的處理程序類型MessageHandler<MessageHandlerContext> ，它是 Metro 專有的。 它比SOAPHandler<SOAPMessageContext>高效得多，因為它不嘗試在內存中進行 DOM 表示。

這是原始博客文章中的關鍵文本：

消息處理器：

利用 JAX-WS 規范提供的可擴展 Handler 框架和 RI 中更好的 Message 抽象，我們引入了一個名為MessageHandler的新處理程序來擴展您的 Web Service 應用程序。 MessageHandler 類似於 SOAPHandler，除了它的實現可以訪問MessageHandlerContext （MessageContext 的擴展）。 通過 MessageHandlerContext 可以訪問 Message 並使用 Message API 處理它。 正如我在博客標題中所說的那樣，這個處理程序讓您可以處理 Message，它提供了訪問/處理消息的有效方法，而不僅僅是基於 DOM 的消息。 處理程序的編程模型是相同的，消息處理程序可以與標准邏輯和 SOAP 處理程序混合使用。 我在 JAX-WS RI 2.1.3 中添加了一個示例，展示了使用 MessageHandler 記錄消息，這里是示例中的一個片段：

public class LoggingHandler implements MessageHandler<MessageHandlerContext> {
    public boolean handleMessage(MessageHandlerContext mhc) {
        Message m = mhc.getMessage().copy();
        XMLStreamWriter writer = XMLStreamWriterFactory.create(System.out);
        try {
            m.writeTo(writer);
        } catch (XMLStreamException e) {
            e.printStackTrace();
            return false;
        }
        return true;
    }

    public boolean handleFault(MessageHandlerContext mhc) {
        ..... 
        return true;
    }

    public void close(MessageContext messageContext) {    }

    public Set getHeaders() {
        return null;
    }
}

（引自 2007 年博客文章的結尾）

不用說， LoggingHandler中的自定義處理程序LoggingHandler需要添加到您的處理程序鏈中才能生效。 這與添加任何其他Handler相同，因此您可以查看此頁面上的其他答案以了解如何執行此操作。

您可以在Metro GitHub 存儲庫中找到完整示例。

Answer 11

使用 logback.xml 配置文件，您可以執行以下操作：

<logger name="com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe" level="trace" additivity="false">
    <appender-ref ref="STDOUT"/>
</logger>

這將像這樣記錄請求和響應（取決於您對日志輸出的配置）：

09:50:23.266 [qtp1068445309-21] DEBUG c.s.x.i.w.t.h.c.HttpTransportPipe - ---[HTTP request - http://xyz:8081/xyz.svc]---
Accept: application/soap+xml, multipart/related
Content-Type: application/soap+xml; charset=utf-8;action="http://xyz.Web.Services/IServiceBase/GetAccessTicket"
User-Agent: JAX-WS RI 2.2.9-b130926.1035 svn-revision#5f6196f2b90e9460065a4c2f4e30e065b245e51e
<?xml version="1.0" ?><S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">[CONTENT REMOVED]</S:Envelope>--------------------

09:50:23.312 [qtp1068445309-21] DEBUG c.s.x.i.w.t.h.c.HttpTransportPipe - ---[HTTP response - http://xyz:8081/xyz.svc - 200]---
null: HTTP/1.1 200 OK
Content-Length: 792
Content-Type: application/soap+xml; charset=utf-8
Date: Tue, 12 Feb 2019 14:50:23 GMT
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">[CONTENT REMOVED]</s:Envelope>--------------------

Answer 12

您可以嘗試在 webservice 前面放置一個ServletFilter並檢查進入/從服務返回的請求和響應。

盡管您沒有特別要求代理，但有時我發現tcptrace足以查看連接上發生的情況。 這是一個簡單的工具，無需安裝，它確實顯示數據流並且也可以寫入文件。

Answer 13

在運行時你可以簡單地執行

com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump = true

因為轉儲是類中定義的公共變量，如下所示

public static boolean dump;

Answer 14

我是否正確理解您要更改/訪問原始 XML 消息？

如果是這樣，您（或者因為這已經是 5 歲了，所以下一位）可能想看看作為 JAXWS 一部分的 Provider 接口。 客戶端對應物是使用“Dispatch”類完成的。 無論如何，您不必添加處理程序或攔截器。 當然，你仍然可以。 缺點是這種方式，您完全負責構建 SOAPMessage，但它很容易，如果這就是您想要的（就像我所做的那樣），那就太完美了。

這是服務器端的示例（有點笨拙，僅用於實驗）-

@WebServiceProvider(portName="Provider1Port",serviceName="Provider1",targetNamespace = "http://localhost:8123/SoapContext/SoapPort1")
@ServiceMode(value=Service.Mode.MESSAGE)
public class Provider1 implements Provider<SOAPMessage>
{
  public Provider1()
  {
  }

  public SOAPMessage invoke(SOAPMessage request)
  { try{


        File log= new File("/home/aneeshb/practiceinapachecxf/log.txt");//creates file object
        FileWriter fw=new FileWriter(log);//creates filewriter and actually creates file on disk

            fw.write("Provider has been invoked");
            fw.write("This is the request"+request.getSOAPBody().getTextContent());

      MessageFactory mf = MessageFactory.newInstance();
      SOAPFactory sf = SOAPFactory.newInstance();

      SOAPMessage response = mf.createMessage();
      SOAPBody respBody = response.getSOAPBody();
      Name bodyName = sf.createName("Provider1Insertedmainbody");
      respBody.addBodyElement(bodyName);
      SOAPElement respContent = respBody.addChildElement("provider1");
      respContent.setValue("123.00");
      response.saveChanges();
      fw.write("This is the response"+response.getSOAPBody().getTextContent());
      fw.close();
      return response;}catch(Exception e){return request;}


   }
}

你像發布 SEI 一樣發布它，

public class ServerJSFB {

    protected ServerJSFB() throws Exception {
        System.out.println("Starting Server");
        System.out.println("Starting SoapService1");

        Object implementor = new Provider1();//create implementor
        String address = "http://localhost:8123/SoapContext/SoapPort1";

        JaxWsServerFactoryBean svrFactory = new JaxWsServerFactoryBean();//create serverfactorybean

        svrFactory.setAddress(address);
        svrFactory.setServiceBean(implementor);

        svrFactory.create();//create the server. equivalent to publishing the endpoint
        System.out.println("Starting SoapService1");
  }

public static void main(String args[]) throws Exception {
    new ServerJSFB();
    System.out.println("Server ready...");

    Thread.sleep(10 * 60 * 1000);
    System.out.println("Server exiting");
    System.exit(0);
}
}

或者您可以使用 Endpoint 類。 希望這有幫助。

哦，如果你想要你不需要處理標題和東西，如果你將服務模式更改為 PAYLOAD（你只會得到 Soap Body）。

Answer 15

幾天來，我一直試圖找到一些框架庫來記錄 Web 服務 soap 請求和響應。 下面的代碼為我解決了這個問題：

System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");

Answer 16

一種方法是不使用您的代碼，而是使用諸如 Etheral 或 WireShark 之類的網絡數據包嗅探器，它們可以捕獲帶有 XML 消息作為負載的 HTTP 數據包，您可以將它們記錄到一個文件左右。

但更復雜的方法是編寫自己的消息處理程序。 你可以在這里看看。

Answer 17

其實。 如果您查看 HttpClientTransport 的來源，您會注意到它也在將消息寫入 java.util.logging.Logger。 這意味着您也可以在日志中看到這些消息。

例如，如果您使用的是 Log4J2，您需要做的就是以下內容：

• 將 JUL-Log4J2 橋添加到您的類路徑中
• 為 com.sun.xml.internal.ws.transport.http.client 包設置 TRACE 級別。
• 將 -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager 系統屬性添加到您的應用程序啟動命令行

在這些步驟之后，您開始在日志中看到 SOAP 消息。

Answer 18

在這個線程中有幾個使用 SoapHandlers 的答案。 您應該知道如果writeTo(out)被調用，SoapHandlers 會修改消息。

調用 SOAPMessage 的writeTo(out) saveChanges()方法也會自動調用saveChanges()方法。 因此，消息中所有附加的 MTOM/XOP 二進制數據都將丟失。

我不確定為什么會發生這種情況，但它似乎是一個記錄在案的功能。

此外，此方法標記了來自所有組成 AttachmentPart 對象的數據被拉入消息的點。

https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html#saveChanges()

Answer 19

如果您碰巧運行 IBM Liberty 應用服務器，只需將ibm-ws-bnd.xml添加到 WEB-INF 目錄中。

<?xml version="1.0" encoding="UTF-8"?>
<webservices-bnd
    xmlns="http://websphere.ibm.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://websphere.ibm.com/xml/ns/javaee http://websphere.ibm.com/xml/ns/javaee/ibm-ws-bnd_1_0.xsd"
    version="1.0">
    <webservice-endpoint-properties
        enableLoggingInOutInterceptor="true" />
</webservices-bnd>

Answer 20

Glassfish/Payara 的解決方案

將以下條目添加到記錄器設置（日志級別FINER ）：

• com.sun.xml.ws.transport.http.client.HttpTransportPipe
• com.sun.xml.ws.transport.http.HttpAdapter

在這里找到。