記錄項目日志，一個注解搞定

小伙伴們知道松哥最近在錄制 TienChin 項目視頻教程，這是一個基于 RuoYi-Vue 腳手架的項目，用過這個腳手架的小伙伴可能知道，這個腳手架有一個功能，就是如果你需要記錄下來一個接口的操作信息，那么只需要在 Controller 接口中加上一個 @Log 注解即可，非常方便，最終記錄到數(shù)據(jù)庫中的日志類似下面這樣：

我們提供的服務有：成都網(wǎng)站建設、網(wǎng)站制作、微信公眾號開發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認證、曲沃ssl等。為上千多家企事業(yè)單位解決了網(wǎng)站和推廣的問題。提供周到的售前咨詢和貼心的售后服務，是有科學管理、有技術的曲沃網(wǎng)站制作公司

可能有小伙伴要吐槽了，這不該記錄到 Elasticsearch 中嗎？上 ELK ??！怎么說呢，如果你會將日志存入數(shù)據(jù)庫，那么將來存 Elasticsearch 其實非常 Easy，結合松哥之前錄制的 Es 視頻（公號后臺回復 es），我相信這個問題你能自己搞定。

今天我們主要來分析一下這個腳手架中 @Log 注解的玩法。

1. 日志表設計

先來看看日志表的設計。

