如何使用 Log4j 记录 Apache CXF Soap 请求和 Soap 响应？

Question

我正在使用 Apache CXF 框架。 在我的客户端程序中，我需要记录 CXF SOAP 请求和 SOAP 响应。 当我使用

JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
factory.setAddress(host);
factory.setServiceClass(MyService.class);
factory.getInInterceptors().add(new LoggingInInterceptor());
factory.getOutInterceptors().add(new LoggingOutInterceptor());

我在控制台中收到了这些 SOAP 请求和 SOAP 响应：

Nov 9, 2011 6:48:01 PM org.apache.cxf.interceptor.LoggingOutInterceptor$LoggingCallback onClose
INFO: Outbound Message
---------------------------
ID: 2
Encoding: UTF-8
Content-Type: text/xml
Headers: {}
Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns4:MYResponse
--------------------------------------

但我的实际要求是，我需要将它们放在日志文件中，而不是将它们打印到服务器控制台。

当我如图所示直接使用log4j时

log4j(factory.getInInterceptors().add(new LoggingInInterceptor()));
log4j(factory.getOutInterceptors().add(new LoggingOutInterceptor()));

它只在日志文件中打印true 和true。

谁能告诉我如何配置这个？

Answer 1

您需要在/META-INF/cxf/下创建一个名为org.apache.cxf.Logger的文件（即：org.apache.cxf文件，扩展名为Logger），内容如下：

org.apache.cxf.common.logging.Log4jLogger

参考：Using Log4j Instead of java.util.logging。

如果你替换标准：

<cxf:bus>
  <cxf:features>
    <cxf:logging/>
  </cxf:features>
</cxf:bus>

更详细：

<bean id="abstractLoggingInterceptor" abstract="true">
    <property name="prettyLogging" value="true"/>
</bean>
<bean id="loggingInInterceptor" class="org.apache.cxf.interceptor.LoggingInInterceptor" parent="abstractLoggingInterceptor"/>
<bean id="loggingOutInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor" parent="abstractLoggingInterceptor"/>

<cxf:bus>
    <cxf:inInterceptors>
        <ref bean="loggingInInterceptor"/>
    </cxf:inInterceptors>
    <cxf:outInterceptors>
        <ref bean="loggingOutInterceptor"/>
    </cxf:outInterceptors>
    <cxf:outFaultInterceptors>
        <ref bean="loggingOutInterceptor"/>
    </cxf:outFaultInterceptors>
    <cxf:inFaultInterceptors>
        <ref bean="loggingInInterceptor"/>
    </cxf:inFaultInterceptors>
</cxf:bus>

Apache CXF 将漂亮地打印 XML 消息，并使用适当的缩进和换行符格式化它们。很有用。更多相关信息here。

Answer 2

另一种简单的方法是像这样设置记录器 - 确保在加载 cxf Web 服务相关类之前执行此操作。您可以在一些静态块中使用它。

YourClientConstructor() {

  LogUtils.setLoggerClass(org.apache.cxf.common.logging.Log4jLogger.class);

  URL wsdlURL = YOurURL;//

  //create the service
  YourService = new YourService(wsdlURL, SERVICE_NAME);
  port = yourService.getServicePort(); 

  Client client = ClientProxy.getClient(port);
  client.getInInterceptors().add(new LoggingInInterceptor());
  client.getOutInterceptors().add(new LoggingOutInterceptor());
}

然后入站和出站消息将打印到 Log4j 文件而不是控制台。确保您的 log4j 配置正确

Answer 3

在 Preethi Jain szenario 中实现漂亮日志记录的最简单方法：

LoggingInInterceptor loggingInInterceptor = new LoggingInInterceptor();
loggingInInterceptor.setPrettyLogging(true);
LoggingOutInterceptor loggingOutInterceptor = new LoggingOutInterceptor();
loggingOutInterceptor.setPrettyLogging(true);
factory.getInInterceptors().add(loggingInInterceptor);
factory.getOutInterceptors().add(loggingOutInterceptor);

Answer 4

在您的 spring 上下文中，下面的配置将记录请求和响应 soap 消息。

<bean id="loggingFeature" class="org.apache.cxf.feature.LoggingFeature">
    <property name="prettyLogging" value="true" />
</bean>

<cxf:bus>
    <cxf:features>
        <ref bean="loggingFeature" />
    </cxf:features>
</cxf:bus>

Answer 5

这对我有用。

正常设置 log4j。然后使用此代码：

    // LOGGING 
    LoggingOutInterceptor loi = new LoggingOutInterceptor(); 
    loi.setPrettyLogging(true); 
    LoggingInInterceptor lii = new LoggingInInterceptor(); 
    lii.setPrettyLogging(true); 

    org.apache.cxf.endpoint.Client client = org.apache.cxf.frontend.ClientProxy.getClient(isalesService); 
    org.apache.cxf.endpoint.Endpoint cxfEndpoint = client.getEndpoint(); 

    cxfEndpoint.getOutInterceptors().add(loi); 
    cxfEndpoint.getInInterceptors().add(lii);

