Spring AOP與自定義註解Annotation的使用

AOP，Spring框架的兩大核心之一，又稱面向切面編程，通過代理模式，對原有的類進行增強。在Spring框架中，AOP有兩種動態代理方式，其一是基於JDK的動態代理，需要代理的類實現某一個接口；其二是基於CGLIB的方式，該方式不需要類實現接口就能進行代理。AOP的應用場景，常見的就是事務的處理和日誌的記錄，還有權限的認證。（筆者使用AOP的場景：保存所有用戶對數據進行的增刪改內容等，比如，張三修改了一個表格數據的值，就需要記錄誰，什麼時候，修改or添加or刪除，哪項數據，數據的舊值和新值是什麼。因爲涉及到的接口很多，也很分散，所以筆者使用aop和自定義註解，讓所有涉及到增刪改的接口添加自定義註解，以達到在保存記錄之後進行操作日誌記錄。）

Annotation，自定義註解，基於Java六大元註解的註解（target、document、retention、inherited、repeatable和類型註解）。一般創建自定義註解，至少會在該註解上添加@target（註解的位置，如添加到方法上或者是類上）和@retention（註解使用的時機，編譯期間或者運行時等）倆個註解。

一、自定義註解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {
    //表示操作是那個服務哪個模塊下的操作
    String module() default "xxxx服務";

    //操作的類型，添加，更新，刪除
    String type() default "add";

    //操作者
    String user() default "system";

    //操作描述
    String operation() default "";
}

二、Aspect類

import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.text.SimpleDateFormat;

@Aspect
@Component
public class OperationLogAspect {
    private ThreadLocal<SimpleDateFormat> format = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
    
    //切點表達式，表示加了OperationLog註解的都是切點，路徑是自定義註解的全路徑
    @Pointcut("@annotation(com.alice.springboot.demo.OperationLog)")
    public void pointcut()
    {
        
    }
    
    @Around("@annotation(operationLog)")
    public Object operationLogRecord(ProceedingJoinPoint joinPoint, OperationLog operationLog)
    {
        //獲取請求
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        //響應
        ResponseResult<Object> responseResult = null;
        //判斷原方法是否正常執行的標誌
        boolean isNormalProcess = false;
        
        try 
        {
            //返回切點處繼續執行原方法，並接收原方法的響應
            responseResult = (ResponseResult<Object>) joinPoint.proceed();    
            //如果順利執行，那麼說明原方法執行正常，就可以進行日誌記錄。因爲，如果原方法的增刪改出問題了，那麼日誌就不需要記錄了，不用記錄失敗的操作。
            isNormalProcess = true;
        }
        catch (Throwable e)
        {
            System.out.println("原方法報錯，不需要記錄日誌");
        }
        
        try 
        {
            if (isNormalProcess)
            {
                //如果原方法正常執行完畢，那麼需要記錄操作日誌
                saveOperationLog(joinPoint, operationLog, request);
            }
        }
        catch (Exception e)
        {
            System.out.println("保存操作日誌出錯");
        }
        
        return  responseResult;
    }
    
    private void saveOperationLog(ProceedingJoinPoint joinPoint, OperationLog operationLog, HttpServletRequest request)
    {
        //用來記錄參數的值
        StringBuilder contentBuilder = new StringBuilder();
        //從切點獲取切點的所有參數
        Object[] allParams = joinPoint.getArgs();
        
        for (Object param: allParams)
        {
            contentBuilder.append(JSON.toJSONString(param) + ",");
        }
        //刪除最後一個多餘的逗號
        contentBuilder.delete(contentBuilder.length() - 1, contentBuilder.length());
        
        //執行數據庫操作，將信息保存到數據庫，筆者這裏使用的是mongodb，僅供參考，主要看獲取自定義註解裏面的值
        Document document = new  Document();
        //獲取自定義註解裏面的值
        document.append("module", operationLog.module())
                .append("type", operationLog.type())
                .append("user", operationLog.user())
                .append("operation", operationLog.operation())
                .append("content", contentBuilder.toString());
        
        logDao.saveLogs("mongo collection name", document);
    }
    
}

三、如何使用——controller層使用

package com.alice.springboot.demo;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(value = "/test")
public class OperationLogController {

    @RequestMapping(value = "/add", method = RequestMethod.POST)
    @OperationLog(module = "xxx服務", type = "add", operation = "添加xxx")
    //這裏使用到了自定義註解，並且賦值了自定義註解裏面的某些值，最後在aspect裏面可以獲取到這些值
    public ResponseResult<String> addOperation(String user, String content)
    {
        ResponseResult<String> result = new ResponseResult<>();

        try
        {
            //執行添加操作
            result.setStatus(ResponseStatusEnum.SUCCESS);
            result.setMessage("添加操作成功");
        }
        catch (Exception e)
        {
            result.setStatus(ResponseStatusEnum.FAIL);
            result.setMessage("添加操作失敗" + e.toString());
        }

        return result;
    }
}

以上就是Spring APO結合自定義註解的使用。