Spring Boot 整合CXF添加日志拦截器

Stella981
• 阅读 1207

一、前言

    上一篇已经完整的描述了spring boot 与cxf整合工程,包括服务端的发布以及客户端的访问。但是整个日志输出只有一个简单的一句:

o.a.c.w.s.f.ReflectionServiceFactoryBean : Creating Service {http://ws.cxf.ouyushan.org/}UserServiceService from class org.ouyushan.cxf.ws.UserService

表示通过CXF已创建指定服务。但是webservice服务中设计的请求信息一星半点都没有,当服务出现问题时,如何通过获取日志来分析问题呢?

       其实在CXF整合完成后,其它附加的高级功能基本上都是通过拦截器来实现的。日志捕获和输出也是基于此实现的。

本文将带领大家快速实现CXF日志输出功能。

项目源码: https://github.com/ouyushan/spring-webservice-samples

spring-cxf参考源码: https://github.com/code-not-found/cxf-jaxws

spring-ws参考源码: https://github.com/code-not-found/spring-ws

二、开发环境

IDE::IDEA

JDK:1.8

maven:3.6.2

spring boot:2.4.0

cxf:3.4.1

三、实现步骤

具体代码实现步骤和上篇一样。本章在之前基础上讲解新增内容。

3.1、实现服务端和客户端

新建服务端和客户端spring-cxf-client-logging、spring-cxf-server-logging,并完成服务部署和客户端访问接口,具体步骤见上一篇。

3.2、添加日志输出依赖

spring boot与cxf整合后输出业务日志只需引入cxf-rt-features-logging,并实现日志拦截器即可。

服务端、客服端pom文件中添加cxf日志依赖包

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-features-logging</artifactId>
    <version>3.4.1</version>
</dependency>

3.3、实现日志输出拦截器

在服务端和客户端配置类中,添加请求接入和响应输出日志拦截器

@Bean
public LoggingInInterceptor loggingInInterceptor() {
    return new LoggingInInterceptor();
}

@Bean
public LoggingOutInterceptor loggingOutInterceptor() {
    return new LoggingOutInterceptor();
}

服务端在Endpoint中配置新增的拦截器

// log the request and response messages
endpoint.getInInterceptors()
        .add(loggingInInterceptor());
endpoint.getOutInterceptors()
        .add(loggingOutInterceptor());

客户端在UserService中配置新增的拦截器

// log the request and response messages
jaxWsProxyFactoryBean.getInInterceptors()
        .add(loggingInInterceptor());
jaxWsProxyFactoryBean.getOutInterceptors()
        .add(loggingOutInterceptor());

3.4、功能验证

分别启动服务端和客户端,访问客户端请求接口:

http://localhost:7070/user/get?userId=1

客户端控制台输出如下:

2020-11-26 20:22:00.884  INFO 8768 --- [nio-7070-exec-1] o.a.cxf.services.UserService.REQ_OUT     : REQ_OUT
    Address: http://localhost:8080/ws/user
    HttpMethod: POST
    Content-Type: text/xml
    ExchangeId: 3140c6ed-a420-4dee-b970-4f9452b17d17
    ServiceName: UserServiceService
    PortName: UserServicePort
    PortTypeName: UserService
    Headers: {SOAPAction="", Accept=*/*}
    Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:getUserName xmlns:ns2="http://ws.cxf.ouyushan.org/"><userId>1</userId></ns2:getUserName></soap:Body></soap:Envelope>

2020-11-26 20:22:01.272  INFO 8768 --- [nio-7070-exec-1] o.a.cxf.services.UserService.RESP_IN     : RESP_IN
    Address: http://localhost:8080/ws/user
    Content-Type: text/xml;charset=UTF-8
    ResponseCode: 200
    ExchangeId: 3140c6ed-a420-4dee-b970-4f9452b17d17
    ServiceName: UserServiceService
    PortName: UserServicePort
    PortTypeName: UserService
    Headers: {Keep-Alive=timeout=60, connection=keep-alive, content-type=text/xml;charset=UTF-8, Content-Length=220, Date=Thu, 26 Nov 2020 12:22:01 GMT}
    Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:getUserNameResponse xmlns:ns2="http://ws.cxf.ouyushan.org/"><return>tom</return></ns2:getUserNameResponse></soap:Body></soap:Envelope>

服务端控制台输出如下:

2020-11-26 20:22:01.057  INFO 10604 --- [nio-8080-exec-4] o.a.cxf.services.UserService.REQ_IN      : REQ_IN
    Address: http://localhost:8080/ws/user
    HttpMethod: POST
    Content-Type: text/xml; charset=UTF-8
    ExchangeId: 3a1a8ecf-f857-4472-9f56-165b54144dae
    ServiceName: UserService
    PortName: UserServiceImplPort
    PortTypeName: UserService
    Headers: {SOAPAction="", Accept=*/*, host=localhost:8080, connection=keep-alive, content-type=text/xml; charset=UTF-8, cache-control=no-cache, Content-Length=202, pragma=no-cache, user-agent=Apache-CXF/3.4.1}
    Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:getUserName xmlns:ns2="http://ws.cxf.ouyushan.org/"><userId>1</userId></ns2:getUserName></soap:Body></soap:Envelope>

2020-11-26 20:22:01.108  INFO 10604 --- [nio-8080-exec-4] o.a.cxf.services.UserService.RESP_OUT    : RESP_OUT
    Address: http://localhost:8080/ws/user
    Content-Type: text/xml
    ResponseCode: 200
    ExchangeId: 3a1a8ecf-f857-4472-9f56-165b54144dae
    ServiceName: UserService
    PortName: UserServiceImplPort
    PortTypeName: UserService
    Headers: {}
    Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:getUserNameResponse xmlns:ns2="http://ws.cxf.ouyushan.org/"><return>tom</return></ns2:getUserNameResponse></soap:Body></soap:Envelope>

从日志可以看出完整的请求链路信息

四、总结

通过本篇教材,您应该已掌握Spring Boot整合CXF实现服务端、客户端日志的配置与输出。整个过程可分为两步:

  1. 定义日志输入、输出拦截器;
  2. 在服务端EndPoint中设置日志拦截器/在客户端代理工厂JaxWsProxyFactoryBean中设置日志拦截器。

获取服务日志的问题已解决了,服务就这样能上线吗?尤其是在保险、银行等公司对接时。结果肯定是否定的,针对敏感信息的服务会话,至少得对会话内容进行加解密甚至签名和验签吧。

具体怎么实现会话的加解密、签名及验签将在下一篇教材中进行讲解。

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Easter79 Easter79
3年前
swap空间的增减方法
(1)增大swap空间去激活swap交换区:swapoff v /dev/vg00/lvswap扩展交换lv:lvextend L 10G /dev/vg00/lvswap重新生成swap交换区:mkswap /dev/vg00/lvswap激活新生成的交换区:swapon v /dev/vg00/lvswap
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这