Answer 6

在配置log4j.properties 时，将org.apache.cxf 日志级别设置为INFO 足以看到普通的SOAP 消息：

log4j.logger.org.apache.cxf=INFO

DEBUG 太冗长了。

Answer 7

试试这个代码：

EndpointImpl impl = (EndpointImpl)Endpoint.publish(address, implementor);
    impl.getServer().getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
    impl.getServer().getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());

在logback.xml里面需要放webservice的接口名：

<appender name="FILE" class="ch.qos.logback.classic.sift.SiftingAppender">
    <discriminator
        class="com.progressoft.ecc.integration.logging.ThreadNameDiscriminator">
        <key>threadName</key>
        <defaultValue>unknown</defaultValue>
    </discriminator>
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
        <evaluator>
            <expression>logger.contains("InterfaceWebServiceSoap")</expression>
        </evaluator>
        <OnMismatch>DENY</OnMismatch>
        <OnMatch>NEUTRAL</OnMatch>
    </filter>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>TRACE</level>
    </filter>
    <sift>
        <appender name="FILE-${threadName}"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${LOGGING_PATH}/${threadName}.log</File>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <FileNamePattern>${ARCHIVING_PATH}/%d{yyyy-MM-dd}.${threadName}%i.log.zip
                </FileNamePattern>
                <MaxHistory>30</MaxHistory>
                <TimeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <MaxFileSize>50MB</MaxFileSize>
                </TimeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <Pattern>%date{dd-MM-yyyy HH:mm:ss.SSS} | %5level | %-60([%logger{53}:%line]): %msg %ex{full} %n</Pattern>
            </encoder>
        </appender>
    </sift>
</appender>

<root>
    <level value="ALL" />
    <appender-ref ref="FILE" />
</root>

Answer 8

cxf.xml

<cxf:bus>
    <cxf:ininterceptors>
        <ref bean="loggingInInterceptor" />
    </cxf:ininterceptors>
    <cxf:outinterceptors>
        <ref bean="logOutInterceptor" />
    </cxf:outinterceptors>
</cxf:bus>

org.apache.cxf.Logger

org.apache.cxf.common.logging.Log4jLogger

请查看截图here

Answer 9

如果有人想这样做，使用 Play Framework（并使用 LogBack http://logback.qos.ch/），那么您可以使用以下行配置 application-logger.xml：

 <logger name="org.apache.cxf" level="DEBUG"/>

对我来说，它成功了；）

Answer 10

使用log4j logger 的 SOAP/REST 请求/响应的客户端/服务器日志记录的全局设置过程。 这样您就可以为整个应用程序设置日志记录，而无需更改代码、war、jar 文件等。

1. 将文件cxf-rt-features-logging-X.Y.Z.jar 安装到您的CLASS_PATH

2. 创建文件（路径例如：/opt/cxf/cxf-logging.xml）：

   <?xml version="1.0" encoding="UTF-8"?>
   <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cxf="http://cxf.apache.org/core" xsi:schemaLocation="http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
   <cxf:bus>
    <cxf:features>
    <bean class="org.apache.cxf.ext.logging.LoggingFeature">
    <property name="prettyLogging" value="true"/>
    </bean>
    </cxf:features>
    </cxf:bus>
    </beans>
   

3. 为org.apache.cxf (log4j 1.x) log4j.logger.org.apache.cxf=INFO,YOUR_APPENDER 设置日志记录

4. 在 java 启动时设置这些属性

java ... -Dcxf.config.file.url=file:///opt/cxf/cxf-logging.xml -Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Log4jLogger -Dcom.sun.xml.ws.transport.http.client.HttpTransportPipe.dump=true -Dcom.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump=true -Dcom.sun.xml.ws.transport.http.HttpAdapter.dump=true -Dcom.sun.xml.internal.ws.transport.http.HttpAdapter.dump=true ...

不知道为什么，但是也要设置变量com.sun.xml.*

Answer 11

旧配置选项不适用于使用 Apache CXF 3.1 或更高版本的用户。检查here。就我而言，我在 spring boot（版本 2.4.2）项目中使用了 apache cxf 3.4.2。

要正确打印日志，您需要在 Bus 对象中添加功能（在我的情况下，它是 SpringBus），如下所示 -

1. 创建LoggingFeature -

LoggingFeature loggingFeature = new LoggingFeature();
loggingFeature.setPrettyLogging(true);

1. 创建/自动装配总线对象，然后将功能设置为总线

bus.setFeatures(Arrays.asList(loggingFeature));

如果您需要查看如何在 Spring Boot 项目中创建总线，请查看here。