【Spring】每个程序员都使用Spring(四)——Aop+自定义注解做日志拦截
一、前言
上一篇博客向大家介绍了Aop的概念,对切面=切点+通知 、连接点、织入、目标对象、代理(jdk动态代理和CGLIB代理)有所了解了。理论很强,实用就在这篇博客介绍。
这篇博客中,小编向大家介绍springAop很常见的使用方式——日志拦截
二、实战
2.1 全局观说明

说明:
假如service出错了,这样错误会抛出到controller,controller捕捉到后,抛出自定义异常。然后@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常,捕获controller抛出的异常。在这个方法中为AOP的连接点,会触发AOP的通知方法。通知方法捕获request和response,打印出详细的错误日志信息。
2.2 建立springboot项目 引入相关依赖
主要添加springmvc和springaop的依赖。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wl</groupId>
<artifactId>sbDemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>sbDemo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.10.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--aop-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!--springmvc-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>21.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.0</version>
<scope>provided</scope>
</dependency>
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>5.0.7.RELEASE</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.3 建立 切面类
使用@Aspect 和 @Component
两个注解,表示是切面类,并且可以被spring管理。
在切面中,添加环绕通知,切点是 com.wl.sbDemo包路径下的 且带有ResponseBody或RequestMapping注解的 且带有RequestLogging自定义注解的。
当有同上满足这三个条件的连接点触发的时候,就会触发环绕通知的方法。这个环绕通知的方法主要就是拦截request和response的信息,打印日志。
package com.wl.sbDemo.aspect;
import com.wl.sbDemo.aspect.config.RequestAttributeConst;
import com.wl.sbDemo.aspect.web.RequestDetailsLogger;
import com.wl.sbDemo.aspect.web.ResponseDetailsLogger;
import com.wl.sbDemo.aspect.web.ServletContextHolder;
import io.swagger.annotations.ApiOperation;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.time.OffsetDateTime;
/**
* 本类设计为当有被@RequestBodyLogs修饰的@ControllerAdvice或者@Controller抛出异常时记录输入输出,
* 其他情况仅记录被标记的@RequestMapping或@ResponseBody方法
*
* @author soul
* @see //RequestLogging
* @see org.springframework.web.bind.annotation.ControllerAdvice
*/
@Aspect
@Component
public class RequestLoggingAspect {
private static final Logger LOGGER = LoggerFactory.getLogger(RequestLoggingAspect.class);
@Around(value = "within(com.wl.sbDemo..*) " +
"&& (@annotation(org.springframework.web.bind.annotation.ResponseBody)" +
"|| @annotation(org.springframework.web.bind.annotation.RequestMapping)) " +
"&& @annotation(com.wl.sbDemo.aspect.RequestLogging)")
public Object aroundMethod(ProceedingJoinPoint joinPoint) throws Throwable {
// 生成请求日志
RequestDetailsLogger requestLog = generateJsonRequestDetails();
// 获取Swagger上的API描述
injectApiOperationDescription(joinPoint, requestLog);
// 执行真实请求
final Object proceed = joinPoint.proceed();
// 当响应完成时, 打印完整的'request & response'信息
requestLog.setResponseTime(OffsetDateTime.now());
LOGGER.info("RequestLoggingAspect#\r\nREQUEST->\r\n{}\r\nRESPONSE->\r\n {}", requestLog, ResponseDetailsLogger.with(proceed));
// 放行
return proceed;
}
/**
* 创建通用的日志输出模式并绑定线程
*
* @return 日志模型
*/
private RequestDetailsLogger generateJsonRequestDetails() {
RequestDetailsLogger logDetails = (RequestDetailsLogger) ServletContextHolder.getRequest().getAttribute(RequestAttributeConst.DETAILS_KEY);
if (logDetails == null) {
logDetails = new RequestDetailsLogger();
ServletContextHolder.getRequest().setAttribute(RequestAttributeConst.DETAILS_KEY, logDetails);
}
return logDetails;
}
private void injectApiOperationDescription(ProceedingJoinPoint joinPoint, RequestDetailsLogger logDetails) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
final ApiOperation operate = method.getAnnotation(ApiOperation.class);
if (operate != null) {
logDetails.setApiDesc(operate.value());
}
}
}
自定义注解:
定义了自定义注解,用于标记连接点。标记出是切点。
@Retention– 定义该注解的生命周期,RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。
@Target – 表示该注解用于什么地方,METHOD:用于描述方法。
package com.wl.sbDemo.aspect;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author soul
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface RequestLogging {
}
2.4 Controller
就是一个普遍的controller类,这里小编用于抛出异常,抛出指定的自定义异常。
package com.wl.sbDemo.controller;
import com.wl.sbDemo.common.StatusCode;
import com.wl.sbDemo.exception.Shift;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* Created by Ares on 2018/7/5.
*/
@RestController
@RequestMapping("/user")
public class UserController {
@GetMapping("/findById")
public int findById(@RequestParam("id") int id ){
try {
if (id>10){
id = id /0;
}
} catch (Exception e) {
Shift.fatal(StatusCode.INVALID_MODEL_FIELDS,e.getMessage());
}
return id;
}
}
Shift抛出异常类:
package com.wl.sbDemo.exception;
import com.wl.sbDemo.common.RestStatus;
import com.wl.sbDemo.model.ErrorEntity;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import java.util.Optional;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* @author soul
*/
public final class Shift {
private Shift() {
}
/**
* 抛出具体的{@code RestStatus}异常
*
* @param status 自定义异常实体
* @param details 额外添加至details字段中的任意实体, 最终会被解析成JSON
*/
public static void fatal(RestStatus status, Object... details) {
checkNotNull(status);
final ErrorEntity entity = new ErrorEntity(status);
// inject details
if (details.length > 0) {
Optional.of(details).ifPresent(entity::setDetails);
}
// put it into request, details entity by Rest Status's name
String errorCode = String.valueOf(status.code());
bindStatusCodesInRequestScope(errorCode, entity);
throw new RestStatusException(errorCode);
}
private static void bindStatusCodesInRequestScope(String key, ErrorEntity entity) {
checkNotNull(entity);
checkNotNull(key);
final RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (requestAttributes != null) {
((ServletRequestAttributes) requestAttributes).getRequest().setAttribute(key, entity);
}
}
}
自定义异常RestStatusException:
package com.wl.sbDemo.exception;
/**
* @author soul
*/
public class RestStatusException extends RuntimeException {
private static final long serialVersionUID = -8541311111016065562L;
public RestStatusException(String message) {
super(message);
}
public RestStatusException(String message, Throwable cause) {
super(message, cause);
}
public RestStatusException(Throwable cause) {
super(cause);
}
protected RestStatusException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
2.5 Controller的全局异常拦截类
使用了@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常。
@ControllerAdvice : 定义全局异常处理类
@ExceptionHandler : 声明拦截指定异常的方法
以本例中的restStatusException方法来说,开头添加了@ResponseBody和@RequestLogging注解,并且这个方法也在com.wl.sbDemo包下,符合Springaop的连接点的条件。所以当这个方法触发的时候就会触发切面类中的通知方法。
package com.wl.sbDemo.controller.advice;
import com.google.common.collect.ImmutableMap;
import com.wl.sbDemo.aspect.RequestLogging;
import com.wl.sbDemo.aspect.config.RequestAttributeConst;
import com.wl.sbDemo.common.RestStatus;
import com.wl.sbDemo.common.StatusCode;
import com.wl.sbDemo.exception.IllegalValidateException;
import com.wl.sbDemo.exception.ReservationExpireException;
import com.wl.sbDemo.exception.RestStatusException;
import com.wl.sbDemo.model.ErrorEntity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.UnsatisfiedServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import javax.servlet.http.HttpServletRequest;
/**
* @author soul
*/
@ControllerAdvice
public class FaultBarrier {
private static final Logger LOGGER = LoggerFactory.getLogger(FaultBarrier.class);
private static final ImmutableMap<Class<? extends Throwable>, RestStatus> EXCEPTION_MAPPINGS;
static {
final ImmutableMap.Builder<Class<? extends Throwable>, RestStatus> builder = ImmutableMap.builder();
// HTTP Request Method不存在
// 账户更新错误
builder.put(ReservationExpireException.class, StatusCode.RESERVATION_EXPIRE);
// 其他未被发现的异常
// SpringMVC中参数类型转换异常,常见于String找不到对应的ENUM而抛出的异常
builder.put(MethodArgumentTypeMismatchException.class, StatusCode.INVALID_PARAMS_CONVERSION);
builder.put(UnsatisfiedServletRequestParameterException.class, StatusCode.INVALID_PARAMS_CONVERSION);
builder.put(IllegalValidateException.class, StatusCode.INVALID_PARAMS_CONVERSION);
builder.put(IllegalArgumentException.class, StatusCode.INVALID_PARAMS_CONVERSION);
// HTTP Request Method不存在
builder.put(HttpRequestMethodNotSupportedException.class, StatusCode.REQUEST_METHOD_NOT_SUPPORTED);
// 要求有RequestBody的地方却传入了NULL
builder.put(HttpMessageNotReadableException.class, StatusCode.HTTP_MESSAGE_NOT_READABLE);
// 通常是操作过快导致DuplicateKey
builder.put(DuplicateKeyException.class, StatusCode.DUPLICATE_KEY);
// 其他未被发现的异常
builder.put(Exception.class, StatusCode.SERVER_UNKNOWN_ERROR);
EXCEPTION_MAPPINGS = builder.build();
}
/**
* <strong>Request域取出对应错误信息</strong>, 封装成实体ErrorEntity后转换成JSON输出
*
* @param e {@code StatusCode}异常
* @param request HttpServletRequest
* @return ErrorEntity
* @see ErrorEntity
* @see StatusCode
*/
@ResponseBody
@RequestLogging
@ExceptionHandler(RestStatusException.class)
public Object restStatusException(Exception e, HttpServletRequest request) {
// 取出存储在Shift设定在Request Scope中的ErrorEntity
return request.getAttribute(e.getMessage());
}
/**
* <strong>Request域取出对应错误信息</strong>, 封装成实体ErrorEntity后转换成JSON输出
*
* @param e {@code IllegalValidateException}异常
* @param request HttpServletRequest
* @return ErrorEntity
* @see ErrorEntity
*/
@ResponseBody
@RequestLogging
@ExceptionHandler(IllegalValidateException.class)
public Object illegalValidateException(Exception e, HttpServletRequest request) {
LOGGER.error("request id: {}\r\nexception: {}", request.getAttribute(RequestAttributeConst.REQUEST_ID), e.getMessage());
if (LOGGER.isDebugEnabled()) {
e.printStackTrace();
}
// 取出存储在Request域中的Map
return request.getAttribute(e.getMessage());
}
@ResponseBody
@RequestLogging
@ExceptionHandler(Exception.class)
public ErrorEntity exception(Exception e, HttpServletRequest request) {
if (LOGGER.isDebugEnabled()) {
e.printStackTrace();
}
LOGGER.error("request id: {}\r\nexception: {}", request.getAttribute(RequestAttributeConst.REQUEST_ID), e.getMessage());
final RestStatus status = EXCEPTION_MAPPINGS.get(e.getClass());
final ErrorEntity error;
if (status != null) {
error = new ErrorEntity(status);
}
else {
error = new ErrorEntity(StatusCode.SERVER_UNKNOWN_ERROR);
}
return error;
}
}
2.6 运行
运行代码后,输入http://localhost:8080/user/findById?id=sdfsdf
,因为id接收的是int,所以传入字符串是肯定报错的。在看我们的打印的日志:
将详细信息完美的打印出来,如果有ES日志收集,更加方便我们查看。

三、小结
这个实战,主要用到了springaop,把日志很好的拦截下来,使用也很方便。同上也用到了自定义注解,指明了在方法使用。还用到了springmvc的全局异常处理类注解@ControllerAdvice 和@ExceptionHandler 更加准确的捕捉问题。
本文源码 :https://github.com/AresKingCarry/aop
原文地址:https://blog.csdn.net/kisscatforever/article/details/80921561
【Spring】每个程序员都使用Spring(四)——Aop+自定义注解做日志拦截的更多相关文章
- 利用Spring AOP自定义注解解决日志和签名校验
转载:http://www.cnblogs.com/shipengzhi/articles/2716004.html 一.需解决的问题 部分API有签名参数(signature),Passport首先 ...
- (转)利用Spring AOP自定义注解解决日志和签名校验
一.需解决的问题 部分API有签名参数(signature),Passport首先对签名进行校验,校验通过才会执行实现方法. 第一种实现方式(Origin):在需要签名校验的接口里写校验的代码,例如: ...
- spring AOP自定义注解 实现日志管理
今天继续实现AOP,到这里我个人认为是最灵活,可扩展的方式了,就拿日志管理来说,用Spring AOP 自定义注解形式实现日志管理.废话不多说,直接开始!!! 关于配置我还是的再说一遍. 在appli ...
- spring boot aop 自定义注解 实现 日志检验 权限过滤
核心代码: package com.tran.demo.aspect; import java.lang.reflect.Method; import java.time.LocalDateTime; ...
- 程序员DD 《Spring boot教程系列》补充
最近在跟着程序员DD的Spring boot教程系列学习Spring boot,由于年代原因,Spring boot已经发生了一些变化,所以在这里进行一些补充. 补充的知识大多来自评论区,百度,Sta ...
- Java后端程序员都做些什么?
这个问题来自于QQ网友,一句两句说不清楚,索性写个文章. 我刚开始做Web开发的时候,根本没有前端,后端之说. 原因很简单,那个时候服务器端的代码就是一切:接受浏览器的请求,实现业务逻辑,访问数据库, ...
- 为什么说程序员都应该玩一玩GitHub
既熟悉又陌生的GitHub 关于GitHub,相信每一个程序员都再熟悉不过了.它为开发者提供Git仓库的托管服务,是全世界最大的代码集中地,被戏称为“全球最大同性交友网站”. 但是对于很大一部分程序员 ...
- Java程序员都应该去使用一下这款强大的国产工具类库
这不是标题党,今天给大家推荐一个很棒的国产工具类库:Hutool.可能有很多朋友已经知道这个类库了,甚至在已经在使用了,如果你还没有使用过,那不妨去尝试一下,我们项目组目前也在用这个.这篇文章来简单介 ...
- 每个程序员都应该了解的 CPU 高速缓存
每个程序员都应该了解的 CPU 高速缓存 英文原文:Memory part 2: CPU caches 来源:oschina [编者按:这是Ulrich Drepper写“程序员都该知道存储器”的第二 ...
随机推荐
- [unity基础教程]Unity3D实现动态载入游戏资源(转)
用Unity3D制作基于web的网络游戏,不可避免的会用到一个技术-资源动态载入.比方想载入一个大场景的资源,不应该在游戏的開始让用户长时间等待全部资源的载入完成.应该优先载入用户附近的场景资源.在游 ...
- dataframe字段过长被截断
总之能,情况就是这样. 看看df类型: 64位明显不够用啊. 网上找到了segmentfault有这个问题,上面说试试 pd.set_option('display.width', 200) ,再百度 ...
- /etc/fstab自动挂载文件
装了Windows 10和Ubuntu双系统,想把win10下的“文娱“盘自动开机挂载到Ubuntu上. 首先你看一下/etc/fstab这个文件喽: 依葫芦画瓢呗.首先看看你要挂载的硬盘是哪一块: ...
- 42.Flatten Binary Tree to Linked List
Level: Medium 题目描述: Given a binary tree, flatten it to a linked list in-place. For example, given ...
- DOM查询的其他方法
document.body 保存的是body的引用 documen.documentElement 保存的是html根标签 document.all 代表页面中所有的元素 getElementsByC ...
- Oracle update 两表及以上关联更新,出现多值情况,不是一对一更新
为了方便起见,建立了以下简单模型,和构造了部分测试数据:在某个业务受理子系统BSS中, SQL 代码--客户资料表 create table customers ( customer_id numbe ...
- 简易的富文本编辑器WangEditor
网址http://www.wangeditor.com/ var E = window.wangEditor; var editor = new E('#editor') // 或者 var edit ...
- go语言从例子开始之Example16.函数递归
Go 支持 递归.这里是一个经典的阶乘示例. Example: package main import "fmt" func fact(n int) int{ //先设置退出条件 ...
- 【机器学习实验】scikit-learn的主要模块和基本使用
[机器学习实验]scikit-learn的主要模块和基本使用 引言 对于一些开始搞机器学习算法有害怕下手的小朋友,该如何快速入门,这让人挺挣扎的.在从事数据科学的人中,最常用的工具就是R和Python ...
- webpack 学习2 入口(entry)和输入管理(output)
在开始上代码之前,先让我们盘一盘什么是webpack中的入口和输入 入口 假设你现在手里有一个水龙头,然后十个人用水管从你这里拿水.你这个龙头就是水的入口,水管就是你和这些人的依赖联系.现在供水局的要 ...