Spring Controller 打印入参/出参

最新推荐文章于 2024-03-08 17:36:53 发布

springff

最新推荐文章于 2024-03-08 17:36:53 发布

阅读量2.3k

点赞数

CC 4.0 BY-SA版权

分类专栏： JavaWeb 文章标签： spring java

本文链接：https://blog.youkuaiyun.com/spring_man/article/details/120027172

JavaWeb 专栏收录该内容

6 篇文章

订阅专栏

本文介绍了如何在Spring Boot项目中实现Controller层的请求参数和返回结果的日志打印。通过自定义注解`@LogPrint`，结合AOP切面处理，详细记录了实现步骤，包括pom.xml依赖配置、切面创建、注解使用等。同时，文章讨论了日志打印过程中遇到的问题，如中文乱码、日志过滤等，并提供了简化版本的解决方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

参考

思路:

自定义注解，针对注解创建切面，对Controller 中的方法使用注解，通过切面中的 @Before, @Around 获取数据并打印

实现步骤

完整代码地址：https://gitee.com/springff/logprint

日志打印 pom.xml 依赖

<!-- spring-aop -->
<spring.version>4.3.12.RELEASE</spring.version>
<!-- jackson-databind, jackson-core, jackson-annotations -->
<jackson.version>2.9.1</jackson.version>
<!-- aspectjrt, aspectjweaver 实现切面 -->
<aspectj.version>1.8.9</aspectj.version>
<!-- logback-core 会自动引入依赖的 sjf4j -->
<logback.version>1.2.2</logback.version>
<!-- lombok sjf4j 中 log 对象实例化-->
<lombok.version>1.16.18</lombok.version>

spring-mvc.xml 添加 aop 自动代理 <aop:aspectj-autoproxy/>

新建注解 LogPrint，将注解作为切点，作用到 Controller 的方法

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogPrint {
    String description() default "";
}

新建切面 LogPrintAspect，在 controller 方法调用前，调用后打印入参，出参

@Aspect
@Component
@Slf4j
public class LogPrintAspect {
    // 1，声明切点
    @Pointcut("@annotation(cn.exrick.common.annotaion.LogPrint)")
    public void logPrint(){}
    // 2，打印入参 joinPoint.getArgs() -- 获取入参
    @Before("logPrint()")
    public void doBefore(JoinPoint joinPoint){
    // 3, 打印出参 proceedingJoinPoint.proceeding() -- 执行切点修饰的方法，拿到结果，打印响应
    @Around("logPrint()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {}
	// 4，切点作用的方法结束
    @After("logPrint()")
    public void doAfter(){}
}

使用注解 @LogPrint 修饰 Controller 类中的方法

@RestController
public class LogController {
    @LogPrint
    @RequestMapping("/logGet")
    public Object getTest(String name, String age){
        String content = name + "今年" + age + "岁";
        HashMap<String, Object> resultMap = new HashMap<>();
        resultMap.put("content", content);
        return resultMap;
    }
}

日志打印结果

在这里插入图片描述

过程记录

日志打印存在的问题：打印请求与打印响应并不是相邻输出，查看日志的时候需要添加上过滤条件

jackson 直接返回带中文的字符串，中文显示乱码 ????18?。将字符串放到HashMap 中返回，中文正常显示{"content": "张三今年18岁"}

@LogPrint 注解加上后日志不打印？<aop:aspectj-autoproxy/> 没有添加导致 aop 在 spring 框架中不启用

日志打印简化版本，日志过滤

添加

<!-- aop 配置批量添加切面 -->
<aop:config>
    <aop:advisor advice-ref="txAdvice"
                 pointcut="execution(* cn.exrick.manager.service..*.*(..))" />
</aop:config>