- 后端：增加异常日志的记录

2019-05-11 02:46:34 +08:00
parent 25ecc25139
commit 6697f4f723
13 changed files with 331 additions and 89 deletions
--- a/common/mall-spring-boot/src/main/java/cn/iocoder/mall/spring/boot/web/handler/GlobalExceptionHandler.java
+++ b/common/mall-spring-boot/src/main/java/cn/iocoder/mall/spring/boot/web/handler/GlobalExceptionHandler.java
@@ -2,10 +2,21 @@ package cn.iocoder.mall.spring.boot.web.handler;

 import cn.iocoder.common.framework.constant.SysErrorCodeEnum;
 import cn.iocoder.common.framework.exception.ServiceException;
+import cn.iocoder.common.framework.util.ExceptionUtil;
+import cn.iocoder.common.framework.util.HttpUtil;
+import cn.iocoder.common.framework.util.MallUtil;
 import cn.iocoder.common.framework.vo.CommonResult;
+import cn.iocoder.mall.admin.api.SystemLogService;
+import cn.iocoder.mall.admin.api.dto.AccessLogAddDTO;
+import cn.iocoder.mall.admin.api.dto.ExceptionLogAddDTO;
+import com.alibaba.fastjson.JSON;
+import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.apache.dubbo.config.annotation.Reference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.scheduling.annotation.Async;
+import org.springframework.util.Assert;
 import org.springframework.web.bind.MissingServletRequestParameterException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
@@ -13,12 +24,19 @@ import org.springframework.web.bind.annotation.ResponseBody;

 import javax.servlet.http.HttpServletRequest;
 import javax.validation.ConstraintViolationException;
+import java.util.Date;

@ControllerAdvice
 public class GlobalExceptionHandler {

    private Logger logger = LoggerFactory.getLogger(getClass());

+    @Value("${spring.application.name}")
+    private String applicationName;
+
+    @Reference(validation = "true", version = "${dubbo.consumer.AdminAccessLogService.version:1.0.0}")
+    private SystemLogService adminAccessLogService;
+
    // 逻辑异常
    @ResponseBody
    @ExceptionHandler(value = ServiceException.class)
@@ -47,24 +65,58 @@ public class GlobalExceptionHandler {
            + detailMessage.toString());
    }

