SpringBoot 使用 AOP 记录接口操作日志，供大家参考，具体内容如下
一、AOP简介
1.什么是AOP
AOP：Aspect Oriented Programming 面向切面编程
AOP关注不是某一个类或某些方法；控制大量资源，关注的是大量的类和方法。
2.AOP应用场景以及常用术语
权限控制、缓存控制、事务控制、分布式追踪、异常处理等Target：目标类，即需要被代理的类。例如：UserServiceJoinpoint(连接点):所谓连接点是指那些可能被拦截到的方法。例如：所有的方法PointCut 切入点：已经被增强的连接点。例如：addUser()Advice 通知/增强，增强代码。例如：after、beforeWeaving(织入):是指把增强advice应用到目标对象target来创建新的代理对象proxy的过程.Aspect(切面): 是切入点pointcut和通知advice的结合
3.AOP的特点
1）降低模块与模块之间的耦合度，提高业务代码的聚合度。（高内聚低耦合）
2）提高了代码的复用性
3）提高系统的扩展性。（高版本兼容低版本）
4）可以在不影响原有的功能基础上添加新的功能
二、springBoot 使用 AOP 实现流程
1.引入依赖
<!-- Spring AOP --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2.封装记录日志实体类
@Getter
@Setter
@ApiModel(value = "Systemlog对象", description = "")
public class Systemlog implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("ID")
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
@ApiModelProperty("用户名")
private String userName;
@ApiModelProperty("用户ID")
private Integer userId;
@ApiModelProperty("操作描述")
private String operate;
@ApiModelProperty("模块")
private String module;
@ApiModelProperty("创建日志时间")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createTime;
@ApiModelProperty("操作结果")
private String result;
}
3.编写注解类(自定义日志注解类)
/**
* controller层切面日志注解
* @author hsq
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SystemControllerLog {
// 操作描述
String operate();
// 模块
String module();
}
4.编写操作日志的切面类
**
* @author hsq
*/
@Aspect
@Component
public class SystemLogAspect {
private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect.class);
@Autowired
private ISystemlogService iSystemlogService;
@Autowired
private UserService userService;
/**
* Controller层切点
*/
@Pointcut("@annotation(com.hsq.demo.config.SystemControllerLog)")
public void SystemControllerLog(){
}
/**
* 前置通知 用于拦截Controller层记录用户的操作的开始时间
* @param joinPoint 切点
* @throws InterruptedException
*/
@Before("SystemControllerLog()")
public void doBefore(JoinPoint joinPoint) throws InterruptedException{
logger.info("进入日志切面前置通知!");
}
@After("SystemControllerLog()")
public void doAfter(JoinPoint joinPoint) {
logger.info("进入日志切面后置通知!");
}
/**value切入点位置
* returning 自定义的变量，标识目标方法的返回值,自定义变量名必须和通知方法的形参一样
* 特点：在目标方法之后执行的,能够获取到目标方法的返回值，可以根据这个返回值做不同的处理
*/
@AfterReturning(value = "SystemControllerLog()", returning = "ret")
public void doAfterReturning(Object ret) throws Throwable {
}
/***
* 异常通知 记录操作报错日志
* * @param joinPoint
* * @param e
* */
@AfterThrowing(pointcut = "SystemControllerLog()", throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
logger.info("进入日志切面异常通知!!");
logger.info("异常信息:" + e.getMessage());
}
//使用这个方法先注释前面三个方法，留before方法就行
/**
* 通知包裹了目标方法，在目标方法调用之前和之后执行自定义的行为
* ProceedingJoinPoint切入点可以获取切入点方法上的名字、参数、注解和对象
* @param joinPoint
*/
@Around("SystemControllerLog() && @annotation(systemControllerLog)")
public Result doAfterReturning(ProceedingJoinPoint joinPoint, SystemControllerLog systemControllerLog) throws Throwable {
logger.info("设置日志信息存储到表中!");
//joinPoint.proceed() 结果集
//参数数组
Object[] args = joinPoint.getArgs();
//请求参数数据
String requestJson = JSONUtil.toJsonStr(args);
//方法名
String methodName = joinPoint.getSignature().getName();
//得到request
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
//得到token
String token = request.getHeader("token");
String userId = JWT.decode(token).getAudience().get(0);
User user = userService.getById(userId);
logger.info("得到用户信息："+user.toString());
//写入数据库操作日志
Systemlog systemlog = new Systemlog();
systemlog.setUserId(user.getUid());
systemlog.setUserName(user.getUname());
systemlog.setOperate(systemControllerLog.operate());
systemlog.setModule(systemControllerLog.module());
systemlog.setCreateTime(new Date());
//存入返回的结果集 joinPoint.proceed()
Result proceed = (Result) joinPoint.proceed();
systemlog.setResult(JSONUtil.toJsonStr(joinPoint.proceed()));
//保存
saveSystemLog(systemlog);
return proceed;
}
}
5.controller使用
@GetMapping("/userListPage")
@SystemControllerLog(operate = "用户查询",module = "用户管理")
public Result findUserList( @RequestParam Integer pageNum,
@RequestParam Integer pageSize,
@RequestParam String username,
@RequestParam String loveValue,
@RequestParam String address) {}
@PostMapping("/addOrUpdate")
@SystemControllerLog(operate = "用户修改或者添加",module = "用户管理")
public Result addOrUpdateUser(@RequestBody User user){}
6.数据库记录
