欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Java?SpringBoot項目如何優(yōu)雅的實現(xiàn)操作日志記錄

 更新時間:2022年08月02日 14:42:20   作者:Java升級之路???????  
這篇文章主要介紹了Java?SpringBoot項目如何優(yōu)雅的實現(xiàn)操作日志記錄,文章圍繞主題展開詳細的內(nèi)容介紹,具有一定的參考價值,需要的朋友可以參考一下

前言

在實際開發(fā)當(dāng)中,對于某些關(guān)鍵業(yè)務(wù),我們通常需要記錄該操作的內(nèi)容,一個操作調(diào)一次記錄方法,每次還得去收集參數(shù)等等,會造成大量代碼重復(fù)。 我們希望代碼中只有業(yè)務(wù)相關(guān)的操作,在項目中使用注解來完成此項功能。

通常就是使用Spring中的AOP特性來實現(xiàn)的,那么在SpringBoot項目當(dāng)中應(yīng)該如何來實現(xiàn)呢?

一、AOP是什么?

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

二、AOP做了什么?

簡單說來,AOP主要做三件事:

  • 1、在哪里切入,也就是日志記錄等非業(yè)務(wù)代碼在哪些業(yè)務(wù)代碼中執(zhí)行。
  • 2、在什么時候切入,是在業(yè)務(wù)代碼執(zhí)行前還是后。
  • 3、切入后做什么事情,比如權(quán)限校驗,日志記錄等。

可以用一張圖來理解:

圖上的一個核心術(shù)語的說明:

  • Pointcut切點,決定在何處切入業(yè)務(wù)代碼中(即織入切面)。切點分為execution方式和annotation方式。execution方式:可以用路徑表達式指定哪些類織入切面,annotation方式:可以指定被哪些注解修飾的代碼織入切面。
  • Advice處理,包括處理時機和處理內(nèi)容。處理內(nèi)容就是要做什么事,比如校驗權(quán)限和記錄日志。處理時機就是在什么時機執(zhí)行處理內(nèi)容,分為前置處理(即業(yè)務(wù)代碼執(zhí)行前)、后置處理(業(yè)務(wù)代碼執(zhí)行后)等。
  • Aspect切面,即Pointcut和Advice。
  • Joint point連接點,是程序執(zhí)行的一個點。例如,一個方法的執(zhí)行或者一個異常的處理。在 Spring AOP 中,一個連接點總是代表一個方法執(zhí)行。
  • Weaving織入,就是通過動態(tài)代理,在目標對象方法中執(zhí)行處理內(nèi)容的過程。

三、實現(xiàn)步驟

(1)自定義一個注解@Log (2)創(chuàng)建一個切面類,切點設(shè)置為攔截標注@Log的方法,截取傳參,進行日志記錄 (3)將@Log標注在接口上

具體的實現(xiàn)步驟如下:

1. 添加AOP依賴

代碼如下(示例):

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

2. 自定義一個日志注解

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

代碼如下(示例):

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

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

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

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

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

3. 切面聲明

申明一個切面類,并交給Spring容器管理。

代碼如下(示例):

@Aspect
@Component
@Slf4j
public class LogAspect {
    @Autowired
    private IXlOperLogService operLogService;
    /**
     * 處理完請求后執(zhí)行
     * @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 {
            // 獲取當(dāng)前的用戶
            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));
            }
            // 設(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ù)庫
            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 {
        // 設(shè)置操作業(yè)務(wù)類型
        operLog.setBusinessType(log.businessType().ordinal());
        // 設(shè)置標題
        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));
        }
    }
    /**
     * 獲取請求的參數(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) {
                // 不為空 并且是不需要過濾的 對象
                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. 實現(xiàn)的效果

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

總結(jié)

到此這篇關(guān)于Java SpringBoot項目如何優(yōu)雅的實現(xiàn)操作日志記錄的文章就介紹到這了,更多相關(guān)SpringBoot操作日志記錄內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • 使用java的注解(用在java類的方法上的注解)方法

    使用java的注解(用在java類的方法上的注解)方法

    這篇文章主要介紹了使用java的注解(用在java類的方法上的注解)方法,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-03-03
  • SpringBoot?整合ChatGPT?API項目實戰(zhàn)教程

    SpringBoot?整合ChatGPT?API項目實戰(zhàn)教程

    這篇文章主要介紹了SpringBoot整合ChatGPT API項目實戰(zhàn)教程,本文通過示例代碼給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2023-05-05
  • 詳談Java中net.sf.json包關(guān)于JSON與對象互轉(zhuǎn)的坑

    詳談Java中net.sf.json包關(guān)于JSON與對象互轉(zhuǎn)的坑

    下面小編就為大家分享一篇Java中net.sf.json包關(guān)于JSON與對象互轉(zhuǎn)的坑,具有很好的參考價值,希望對大家有所幫助
    2017-12-12
  • Spring中@Autowired、@Qualifier、@Resource注解的區(qū)別

    Spring中@Autowired、@Qualifier、@Resource注解的區(qū)別

    這篇文章主要介紹了Spring中@Autowired、@Qualifier、@Resource注解的區(qū)別,@Autowired 可以單獨使用,如果單獨使用,它將按類型裝配,因此,如果在容器中聲明了多個相同類型的bean,則會出現(xiàn)問題,因為 @Autowired 不知道要使用哪個bean來注入,需要的朋友可以參考下
    2023-11-11
  • 謹慎使用Java8的默認方法

    謹慎使用Java8的默認方法

    為什么要謹慎使用Java8的默認方法?本文給出了為什么要慎用Java8默認方法的原因,解釋的很詳細,感興趣的朋友可以參考一下
    2016-01-01
  • springboot的EnvironmentPostProcessor接口方法源碼解析

    springboot的EnvironmentPostProcessor接口方法源碼解析

    這篇文章主要介紹了springboot的EnvironmentPostProcessor接口方法源碼解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2023-08-08
  • 淺談spring和spring MVC的區(qū)別與關(guān)系

    淺談spring和spring MVC的區(qū)別與關(guān)系

    下面小編就為大家?guī)硪黄獪\談spring和spring MVC的區(qū)別與關(guān)系。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2017-04-04
  • Java三大特性之繼承詳解

    Java三大特性之繼承詳解

    繼承:就是子類繼承父類的屬性和行為,使得子類對象具有與父類相同的屬性、相同的行為。本文將來和大家詳細說說Java中的繼承,需要的可以了解一下
    2022-10-10
  • 解決2022.3.1版本中?IDEA中?XML文件提示屎黃色背景的方法

    解決2022.3.1版本中?IDEA中?XML文件提示屎黃色背景的方法

    這篇文章主要介紹了解決2022.3.1版本中?IDEA中?XML文件屎黃色背景?的方法,本文通過圖文并茂的形式給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2023-01-01
  • IDEA創(chuàng)建Java項目文件并運行教程解析

    IDEA創(chuàng)建Java項目文件并運行教程解析

    這篇文章主要介紹了IDEA創(chuàng)建Java項目文件并運行教程解析,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
    2020-11-11

最新評論