Java SpringBoot項目如何優雅的實現操作日志記錄

Posted on by

前言

在實際開發當中，對於某些關鍵業務，我們通常需要記錄該操作的內容，一個操作調一次記錄方法，每次還得去收集參數等等，會造成大量代碼重復。 我們希望代碼中隻有業務相關的操作，在項目中使用註解來完成此項功能。

通常就是使用Spring中的AOP特性來實現的，那麼在SpringBoot項目當中應該如何來實現呢？

一、AOP是什麼？

AOP(Aspect-Oriented Programming:⾯向切⾯編程)，說起AOP，幾乎學過Spring框架的人都知道，它是Spring的三大核心思想之一（IOC：控制反轉，DI：依賴註入，AOP：面向切面編程）。能夠將那些與業務⽆關，卻為業務模塊所共同調⽤的邏輯或責任（例如事務處理、⽇志管理、權限控制等）封裝起來，便於減少系統的重復代碼，降低模塊間的耦合度，並有利於未來的可拓展性和可維護性。

二、AOP做瞭什麼？

簡單說來，AOP主要做三件事：

  • 1、在哪裡切入，也就是日志記錄等非業務代碼在哪些業務代碼中執行。
  • 2、在什麼時候切入，是在業務代碼執行前還是後。
  • 3、切入後做什麼事情，比如權限校驗，日志記錄等。

可以用一張圖來理解：

圖上的一個核心術語的說明：

  • Pointcut：切點，決定在何處切入業務代碼中（即織入切面）。切點分為execution方式和annotation方式。execution方式：可以用路徑表達式指定哪些類織入切面，annotation方式：可以指定被哪些註解修飾的代碼織入切面。
  • Advice：處理，包括處理時機和處理內容。處理內容就是要做什麼事，比如校驗權限和記錄日志。處理時機就是在什麼時機執行處理內容，分為前置處理（即業務代碼執行前）、後置處理（業務代碼執行後）等。
  • Aspect：切面，即Pointcut和Advice。
  • Joint point：連接點，是程序執行的一個點。例如，一個方法的執行或者一個異常的處理。在 Spring AOP 中，一個連接點總是代表一個方法執行。
  • Weaving：織入，就是通過動態代理，在目標對象方法中執行處理內容的過程。

三、實現步驟

（1）自定義一個註解@Log （2）創建一個切面類，切點設置為攔截標註@Log的方法，截取傳參，進行日志記錄 （3）將@Log標註在接口上

具體的實現步驟如下：

1. 添加AOP依賴

代碼如下（示例）：

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

2. 自定義一個日志註解

日志一般使用的是註解類型的切點表達式，我們先創建一個日志註解，當spring容器掃描到有此註解的方法就會進行增強。

代碼如下（示例）：

@Target({ ElementType.PARAMETER, ElementType.METHOD }) // 註解放置的目標位置,PARAMETER: 可用在參數上  METHOD：可用在方法級別上
@Retention(RetentionPolicy.RUNTIME)    // 指明修飾的註解的生存周期  RUNTIME：運行級別保留
@Documented
public @interface Log {

    /**
     * 模塊
     */
    String title() default "";

    /**
     * 功能
     */
    public BusinessType businessType() default BusinessType.OTHER;

    /**
     * 是否保存請求的參數
     */
    public boolean isSaveRequestData() default true;

    /**
     * 是否保存響應的參數
     */
    public boolean isSaveResponseData() default true;
}

3. 切面聲明

申明一個切面類，並交給Spring容器管理。

代碼如下（示例）：

