SpringBoot開發技巧之使用AOP記錄日志示例解析

Posted on by

為什麼要用AOP？

答案是解耦！

Aspect Oriented Programming 面向切面編程。解耦是程序員編碼開發過程中一直追求的。AOP也是為瞭解耦所誕生。

具體思想是：定義一個切面，在切面的縱向定義處理方法，處理完成之後，回到橫向業務流。

AOP 主要是利用代理模式的技術來實現的。

具體的代理實現可以參考這篇文章，講解的非常詳細。https://www.jb51.net/article/130525.htm

通過預編譯方式和運行期動態代理實現程序功能的統一維護的一種技術。利用 AOP 可以對業務邏輯的各個部分進行隔離，從而使得業務邏輯各部分之間的耦合度降低，提高程序的可重用性，同時提高瞭開發的效率。

 
 

常用的工作場景

事務控制

日志記錄

本文沒有過度深度學習原理，因為是菜鳥一個，先學會怎麼不加班。

必須知道的概念

AOP 的相關術語

通知（Advice）

通知描述瞭切面要完成的工作以及何時執行。比如我們的日志切面需要記錄每個接口調用時長，就需要在接口調用前後分別記錄當前時間，再取差值。

  • 前置通知（Before）：在目標方法調用前調用通知功能；
  • 後置通知（After）：在目標方法調用之後調用通知功能，不關心方法的返回結果；
  • 返回通知（AfterReturning）：在目標方法成功執行之後調用通知功能；
  • 異常通知（AfterThrowing）：在目標方法拋出異常後調用通知功能；
  • 環繞通知（Around）：通知包裹瞭目標方法，在目標方法調用之前和之後執行自定義的行為。

連接點（JoinPoint）

通知功能被應用的時機。比如接口方法被調用的時候就是日志切面的連接點。

切點（Pointcut）

切點定義瞭通知功能被應用的范圍。比如日志切面的應用范圍就是所有接口，即所有 controller 層的接口方法。

切面（Aspect）

切面是通知和切點的結合，定義瞭何時、何地應用通知功能。

引入（Introduction）

在無需修改現有類的情況下，向現有的類添加新方法或屬性。

織入（Weaving）

把切面應用到目標對象並創建新的代理對象的過程。

Spring 中使用註解創建切面

相關註解

@Aspect：用於定義切面

@Before：通知方法會在目標方法調用之前執行

@After：通知方法會在目標方法返回或拋出異常後執行

@AfterReturning：通知方法會在目標方法返回後執行

@AfterThrowing：通知方法會在目標方法拋出異常後執行

@Around：通知方法會將目標方法封裝起來

@Pointcut：定義切點表達式

切點表達式

指定瞭通知被應用的范圍，表達式格式：

execution
(方法修飾符
 
返回類型
 
方法所屬的包.類名.方法名稱(方法參數)
//com.ninesky.study.tiny.controller包中所有類的public方法都應用切面裡的通知
execution(public * com.ninesky.study.tiny.controller.*.*(..))
//com.ninesky.study.tiny.service包及其子包下所有類中的所有方法都應用切面裡的通知
execution(* com.ninesky.study.tiny.service..*.*(..))
//com.ninesky.study.tiny.service.PmsBrandService類中的所有方法都應用切面裡的通知
execution(* com.macro.ninesky.study.service.PmsBrandService.*(..))

實戰應用-利用AOP記錄日志

從傳統行業轉行，以前都沒想過打日志埋點，第一份工作，真的應該選擇一個好的平臺比較重要。

定義日志信息封裝

用於封裝需要記錄的日志信息，包括操作的描述、時間、消耗時間、url、請求參數和返回結果等信息

public class WebLog {
    /**
     * 操作描述
     */
    private String description;
    /**
     * 操作用戶
     */
    private String username;
    /**
     * 操作時間
     */
    private Long startTime;
    /**
     * 消耗時間
     */
    private Integer spendTime;
    /**
     * 根路徑
     */
    private String basePath;
    /**
     * URI
     */
    private String uri;
    /**
     * URL
     */
    private String url;
    /**
     * 請求類型
     */
    private String method;
    /**
     * IP地址
     */
    private String ip;
    /**
     * 請求參數
     */
    private Object parameter;
    /**
     * 請求返回的結果
     */
    private Object result;
    //省略瞭getter,setter方法
}

定義註解,通過註解減少代碼量

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OperationLog {
    String name();//調用接口的名稱
 
    boolean intoDb() default false;//該條操作日志是否需要持久化存儲
}

統一日志處理切面

@Aspect
@Component
@Order(1)
@Slf4j
public class WebLogAspect {
    private static final Logger controlLog = LoggerFactory.getLogger("tmall_control");
    @Pointcut("execution(public * com.yee.walnut.*.*.*(..))")
    public void webLog() {
    }
 
    @Before(value = "webLog()&& @annotation(OperationLog)")
    public void doBefore(ControllerWebLog controllerWebLog) throws Throwable {
    }
 
    @AfterReturning(value = "webLog()&& @annotation(OperationLog)", returning = "ret")
    public void doAfterReturning(Object ret, ControllerWebLog controllerWebLog) throws Throwable {
    }
 
    @Around(value = "webLog()&& @annotation(OperationLog)")
    public Object doAround(ProceedingJoinPoint joinPoint, OperationLog operationLog) throws Throwable {
        long startTime = System.currentTimeMillis();
        //獲取當前請求對象
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //記錄請求信息
        Object[] objs = joinPoint.getArgs();
        WebLog webLog = new WebLog();
        Object result = joinPoint.proceed();//返回的結果，這是一個進入方法和退出方法的一個分界
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        long endTime = System.currentTimeMillis();
        String urlStr = request.getRequestURL().toString();
        webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));
        webLog.setIp(request.getRemoteUser());
        webLog.setMethod(request.getMethod());
        webLog.setParameter(getParameter(method, joinPoint.getArgs()));
        webLog.setResult(JSONUtil.parse(result));
        webLog.setSpendTime((int) (endTime - startTime));
        webLog.setStartTime(startTime);
        webLog.setUri(request.getRequestURI());
        webLog.setUrl(request.getRequestURL().toString());
        controlLog.info("RequestAndResponse {}", JSONObject.toJSONString(webLog));
        //必須有這個返回值。可以這樣理解，Around方法之後，不再是被織入的函數返回值，而是Around函數返回值
        return result;
    } 
    /**
     * 根據方法和傳入的參數獲取請求參數
     */
    private Object getParameter(Method method, Object[] args) {
        List<Object> argList = new ArrayList<>();
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            //將RequestBody註解修飾的參數作為請求參數
            RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);
            if (requestBody != null) {
                argList.add(args[i]);
            }
            //將RequestParam註解修飾的參數作為請求參數
            RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);
            if (requestParam != null) {
                Map<String, Object> map = new HashMap<>();
                String key = parameters[i].getName();
                if (!StringUtils.isEmpty(requestParam.value())) {
                    key = requestParam.value();
                }
                map.put(key, args[i]);
                argList.add(map);
            } else {
                argList.add(args[i]);
            }
        }
        if (argList.size() == 0) {
            return null;
        } else if (argList.size() == 1) {
            return argList.get(0);
        } else {
            return argList;
        }
    }
}

在方法上加上自定義註解即可

@OperationLog(name = "TurnOnOffStrategy")
public String doOperation(GlobalDto globalDto, DeviceOperator deviceOperator) {
}

以上就是SpringBoot開發技巧之利用AOP記錄日志示例解析的詳細內容，更多關於SpringBoot開發AOP記錄日志的資料請關註WalkonNet其它相關文章！

推薦閱讀：