Java?SpringBoot項(xiàng)目怎么優(yōu)雅的實(shí)現(xiàn)操作日志記錄

本篇內(nèi)容介紹了“Java SpringBoot項(xiàng)目怎么優(yōu)雅的實(shí)現(xiàn)操作日志記錄”的有關(guān)知識(shí)，在實(shí)際案例的操作過(guò)程中，不少人都會(huì)遇到這樣的困境，接下來(lái)就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

一、AOP是什么？

AOP(Aspect-Oriented Programming:?向切?編程)，說(shuō)起AOP，幾乎學(xué)過(guò)Spring框架的人都知道，它是Spring的三大核心思想之一（IOC：控制反轉(zhuǎn)，DI：依賴注入，AOP：面向切面編程）。能夠?qū)⒛切┡c業(yè)務(wù)?關(guān)，卻為業(yè)務(wù)模塊所共同調(diào)?的邏輯或責(zé)任（例如事務(wù)處理、?志管理、權(quán)限控制等）封裝起來(lái)，便于減少系統(tǒng)的重復(fù)代碼，降低模塊間的耦合度，并有利于未來(lái)的可拓展性和可維護(hù)性。

二、AOP做了什么？

簡(jiǎn)單說(shuō)來(lái)，AOP主要做三件事：

• 1、在哪里切入，也就是日志記錄等非業(yè)務(wù)代碼在哪些業(yè)務(wù)代碼中執(zhí)行。

• 2、在什么時(shí)候切入，是在業(yè)務(wù)代碼執(zhí)行前還是后。

• 3、切入后做什么事情，比如權(quán)限校驗(yàn)，日志記錄等。

可以用一張圖來(lái)理解：

圖上的一個(gè)核心術(shù)語(yǔ)的說(shuō)明：

• Pointcut：切點(diǎn)，決定在何處切入業(yè)務(wù)代碼中（即織入切面）。切點(diǎn)分為execution方式和annotation方式。execution方式：可以用路徑表達(dá)式指定哪些類織入切面，annotation方式：可以指定被哪些注解修飾的代碼織入切面。

• Advice：處理，包括處理時(shí)機(jī)和處理內(nèi)容。處理內(nèi)容就是要做什么事，比如校驗(yàn)權(quán)限和記錄日志。處理時(shí)機(jī)就是在什么時(shí)機(jī)執(zhí)行處理內(nèi)容，分為前置處理（即業(yè)務(wù)代碼執(zhí)行前）、后置處理（業(yè)務(wù)代碼執(zhí)行后）等。

• Aspect：切面，即Pointcut和Advice。

• Joint point：連接點(diǎn)，是程序執(zhí)行的一個(gè)點(diǎn)。例如，一個(gè)方法的執(zhí)行或者一個(gè)異常的處理。在 Spring AOP 中，一個(gè)連接點(diǎn)總是代表一個(gè)方法執(zhí)行。

• Weaving：織入，就是通過(guò)動(dòng)態(tài)代理，在目標(biāo)對(duì)象方法中執(zhí)行處理內(nèi)容的過(guò)程。

三、實(shí)現(xiàn)步驟

（1）自定義一個(gè)注解@Log （2）創(chuàng)建一個(gè)切面類，切點(diǎn)設(shè)置為攔截標(biāo)注@Log的方法，截取傳參，進(jìn)行日志記錄 （3）將@Log標(biāo)注在接口上

具體的實(shí)現(xiàn)步驟如下：

1. 添加AOP依賴

代碼如下（示例）：

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

2. 自定義一個(gè)日志注解

日志一般使用的是注解類型的切點(diǎn)表達(dá)式，我們先創(chuàng)建一個(gè)日志注解，當(dāng)spring容器掃描到有此注解的方法就會(huì)進(jìn)行增強(qiáng)。

代碼如下（示例）：

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

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

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

    /**
     * 是否保存請(qǐng)求的參數(shù)
     */
    public boolean isSaveRequestData() default true;

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

3. 切面聲明

申明一個(gè)切面類，并交給Spring容器管理。

代碼如下（示例）：

@Aspect
@Component
@Slf4j
public class LogAspect {
    @Autowired
    private IXlOperLogService operLogService;
    /**
     * 處理完請(qǐng)求后執(zhí)行
     * @param joinPoint 切點(diǎn)
     */
    @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 {
            // 獲取當(dāng)前的用戶
            JwtUser loginUser = SecurityUtils.getLoginUser();

            // 日志記錄
            XlOperLog operLog = new XlOperLog();
            operLog.setStatus(0);
            // 請(qǐng)求的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));
            }
            // 設(shè)置方法名稱
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
            operLog.setOperTime(new Date());
            // 處理設(shè)置注解上的參數(shù)
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 保存數(shù)據(jù)庫(kù)
            operLogService.save(operLog);

        } catch (Exception exp) {
            log.error("異常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }
    /**
     * 獲取注解中對(duì)方法的描述信息 用于Controller層注解
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, XlOperLog operLog, Object jsonResult) throws Exception {
        // 設(shè)置操作業(yè)務(wù)類型
        operLog.setBusinessType(log.businessType().ordinal());
        // 設(shè)置標(biāo)題
        operLog.setTitle(log.title());
        // 是否需要保存request，參數(shù)和值
        if (log.isSaveRequestData()) {
            // 設(shè)置參數(shù)的信息
            setRequestValue(joinPoint, operLog);
        }
        // 是否需要保存response，參數(shù)和值
        if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult)) {
            operLog.setJsonResult(StringUtils.substring(JSON.toJSONString(jsonResult), 0, 2000));
        }
    }
    /**
     * 獲取請(qǐng)求的參數(shù)，放到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));
        }
    }
    /**
     * 參數(shù)拼裝
     */
    private String argsArrayToString(Object[] paramsArray) {
        String params = "";
        if (paramsArray != null && paramsArray.length > 0) {
            for (Object object : paramsArray) {
                // 不為空 并且是不需要過(guò)濾的 對(duì)象
                if (StringUtils.isNotNull(object) && !isFilterObject(object)) {
                    Object jsonObj = JSON.toJSON(object);
                    params += jsonObj.toString() + " ";
                }
            }
        }
        return params.trim();
    }
    /**
     * 判斷是否需要過(guò)濾的對(duì)象。
     * @param object 對(duì)象信息。
     * @return 如果是需要過(guò)濾的對(duì)象，則返回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. 標(biāo)注在接口上

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

	@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. 實(shí)現(xiàn)的效果

執(zhí)行相關(guān)操作就會(huì)記錄日志，記錄了一些基礎(chǔ)信息存在數(shù)據(jù)表里。

“Java SpringBoot項(xiàng)目怎么優(yōu)雅的實(shí)現(xiàn)操作日志記錄”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！