@Aspect
@Component
@Slf4j
public class LogAspect {
    @Autowired
    private IXlOperLogService operLogService;
    /**
     * 處理完請求後執行
     * @param joinPoint 切點
     */
    @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
    public void doAfterReturnibng(JoinPoint joinPoint, Log controllerLog, Object jsonResult) {
        handleLog(joinPoint, controllerLog, null, jsonResult);
    }
    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
        try {
            // 獲取當前的用戶
            JwtUser loginUser = SecurityUtils.getLoginUser();

            // 日志記錄
            XlOperLog operLog = new XlOperLog();
            operLog.setStatus(0);
            // 請求的IP地址
            String iP = ServletUtil.getClientIP(ServletUtils.getRequest());
            if ("0:0:0:0:0:0:0:1".equals(iP)) {
                iP = "127.0.0.1";
            }
            operLog.setOperIp(iP);
            operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
            if (loginUser != null) {
                operLog.setOperName(loginUser.getUsername());
            }
            if (e != null) {
                operLog.setStatus(1);
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 設置方法名稱
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
            operLog.setOperTime(new Date());
            // 處理設置註解上的參數
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 保存數據庫
            operLogService.save(operLog);

        } catch (Exception exp) {
            log.error("異常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }
    /**
     * 獲取註解中對方法的描述信息 用於Controller層註解
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, XlOperLog operLog, Object jsonResult) throws Exception {
        // 設置操作業務類型
        operLog.setBusinessType(log.businessType().ordinal());
        // 設置標題
        operLog.setTitle(log.title());
        // 是否需要保存request，參數和值
        if (log.isSaveRequestData()) {
            // 設置參數的信息
            setRequestValue(joinPoint, operLog);
        }
        // 是否需要保存response，參數和值
        if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult)) {
            operLog.setJsonResult(StringUtils.substring(JSON.toJSONString(jsonResult), 0, 2000));
        }
    }
    /**
     * 獲取請求的參數，放到log中
     * @param operLog 操作日志
     * @throws Exception 異常
     */
    private void setRequestValue(JoinPoint joinPoint, XlOperLog operLog) throws Exception {
        String requsetMethod = operLog.getRequestMethod();
        if (HttpMethod.PUT.name().equals(requsetMethod) || HttpMethod.POST.name().equals(requsetMethod)) {
            String parsams = argsArrayToString(joinPoint.getArgs());
            operLog.setOperParam(StringUtils.substring(parsams,0,2000));
        } else {
            Map<?,?> paramsMap = (Map<?,?>) ServletUtils.getRequest().getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
            operLog.setOperParam(StringUtils.substring(paramsMap.toString(),0,2000));
        }
    }
    /**
     * 參數拼裝
     */
    private String argsArrayToString(Object[] paramsArray) {
        String params = "";
        if (paramsArray != null && paramsArray.length > 0) {
            for (Object object : paramsArray) {
                // 不為空 並且是不需要過濾的 對象
                if (StringUtils.isNotNull(object) && !isFilterObject(object)) {
                    Object jsonObj = JSON.toJSON(object);
                    params += jsonObj.toString() + " ";
                }
            }
        }
        return params.trim();
    }
    /**
     * 判斷是否需要過濾的對象。
     * @param object 對象信息。
     * @return 如果是需要過濾的對象，則返回true；否則返回false。
     */
    @SuppressWarnings("rawtypes")
    public boolean isFilterObject(final Object object) {
        Class<?> clazz = object.getClass();
        if (clazz.isArray()) {
            return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
        } else if (Collection.class.isAssignableFrom(clazz)) {
            Collection collection = (Collection) object;
            for (Object value : collection) {
                return value instanceof MultipartFile;
            }
        } else if (Map.class.isAssignableFrom(clazz)) {
            Map map = (Map) object;
            for (Object value : map.entrySet()) {
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        return object instanceof MultipartFile || object instanceof HttpServletRequest
                || object instanceof HttpServletResponse || object instanceof BindingResult;
    }
}

4. 標註在接口上

將自定義註解標註在需要記錄操作日志的接口上，代碼如下（示例）：

	@Log(title = "代碼生成", businessType = BusinessType.GENCODE)
    @ApiOperation(value = "批量生成代碼")
    @GetMapping("/download/batch")
    public void batchGenCode(HttpServletResponse response, String tables) throws IOException {
        String[] tableNames = Convert.toStrArray(tables);
        byte[] data = genTableService.downloadCode(tableNames);
        genCode(response, data);
    }

5. 實現的效果

執行相關操作就會記錄日志，記錄瞭一些基礎信息存在數據表裡。

總結

到此這篇關於Java SpringBoot項目如何優雅的實現操作日志記錄的文章就介紹到這瞭,更多相關SpringBoot操作日志記錄內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：