最近正在錄制 TienChin 項目視頻 采用 Spring Boot+Vue3 技術棧，里邊會涉及到各種好玩的技術，小伙伴們來和我一起做一個完成率超 90% 的項目。
前段時間做了一個支線任務，現(xiàn)在還是回到我們的主線上面來，繼續(xù)完成 TienChin 項目。
小伙伴們知道我最近在錄制 TienChin 項目視頻教程，這是一個基于 RuoYi-Vue 腳手架的項目，用過這個腳手架的小伙伴可能知道，這個腳手架有一個功能，就是如果你需要記錄下來一個接口的操作信息，那么只需要在 Controller 接口中加上一個 @Log 注解即可，非常方便，最終記錄到數(shù)據(jù)庫中的日志類似下面這樣：
可能有小伙伴要吐槽了，這不該記錄到 Elasticsearch 中嗎？上 ELK ??！怎么說呢，如果你會將日志存入數(shù)據(jù)庫，那么將來存 Elasticsearch 其實非常 Easy，結合我之前錄制的 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)@Documentedpublic @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. 注解的解析
經典搭配：自定義注解+ AOP 切面。解析該注解的 AOP 切面是 LogAspect，位于 org.javaboy.tienchin.framework.aspectj.LogAspect ：
@Aspect@Componentpublic 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; }}
大概跟小伙伴們捋一下這個切面的邏輯。
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 的，和小伙伴們一起探討。
我最近正在錄制 TienChin 項目視頻 采用 Spring Boot+Vue3 技術棧，里邊會涉及到各種好玩的技術，小伙伴們來和我一起做一個完成率超 90% 的項目。
