controller接口日志输出

原创 已于 2025-10-17 17:14:41 修改 · 304 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot

于 2023-03-23 09:29:03 首次发布
在使用AOP进行日志记录时，由于在尝试获取切点数据时抛出的Throwable异常先于ControllerAdvice的异常处理，导致ControllerAdvice只能捕获到Exception。文章探讨了处理流程的顺序，即Filter>Interceptor>ControllerAdvice>AOP（接收时），以及AOP>ControllerAdvice>Interceptor>Filter（返回时），并指出这一顺序是问题的根本原因。

问题出现：使用aop中around进行日志输出时，ControllerAdvice进行异常捕获时只能捕获exception异常

原因：controller执行完成之后，使用aop获取切点数据时try catch抛出了Throwable异常导致controller进行捕获时只能捕获到exception异常

根本原因为执行顺序

当接收数据时为：Filter过滤器 > Interceptor拦截器 > ControllerAdvice > AOP。

当返回数据时为：AOP > ControllerAdvice > Interceptor拦截器 > Filter过滤器

SpringBoot通过AOP实现系统日志记录（一）-Controller层日志监控（包括系统日志监控）
专注基础架构领域
11-09 6694
最近项目中需要记录服务端访问日志，所谓的服务端访问日志其实就是Controller层的访问日志，所以在开发过程中回顾了一下AOP相关的内容，特此记录，便于日后查阅。 本文只介绍Controller层日志记录，不涉及Service层与Mapper层日志记录： Service层日志监控：SpringBoot通过AOP实现系统日志记录（二）-Service层日志监控 Mapper层日志监控：Spr...
java利用aop来记录接口的请求耗时、请求参数、请求url等详细信息
lixiaobai_boke的博客
09-06 1200
java利用aop来记录请求接口的详细信息
java优雅的打印日志——对controller层方法的进入和结束地方打印日志——直接使用
可乐多点冰的博客
09-07 7352
场景：看日志是后端常用的操作，但是日志过于多的时候，很难分清日志打印的是不是同一个调用里面的。所以在controller的方法的开始和结尾的地方，打印日志，并且打印入参和出参，这样就能够很好的分析日志的逻辑了。 由于每一个controller层的方法都需要打印进入和返回的日志，所以使用AOP的思想可以很好的解决，我们这边使用静态代理AspectJ。 <dependency> <groupId>org.aspectj</groupId&gt
利用@ControllerAdvice和@ExceptionHandler自定义全局异常并打印日志到前端页面
lovekjl的博客
08-20 1729
@ExceptionHandler 单独使用一般是用在控制器的内部某个方法上，表示捕捉控制器内部抛出的异常 详细的使用方法请参考：lkforce的博客 @ControllerAdvice+@ExceptionHandler Spring 3.2之后加入了新的@ControllerAdvice注解，可以支持全局的异常处理。 自定义全局异常并打印系统默认日志demo： 第一步：修改pom配置文件 设置日志级别和日志保存地址 logging.level.root=info logging.lev
@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常
热门推荐
kinginblue的专栏
04-15 9万+
@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常...
使用切面在controller层记录操作日志
YuChenIT的博客
01-29 811
使用切面在controller层记录操作日志
全局controller 请求返回参数信息日志
yulingli42的博客
04-03 247
全局controller 请求返回参数信息日志
springMVC AOP拦截拦截Controller等实现日志管理
07-19
在实际项目中，我们可以根据需求进一步定制日志格式，或者将日志信息输出到不同的目的地，如文件、数据库或日志服务。同时，也可以扩展此机制，为其他关注点（如事务管理、安全控制等）创建额外的切面。 综上所述，...
SpringBoot自定义日志--（实现输出接口信息）
m0_46698142的博客
08-23 1298
SpringBoot自定义日志–实现输出接口信息 在项目开发过程中我们排查错误过程中，为了更清晰明了的查看接口调用情况，我们会将接口的入参和响应进行Log打印，工作原理就是利用Spring的Aop进行日志打印，接下来我们一起进入正题 先上效果图 1. 请求 2. 控制台日志 一、准备工作 SpringBoot项目 pom依赖 (SpringBoot基础依赖,Aop依赖,Swagger依赖 ) <dependencies> <dependency> &
日志输出-第二章-接口级出入参的实现
阿沐沐的博客
05-22 1251
日志接口级统一出入参的实现
SpringBoot通过AOP实现系统日志记录（Controller层日志监控，将日志信息保存到数据库）
GY的的专栏
07-17 1684
1、 导入pom文件 <!--用于日志存储，不引用打包时会找不到JDBCAppender --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> ...
springmvcController层通用日志配置
01-31
springmvcController层通用日志配置
aop统一日志输出controller出入参及部分参数
qq_41214487的博客
05-20 579
aop统一日志输出controller出入参及部分参数 /** * @author cy c * @date 2022/5/19 16:28 * 统一日志处理 */ @Component @Aspect public class LogStdOut { private static final Logger logger = LoggerFactory.getLogger(LogStdOut.class); private final ObjectMapper objec.
aop+controllerAdvice+token验证+事物回滚+保存日志
bao122412的博客
04-15 814
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录前言一、AOP先加入依赖启动配置：@ComponentScan({"com.test"})，改成自己项目的包名aop工具二、统一异常处理三、请求接口注意四、日志保存总结
为spring的controller做一个打印日志、验证参数、提供默认异常处理的切面
w36680130的博客
08-29 225
为spring的controller做一个打印日志、验证参数、提供默认异常处理的切面
Spring AOP 应用 - 打印 Action （Controller ）层的日志信息
李威威的博客
12-13 1770
目的：通过 Spring 的 AOP 特性，对所有的 Action （Controller ）层增加前置通知，以观察前台如何请求后台数据（可以看到请求顺序、参数分别是什么）。所用技术： AOP 、slf4j（log4j）
在controller怎么让页面输出内容（弹框等）
Puzzle_L的博客
04-23 525
Controller执行JS代码
Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】
Appleyk的专栏
12-05 3万+
       最好的演示说明，不是上来就贴配置文件和代码，而是，先来一波配置文件的注释，再来一波代码的测试过程，最后再出个技术在项目中的应用效果，这样的循序渐进的方式，才会让读者更加清楚的理解一项技术是如何运用在项目中的，虽然本篇很简单，几乎不用手写什么代码，但是，比起网上其他人写的同类型的文章来说，我只能说，我很认真，认真的有点帅，哈哈哈哈。一、日志记录相关依赖，首选Spring-Boot"原生...
springboot 统一异常处理 + 日志记录
lgq2016的博客
04-13 2852
在项目的开发中，在某些情况下，比如非业务的操作，日志记录，权限认证和异常处理等。我们需要对客户端发出的请求进行拦截，常用的API拦截方式有Fliter，Interceptor，ControllerAdvice以及Aspect。先简单介绍一下不同的拦截方式。
JoinPoint获取完整controller接口名称
最新发布
10-25
<think>我们已经讨论过如何使用JoinPoint获取方法的完整名称（包括包名、类名和方法名）。现在用户的需求更具体：获取完整的Controller接口名称。这里的“接口名称”可能指Controller方法的完整路径（如URL路径），也可能指Java方法的完整签名（包名+类名+方法名）。结合引用[1]和[3]，用户可能是在记录操作日志时需要展示Controller方法的标识信息，并且希望避免手动维护枚举。 根据引用[3]：“通过自定义注解和AOP实现打印所有controller接口的出入参数”，我们可以推断用户主要关注的是Controller层的方法。因此，获取Controller方法的完整信息（如类名、方法名、URL路径等）是关键。 ### 解决方案 在Spring中，Controller的接口名称通常有两种含义： 1. **Java方法的完整签名**：包名+类名+方法名（如`com.example.controller.UserController.createUser`）。 2. **HTTP请求的路径**：如`/api/users`（通过`@RequestMapping`等注解定义）。 用户问题中提到的“完整controller接口名称”可能同时包含这两者，也可能仅指其中之一。但根据引用[1]，用户需要记录方法的中文名称并展示到页面，因此更可能关注的是Java方法的完整签名（因为URL路径通常不包含中文描述）。此外，如果用户想获取的是URL路径，则需要通过Spring的`RequestMappingHandlerMapping`等机制，而非直接通过`JoinPoint`。 ### 方法一：获取Controller方法的完整Java签名（推荐） 使用`JoinPoint`获取Controller方法的完整Java签名（包名+类名+方法名）是最直接的方式： ```java import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.stereotype.Component; @Aspect @Component public class ControllerAspect { @Before("execution(* com.example.controller..*.*(..))") // 针对controller包下的所有方法 public void logControllerMethod(JoinPoint joinPoint) { // 获取声明类型名（即Controller类的全限定名） String className = joinPoint.getSignature().getDeclaringTypeName(); // 获取方法名 String methodName = joinPoint.getSignature().getName(); // 拼接完整方法签名 String fullMethodSignature = className + "." + methodName; System.out.println("Controller方法完整签名: " + fullMethodSignature); } } ``` ### 方法二：获取Controller方法的URL路径（需结合Spring Web） 如果需要获取HTTP路径（如`/api/users`），则必须从Spring的`RequestMappingInfo`中提取。这种方式更复杂，但能获取实际接口路径： ```java import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping; import javax.servlet.http.HttpServletRequest; import java.util.Optional; @Aspect @Component public class ControllerAspect { @Autowired private RequestMappingHandlerMapping handlerMapping; @Before("execution(* com.example.controller..*.*(..))") public void logControllerUrl(JoinPoint joinPoint) throws Exception { HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest(); String requestUri = request.getRequestURI(); // 获取请求URI（如/api/users） System.out.println("接口请求路径: " + requestUri); // 如果需要更详细的映射信息（如匹配的Controller方法），可以使用handlerMapping // 但注意：在AOP中直接使用handlerMapping可能因请求未完全处理而受限，需谨慎 } } ``` **注意事项**： - 方法二依赖HTTP请求上下文（`RequestContextHolder`），因此仅适用于Web请求场景，且需确保在请求线程中执行（如`@Before`通知）。 - 获取的URI可能包含上下文路径（如`/app/api/users`），需根据实际情况处理。 ### 结合自定义注解获取中文名称（参考引用[1]） 引用[1]提到需要“方法的中文名称”，这通常需要自定义注解实现。例如定义`@OperationLog`注解： ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface OperationLog { String value(); // 中文名称 } ``` 在Controller方法上使用： ```java @RestController public class UserController { @OperationLog("创建用户") @PostMapping("/users") public void createUser() { /* ... */ } } ``` 在切面中获取注解值： ```java @Before("execution(* com.example.controller..*.*(..)) && @annotation(operationLog)") public void logOperation(JoinPoint joinPoint, OperationLog operationLog) { String chineseName = operationLog.value(); String fullMethodName = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName(); System.out.println("操作名称: " + chineseName + ", 方法: " + fullMethodName); } ``` ### 总结 - **获取Java签名**：直接通过`JoinPoint.getSignature()`组合`getDeclaringTypeName()`和`getName()`。 - **获取URL路径**：通过`RequestContextHolder`获取`HttpServletRequest`提取URI。 - **获取中文名称**：结合自定义注解实现，避免手动维护枚举[^1]。 §§相关问题§§ 1. 如何在AOP中同时获取Controller方法的URL路径和Java方法名？ 2. 使用JoinPoint获取Controller方法的参数有哪些最佳实践？ 3. 如何避免在AOP中频繁使用反射获取注解信息带来的性能问题？ [^1]: 在日常的开发中，我们有时需要记录用户的操作日志并展示到页面上，因此我们需要知道用户都调用了哪些方法，要展示到页面上，肯定是需要方法名称（中文名称），甚至包括其注释，参数等。 [^2]: 切面aspect：指定就是切面类，切面类会管理着切点、通知。通知advice：需要增强到业务方法中的公共代码。 [^3]: 通过自定义注解和AOP实现打印所有controller接口的出入参数。 </think>### 使用JoinPoint获取完整Controller接口名称的方法 在Spring AOP中，通过JoinPoint可以获取Controller方法的完整接口名称（包括包名、类名和方法名）。以下是具体实现方法，结合引用[1]和[3]中关于记录操作日志和打印接口参数的需求： #### 核心步骤 1. **声明切面并定义切入点** 使用`@Pointcut`定位所有Controller方法： ```java @Pointcut("within(@org.springframework.stereotype.Controller *) || " + "within(@org.springframework.web.bind.annotation.RestController *)") public void controllerMethods() {} ``` 2. **使用JoinPoint获取完整名称** 在通知方法中获取方法签名并组合完整名称： ```java @Before("controllerMethods()") public void logControllerMethod(JoinPoint joinPoint) { // 获取方法签名 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); // 组合完整接口名称：包名+类名+方法名 String fullName = joinPoint.getTarget().getClass().getName() // 完整类名 + "." + signature.getName(); // 方法名 System.out.println("Controller接口完整名称: " + fullName); } ``` #### 完整切面实现（结合引用[3]的自定义注解） ```java import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.stereotype.Component; @Aspect @Component public class ControllerLogAspect { // 定义切入点：所有Controller类的方法 @Pointcut("within(@org.springframework.stereotype.Controller *) || " + "within(@org.springframework.web.bind.annotation.RestController *)") public void controllerPointcut() {} // 前置通知记录接口名称 @Before("controllerPointcut()") public void logControllerName(JoinPoint joinPoint) { String className = joinPoint.getTarget().getClass().getName(); String methodName = ((MethodSignature) joinPoint.getSignature()).getName(); String fullInterfaceName = className + "." + methodName; // 实际应用中可替换为日志记录 System.out.println("[控制器接口] " + fullInterfaceName); } } ``` #### 关键说明 1. **`joinPoint.getTarget()`** 获取目标Controller实例（如`com.example.UserController`），比`getDeclaringTypeName()`更准确，能避免代理类问题[^3] 2. **类型转换** 使用`(MethodSignature) joinPoint.getSignature()`获取详细方法信息 3. **结合自定义注解（引用[1][3]）** 若需记录中文接口名，可添加自定义注解： ```java // 自定义注解 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface OperationLog { String value(); // 中文接口名称 } // 切面中获取注解 Method method = ((MethodSignature) joinPoint.getSignature()).getMethod(); OperationLog anno = method.getAnnotation(OperationLog.class); if(anno != null) { System.out.println("接口中文名称: " + anno.value()); } ``` #### 输出示例 当访问`UserController.getUser()`时： ``` [控制器接口] com.example.controller.UserController.getUser ``` ### 注意事项 1. **避免代理类问题** 使用`joinPoint.getTarget()`代替`joinPoint.getTarget().getClass()`可避免Spring AOP代理类干扰 2. **性能优化** 在频繁调用的接口中，建议缓存`MethodSignature`对象避免重复反射操作[^2] 3. **接口路径获取** 若需要URL路径而非Java方法名，可通过注入`HttpServletRequest`获取： ```java ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()) .getRequest().getRequestURI(); ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值