+    // TODO 芋艿，应该还有其它的异常，需要进行翻译
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
-    public CommonResult resultExceptionHandler(HttpServletRequest req, Exception e) {
-        logger.error("[resultExceptionHandler]", e);
-        // 返回
+    public CommonResult exceptionHandler(HttpServletRequest req, Exception e) {
+        logger.error("[exceptionHandler]", e);
+        // 插入异常日志
+        ExceptionLogAddDTO exceptionLog = new ExceptionLogAddDTO();
        try {
-            addExceptionLog();
+            // 初始化 exceptionLog
+            initExceptionLog(exceptionLog, req, e);
+            // 执行插入 exceptionLog
+            addExceptionLog(exceptionLog);
        } catch (Throwable th) {
-            // TODO
+            logger.error("[exceptionHandler][插入访问日志({}) 发生异常({})", JSON.toJSONString(exceptionLog), ExceptionUtils.getRootCauseMessage(th));
        }
+        // 返回 ERROR CommonResult
        return CommonResult.error(SysErrorCodeEnum.SYS_ERROR.getCode(), SysErrorCodeEnum.SYS_ERROR.getMessage());
    }

-    // TODO 芋艿，应该还有其它的异常，需要进行翻译
+    private void initExceptionLog(ExceptionLogAddDTO exceptionLog, HttpServletRequest request,  Exception e) {
+        // 设置用户编号
+        exceptionLog.setUserId(MallUtil.getUserId(request));
+        if (exceptionLog.getUserId() == null) {
+            exceptionLog.setUserId(AccessLogAddDTO.USER_ID_NULL);
+        }
+        exceptionLog.setUserType(MallUtil.getUserType(request));
+        // 设置异常字段
+        exceptionLog.setExceptionName(e.getClass().getName());
+        exceptionLog.setExceptionMessage(ExceptionUtil.getMessage(e));
+        exceptionLog.setExceptionRootCauseMessage(ExceptionUtil.getRootCauseMessage(e));
+        exceptionLog.setExceptionStackTrace(ExceptionUtil.getStackTrace(e));
+        StackTraceElement[] stackTraceElements = e.getStackTrace();
+        Assert.notEmpty(stackTraceElements, "异常 stackTraceElements 不能为空");
+        StackTraceElement stackTraceElement = stackTraceElements[0];
+        exceptionLog.setExceptionClassName(stackTraceElement.getClassName());
+        exceptionLog.setExceptionFileName(stackTraceElement.getFileName());
+        exceptionLog.setExceptionMethodName(stackTraceElement.getMethodName());
+        exceptionLog.setExceptionLineNumber(stackTraceElement.getLineNumber());
+        // 设置其它字段
+        exceptionLog.setTraceId(MallUtil.getTraceId())
+                .setApplicationName(applicationName)
+                .setUri(request.getRequestURI()) // TODO 提升：如果想要优化，可以使用 Swagger 的 @ApiOperation 注解。
+                .setQueryString(HttpUtil.buildQueryString(request))
+                .setMethod(request.getMethod())
+                .setUserAgent(HttpUtil.getUserAgent(request))
+                .setIp(HttpUtil.getIp(request))
+                .setExceptionTime(new Date());
+    }

    @Async
-    public void addExceptionLog() {
-
+    public void addExceptionLog(ExceptionLogAddDTO exceptionLog) {
+        adminAccessLogService.addExceptionLog(exceptionLog);
    }

 }
--- a/common/mall-spring-boot/src/main/java/cn/iocoder/mall/spring/boot/web/interceptor/AccessLogInterceptor.java
+++ b/common/mall-spring-boot/src/main/java/cn/iocoder/mall/spring/boot/web/interceptor/AccessLogInterceptor.java
@@ -50,28 +50,9 @@ public class AccessLogInterceptor extends HandlerInterceptorAdapter {
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        AccessLogAddDTO accessLog = new AccessLogAddDTO();
        try {
-            // 设置用户编号
-            accessLog.setUserId(MallUtil.getUserId(request));
-            if (accessLog.getUserId() == null) {
-                accessLog.setUserId(AccessLogAddDTO.USER_ID_NULL);
-            }
-            accessLog.setUserType(MallUtil.getUserType(request));
-            // 设置访问结果
-            CommonResult result = MallUtil.getCommonResult(request);
-            Assert.isTrue(result != null, "result 必须非空");
-            accessLog.setErrorCode(result.getCode())
-                    .setErrorMessage(result.getMessage());
-            // 设置其它字段
-            accessLog.setTraceId(MallUtil.getTraceId())
-                    .setApplicationName(applicationName)
-                    .setUri(request.getRequestURI()) // TODO 提升：如果想要优化，可以使用 Swagger 的 @ApiOperation 注解。
-                    .setQueryString(HttpUtil.buildQueryString(request))
-                    .setMethod(request.getMethod())
-                    .setUserAgent(HttpUtil.getUserAgent(request))
-                    .setIp(HttpUtil.getIp(request))
-                    .setStartTime(START_TIME.get())
-                    .setResponseTime((int) (System.currentTimeMillis() - accessLog.getStartTime().getTime())); // 默认响应时间设为 0
-            // 执行插入
+            // 初始化 accessLog
+            initAccessLog(accessLog, request);
+            // 执行插入 accessLog
            addAccessLog(accessLog);
            // TODO 提升：暂时不考虑 ELK 的方案。而是基于 MySQL 存储。如果访问日志比较多，需要定期归档。
        } catch (Throwable th) {
@@ -81,6 +62,30 @@ public class AccessLogInterceptor extends HandlerInterceptorAdapter {
        }
    }

+    private void initAccessLog(AccessLogAddDTO accessLog, HttpServletRequest request) {
+        // 设置用户编号
+        accessLog.setUserId(MallUtil.getUserId(request));
+        if (accessLog.getUserId() == null) {
+            accessLog.setUserId(AccessLogAddDTO.USER_ID_NULL);
+        }
+        accessLog.setUserType(MallUtil.getUserType(request));
+        // 设置访问结果
+        CommonResult result = MallUtil.getCommonResult(request);
+        Assert.isTrue(result != null, "result 必须非空");
+        accessLog.setErrorCode(result.getCode())
+                .setErrorMessage(result.getMessage());
+        // 设置其它字段
+        accessLog.setTraceId(MallUtil.getTraceId())
+                .setApplicationName(applicationName)
+                .setUri(request.getRequestURI()) // TODO 提升：如果想要优化，可以使用 Swagger 的 @ApiOperation 注解。
+                .setQueryString(HttpUtil.buildQueryString(request))
+                .setMethod(request.getMethod())
+                .setUserAgent(HttpUtil.getUserAgent(request))
+                .setIp(HttpUtil.getIp(request))
+                .setStartTime(START_TIME.get())
+                .setResponseTime((int) (System.currentTimeMillis() - accessLog.getStartTime().getTime())); // 默认响应时间设为 0
+    }
+
    @Async // 异步入库
    public void addAccessLog(AccessLogAddDTO accessLog) {
        try {