SpringBoot使用AOP記錄接口操作日志詳解

<!-- Spring AOP -->
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

@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;

}

/**
 * controller層切面日志註解
 * @author hsq
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SystemControllerLog {
    // 操作描述
    String operate();
    // 模塊
    String module();
}

**
 * @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;

    }

}

 @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){}