JAX-WSを使用したXML要求/応答のトレース
JAX-WS参照実装（JDK 1.5以降に含まれるもの）で公開されたWebサービスの生の要求/応答XMLにアクセスする簡単な方法（別名：プロキシを使用しない）はありますか？コードを介してそれを行うことができることは、私がする必要があるものです。巧妙なログ設定によってファイルにログを記録するだけでいいのですが、それで十分です。
私はそれを行うかもしれない他のより複雑で完全なフレームワークが存在することを知っていますが、できるだけシンプルに保ちたいし、軸、cxfなどはすべて、かなりのオーバーヘッドを追加したいと思います.
ありがとう！
生コードでの解決策は次のとおりです（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);
}
}
}
次のオプションにより、コンソールへのすべての通信のログが有効になります（技術的には、必要なのはいずれか1つだけですが、使用するライブラリによって異なるため、4つすべてを設定する方が安全です）。例のようにコードで設定したり、-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");
詳細については、質問 エラー発生時のJAX-WSによるXML要求/応答の追跡 を参照してください。
Tomcatを起動する前に、Linux環境で以下のようにJava_OPTSを設定します。次に、Tomcatを起動します。 catalina.outファイルに要求と応答が表示されます。
export Java_OPTS="$Java_OPTS -Dcom.Sun.xml.ws.transport.http.client.HttpTransportPipe.dump=true"
次のシステムプロパティを設定します。これにより、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");
}
コンソールログ：
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
--------------------------------------
他の回答で説明されているように、プログラムでこれを行うにはさまざまな方法がありますが、それらは非常に侵襲的なメカニズムです。ただし、JAX-WS RI（別名「メトロ」）を使用していることがわかっている場合は、構成レベルでこれを実行できます。 手順についてはこちらをご覧ください これを行う方法について。アプリケーションを台無しにする必要はありません。
//このソリューションは、XML設定を使用せずにWebサービスクライアントにハンドラーをプログラムで追加する方法を提供します
//完全なドキュメントを参照してください： 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);
SOAPHandlerをエンドポイントインターフェイスに挿入します。 SOAPリクエストとレスポンスをトレースできます
Programmaticを使用した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")注釈を追加します。
handlers.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) {
}
}
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= または https://www.Java.net/node/69107 ）、したがって、次のコードがトリックを行います：
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());
Javax.xml.ws.handler.LogicalHandlerを実装する必要があります。このハンドラーは、ハンドラー構成ファイルで参照する必要があります。このハンドラーは、サービスエンドポイント（インターフェイスまたは実装）の@HandlerChainアノテーションによって参照されます。その後、system.outまたはprocessMessage実装のロガーを介してメッセージを出力できます。
見る
http://Java.Sun.com/mailers/techtips/enterprise/2006/TechTips_June06.html
runtimeでは、単に実行できます
com.Sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump = true
asdumpは、クラスで次のように定義されたパブリック変数です
public static boolean dump;
Webサービスの前にServletFilterを配置して、サービスに出入りする要求と応答を検査することができます。
あなたは特にプロキシを要求しませんでしたが、時々 tcptrace は接続で何が起こっているかを見るのに十分であることがわかります。これはシンプルなツールで、インストールは不要です。データストリームを表示し、ファイルに書き込むこともできます。
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>--------------------
SOAPHandlerの使用をガイドする、ここにリストされている回答は完全に正しいです。この方法の利点は、SOAPHandlerがJAX-WS仕様の一部であるため、どのJAX-WS実装でも機能することです。ただし、SOAPHandlerの問題は、メモリ内のXMLメッセージ全体を暗黙的に表現しようとすることです。これにより、大量のメモリが使用される可能性があります。 JAX-WSのさまざまな実装では、このための独自の回避策が追加されています。大規模な要求または大規模な応答を扱う場合は、独自のアプローチの1つを検討する必要があります。
「JDK 1.5以上に含まれるもの」について質問するので、JDKに含まれているJAX-WS RI（Metro）として正式に知られているものに関して回答します。
JAX-WS RIには、メモリ使用量の点で非常に効率的なこのための特定のソリューションがあります。
https://javaee.github.io/metro/doc/user-guide/ch02.html#efficient-handlers-in-jax-ws-ri を参照してください。残念ながら、そのリンクは現在壊れていますが、WayBack Machineで見つけることができます。以下にハイライトを示します。
2007年のMetroの人々 導入済み 追加のハンドラータイプMessageHandler<MessageHandlerContext>は、Metro独自のものです。インメモリDOM表現を試行しないため、SOAPHandler<SOAPMessageContext>よりもはるかに効率的です。
元のブログ記事の重要なテキストを次に示します。
MessageHandler：
JAX-WS仕様で提供される拡張可能なハンドラフレームワークとRIの優れたメッセージ抽象化を利用して、
MessageHandlerという新しいハンドラを導入して、Webサービスアプリケーションを拡張しました。 MessageHandlerはSOAPHandlerに似ていますが、実装がMessageHandlerContext（MessageContextの拡張）にアクセスする点が異なります。 MessageHandlerContextを介して、Message APIを使用してMessageにアクセスして処理できます。ブログのタイトルで述べたように、このハンドラーを使用すると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）をハンドラーチェーンに追加して、効果を持たせる必要があります。これは、他のHandlerを追加するのと同じであるため、その方法については、このページの その他の回答 を参照してください。
完全な例 は Metro GitHubリポジトリ にあります。
生の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のみを取得します）。
私は数日間、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");
1つの方法は、コードを使用せず、EtheralやWireSharkなどのネットワークパケットスニファーを使用することです。これは、XMLメッセージをペイロードとしてHTTPパケットをキャプチャし、ファイルなどにログを記録し続けることができます。
しかし、より洗練されたアプローチは、独自のメッセージハンドラを記述することです。あなたはそれを見ることができます ここ 。
実際に。 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メッセージが表示され始めます。