CREATE TABLE `sys_oper_log` (
  `oper_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '日志主鍵',
  `title` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '模塊標題',
  `business_type` int(2) DEFAULT '0' COMMENT '業(yè)務類型（0其它 1新增 2修改 3刪除）',
  `method` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '方法名稱',
  `request_method` varchar(10) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '請求方式',
  `operator_type` int(1) DEFAULT '0' COMMENT '操作類別（0其它 1后臺用戶 2手機端用戶）',
  `oper_name` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '操作人員',
  `dept_name` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '部門名稱',
  `oper_url` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '請求URL',
  `oper_ip` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '主機地址',
  `oper_location` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '操作地點',
  `oper_param` varchar(2000) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '請求參數(shù)',
  `json_result` varchar(2000) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '返回參數(shù)',
  `status` int(1) DEFAULT '0' COMMENT '操作狀態(tài)（0正常 1異常）',
  `error_msg` varchar(2000) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '錯誤消息',
  `oper_time` datetime DEFAULT NULL COMMENT '操作時間',
  PRIMARY KEY (`oper_id`)
) ENGINE=InnoDB AUTO_INCREMENT=280 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='操作日志記錄';

這里各個字段的含義我來解釋下：

oper_id：這是日志主鍵，自增的。
title：這個標題，一般就是用來說明這個操作是干嘛的，例如刪除一個用戶、添加一條線索等待。
business_type：這個是指業(yè)務類型，一般來說有：添加、修改、刪除、導入、導出等等。
method：執(zhí)行的接口方法名稱。
request_method：這個是指請求的方法類型，如 GET、POST、PUT、DELETE 等。
operator_type：這個是指操作類別，分為三種：后臺用戶、手機用戶以及其他。
oper_name：操作人員的名稱。
dept_name：操作人員所屬的部門。
oper_url：請求的 URL 地址。
oper_ip：請求的 IP 地址。
oper_location：請求 IP 地址所屬的區(qū)域。
oper_param：請求的參數(shù)。
json_result：響應的 JSON 參數(shù)。
status：操作的狀態(tài)，成功還是失敗。
error_msg：如果是失敗，失敗的內容是什么。
oper_time：操作的時間。

這里給出來的就這些字段，基本上滿足項目需求了，如果不夠的話，也可以自定添加即可。

2. 注解的定義

再來看看 @Log 注解的定義，該注解位于 org.javaboy.tienchin.common.annotation.Log：

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 模塊
     */
    public String title() default "";

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

    /**
     * 操作人類別
     */
    public OperatorType operatorType() default OperatorType.MANAGE;

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

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

這個注解一共有五個屬性，結合上面表的定義，五個屬性含義很好理解，不多說。

3. 注解的解析

經(jīng)典搭配：自定義注解+ AOP 切面。解析該注解的 AOP 切面是 LogAspect，位于 org.javaboy.tienchin.framework.aspectj.LogAspect：

@Aspect
@Component
public class LogAspect {
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    /**
     * 處理完請求后執(zhí)行
     *
     * @param joinPoint 切點
     */
    @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
    public void doAfterReturning(JoinPoint joinPoint, Log controllerLog, Object jsonResult) {
        handleLog(joinPoint, controllerLog, null, jsonResult);
    }

    /**
     * 攔截異常操作
     *
     * @param joinPoint 切點
     * @param e         異常
     */
    @AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e) {
        handleLog(joinPoint, controllerLog, e, null);
    }

    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
        try {
            // 獲取當前的用戶
            LoginUser loginUser = SecurityUtils.getLoginUser();

            // *========數(shù)據(jù)庫日志=========*//
            SysOperLog operLog = new SysOperLog();
            operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
            // 請求的地址
            String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
            operLog.setOperIp(ip);
            operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
            if (loginUser != null) {
                operLog.setOperName(loginUser.getUsername());
            }

            if (e != null) {
                operLog.setStatus(BusinessStatus.FAIL.ordinal());
                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());
            // 處理設置注解上的參數(shù)
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 保存數(shù)據(jù)庫
            AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
        } catch (Exception exp) {
            // 記錄本地異常日志
            log.error("==前置通知異常==");
            log.error("異常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }

    /**
     * 獲取注解中對方法的描述信息 用于Controller層注解
     *
     * @param log     日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, SysOperLog operLog, Object jsonResult) throws Exception {
        // 設置action動作
        operLog.setBusinessType(log.businessType().ordinal());
        // 設置標題
        operLog.setTitle(log.title());
        // 設置操作人類別
        operLog.setOperatorType(log.operatorType().ordinal());
        // 是否需要保存request，參數(shù)和值
        if (log.isSaveRequestData()) {
            // 獲取參數(shù)的信息，傳入到數(shù)據(jù)庫中。
            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, SysOperLog operLog) throws Exception {
        String requestMethod = operLog.getRequestMethod();
        if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod)) {
            String params = argsArrayToString(joinPoint.getArgs());
            operLog.setOperParam(StringUtils.substring(params, 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 o : paramsArray) {
                if (StringUtils.isNotNull(o) && !isFilterObject(o)) {
                    try {
                        Object jsonObj = JSON.toJSON(o);
                        params += jsonObj.toString() + " ";
                    } catch (Exception e) {
                    }
                }
            }
        }
        return params.trim();
    }

    /**
     * 判斷是否需要過濾的對象。
     *
     * @param o 對象信息。
     * @return 如果是需要過濾的對象，則返回true；否則返回false。
     */
    public boolean isFilterObject(final Object o) {
        Class clazz = o.getClass();
        if (clazz.isArray()) {
            return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
        } else if (Collection.class.isAssignableFrom(clazz)) {
            Collection collection = (Collection) o;
            for (Object value : collection) {
                return value instanceof MultipartFile;
            }
        } else if (Map.class.isAssignableFrom(clazz)) {
            Map map = (Map) o;
            for (Object value : map.entrySet()) {
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse
                || o instanceof BindingResult;
    }
}

大概跟小伙伴們捋一下這個切面的邏輯。

首先定義了兩種不同類型的通知：返回通知和異常通知，正常流程就是在返回通知中處理日志寫入操作，但是如果系統(tǒng)不幸拋出異常，就在異常通知中處理日志寫入操作（此時就多了一個異常對象）。
日志數(shù)據(jù)保存在 SysOperLog 對象中，采集各種日志數(shù)據(jù)都是常規(guī)操作，不多說。
當收集接口參數(shù)的時候，有兩個需要注意的地方：

如果請求類型是 PUT 或者 POST，就直接從接口的參數(shù)中獲取想要的數(shù)據(jù)，但是接口的參數(shù)中可能會存在一些并不需要記錄的內容，例如 HttpServletRequest、HttpServletResponse 或者文件上傳對象 MultipartFile 等，這些類型的內容是不需要記錄到日志中的，這里通過一個 isFilterObject 方法完成了數(shù)據(jù)過濾操作；

如果請求類型是 GET 或者 DELETE，則請求參數(shù)就直接從請求對象提取了。為什么設計成這樣呢？很明顯，直接從請求對象中提取參數(shù)是最為方便的，一行代碼就搞定，但是如果請求類型是 PUT 或者 POST，就意味著請求參數(shù)是在請求體中，請求參數(shù)有可能是二進制數(shù)據(jù)（例如上傳的文件），二進制數(shù)據(jù)就不好保存了，所以對于 POST 和 PUT 還是從接口參數(shù)中提取，然后過濾掉二進制數(shù)據(jù)即可。

數(shù)據(jù)收集齊了，接下來就是往數(shù)據(jù)庫中寫入了。因為我們現(xiàn)在用的 SpringMVC 這一套是線程阻塞的，也就是得等到服務端都處理完畢之后，接口才會給客戶端響應，而寫日志是一個業(yè)務無關的操作，所以可以直接放在一個子線程中去完成。在 RuoYi-Vue 腳手架中，使用了 Java JUC 中的 ScheduledExecutorService 去完成這個延時任務，AsyncManager.me().execute 方法實際上就是去執(zhí)行一個延時任務，這個延時任務就是一個往數(shù)據(jù)庫中寫入一條記錄。

4. 記錄日志

弄好之后，日志注解具體用法如下：

@Log(title = "參數(shù)管理", businessType = BusinessType.EXPORT)
@PreAuthorize("@ss.hasPermi('system:config:export')")
@PostMapping("/export")
public void export(HttpServletResponse response, SysConfig config) {
    List list = configService.selectConfigList(config);
    ExcelUtil util = new ExcelUtil(SysConfig.class);
    util.exportExcel(response, list, "參數(shù)數(shù)據(jù)");
}

好啦，這就是整體操作，實際上看起來并不難，后面要是有空的話，松哥把這個日志整成一個 ELK 的，和小伙伴們一起探討。

文章題目：記錄項目日志，一個注解搞定
當前地址：http://uogjgqi.cn/article/dpedidd.html

掃二維碼與項目經(jīng)理溝通

我們在微信上24小時期待你的聲音

解答本文疑問/技術咨詢/運營咨詢/技術建議/互聯(lián)網(wǎng)交流

av激情亚洲男人的天堂国语,日韩欧美精品一中文字幕,无码av一区二区三区无码,国产又色又爽又刺激的a片,国产又色又爽又刺激的a片

記錄項目日志，一個注解搞定

1. 日志表設計

2. 注解的定義

3. 注解的解析

4. 記錄日志

掃二維碼與項目經(jīng)理溝通

其他資訊

行業(yè)動態(tài)

企業(yè)網(wǎng)站建設的重要性！

服務項目

網(wǎng)站建設

移動端/APP

微信/小程序

技術支持

其它服務

更多服務項目

聯(lián)系吧在百度地圖上找到我們

電話：13518219792

av激情亚洲男人的天堂国语,日韩欧美精品一中文字幕,无码av一区二区三区无码,国产又色又爽又刺激的a片,国产又色又爽又刺激的a片

記錄項目日志，一個注解搞定

1. 日志表設計

2. 注解的定義

3. 注解的解析

4. 記錄日志

掃二維碼與項目經(jīng)理溝通

其他資訊

行業(yè)動態(tài)

企業(yè)網(wǎng)站建設的重要性！

服務項目

網(wǎng)站建設

移動端/APP

微信/小程序

技術支持

其它服務

更多服務項目

聯(lián)系吧 在百度地圖上找到我們

電話：13518219792

記錄項目日志，一個注解搞定

企業(yè)網(wǎng)站建設的重要性！

聯(lián)系吧在百度地圖上找到我們