处理 SpringMVC 全局处理

2020-07-16 19:39:49 +08:00
parent 02dda60e60
commit 3b5199b60b
25 changed files with 360 additions and 91 deletions
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/admin/AdminController.http
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/admin/AdminController.http
@@ -22,7 +22,20 @@ POST {{baseUrl}}/admin/update-status
 Content-Type: application/x-www-form-urlencoded
 Authorization: Bearer {{accessToken}}

-id=31&status=1
+adminId=31&status=1
+
+### /admin/update-status 失败，参数缺失
+POST {{baseUrl}}/admin/update-status
+Content-Type: application/x-www-form-urlencoded
+Authorization: Bearer {{accessToken}}
+
+adminId=31
+
+### admin/update-status 失败，地址不存在
+GET {{baseUrl}}/admin/update-status---
+Content-Type: application/x-www-form-urlencoded
+Authorization: Bearer {{accessToken}}
+
+adminId=31&status=sss

 ###
-
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/admin/AdminController.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/admin/AdminController.java
@@ -14,18 +14,21 @@ import cn.iocoder.security.annotations.RequiresPermissions;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;

 import javax.servlet.http.HttpServletRequest;
+import javax.validation.Valid;

 import static cn.iocoder.common.framework.vo.CommonResult.success;

@Api("管理员 API")
@RestController
@RequestMapping("/admin")
+@Validated
 public class AdminController {

    @Autowired
@@ -56,7 +59,7 @@ public class AdminController {
    @PostMapping("/update-status")
    @ApiOperation(value = "更新管理员状态")
    @RequiresPermissions("system:admin:update-status")
-    public CommonResult<Boolean> updateAdminStatus(AdminUpdateStatusDTO updateStatusDTO) {
+    public CommonResult<Boolean> updateAdminStatus(@Valid AdminUpdateStatusDTO updateStatusDTO) {
        adminManager.updateAdminStatus(updateStatusDTO);
        return success(true);
    }
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/SystemAccessLogController.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/SystemAccessLogController.java
@@ -5,6 +5,7 @@ import cn.iocoder.common.framework.vo.PageResult;
 import cn.iocoder.mall.managementweb.controller.systemlog.dto.SystemAccessLogPageDTO;
 import cn.iocoder.mall.managementweb.controller.systemlog.vo.SystemAccessLogVO;
 import cn.iocoder.mall.managementweb.manager.systemlog.SystemAccessLogManager;
+import cn.iocoder.security.annotations.RequiresPermissions;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -29,6 +30,7 @@ public class SystemAccessLogController {

    @GetMapping("/page")
    @ApiOperation("获得系统访问日志分页")
+    @RequiresPermissions("system:system-access-log:page")
    public CommonResult<PageResult<SystemAccessLogVO>> pageSystemAccessLog(SystemAccessLogPageDTO pageDTO) {
        return success(systemAccessLogManager.pageSystemAccessLog(pageDTO));
    }
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/SystemExceptionLogController.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/SystemExceptionLogController.java
@@ -3,18 +3,18 @@ package cn.iocoder.mall.managementweb.controller.systemlog;
 import cn.iocoder.common.framework.vo.CommonResult;
 import cn.iocoder.common.framework.vo.PageResult;
 import cn.iocoder.mall.managementweb.controller.systemlog.dto.SystemExceptionLogPageDTO;
+import cn.iocoder.mall.managementweb.controller.systemlog.dto.SystemExceptionLogProcessDTO;
 import cn.iocoder.mall.managementweb.controller.systemlog.vo.SystemExceptionLogDetailVO;
 import cn.iocoder.mall.managementweb.controller.systemlog.vo.SystemExceptionLogVO;
 import cn.iocoder.mall.managementweb.manager.systemlog.SystemExceptionLogManager;
+import cn.iocoder.mall.security.admin.core.context.AdminSecurityContextHolder;
+import cn.iocoder.security.annotations.RequiresPermissions;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;

 import static cn.iocoder.common.framework.vo.CommonResult.success;

@@ -33,14 +33,24 @@ public class SystemExceptionLogController {
    @GetMapping("/get")
    @ApiOperation("获得系统异常日志明细")
    @ApiImplicitParam(name = "logId", value = "系统异常日志编号", required = true)
+    @RequiresPermissions("system:system-exception-log:page")
    public CommonResult<SystemExceptionLogDetailVO> getSystemExceptionLogDetail(@RequestParam("logId") Integer logId) {
        return success(systemExceptionLogManager.getSystemExceptionLogDetail(logId));
    }

    @GetMapping("/page")
    @ApiOperation("获得系统异常日志分页")
+    @RequiresPermissions("system:system-exception-log:page")
    public CommonResult<PageResult<SystemExceptionLogVO>> pageSystemExceptionLog(SystemExceptionLogPageDTO pageDTO) {
        return success(systemExceptionLogManager.pageSystemExceptionLog(pageDTO));
    }

+    @PostMapping("/process")
+    @ApiOperation("处理系统异常日志")
+    @RequiresPermissions("system:system-exception-log:process")
+    public CommonResult<Boolean> processSystemExceptionLog(SystemExceptionLogProcessDTO processDTO) {
+        systemExceptionLogManager.processSystemExceptionLog(AdminSecurityContextHolder.getAdminId(), processDTO);
+        return CommonResult.success(true);
+    }
+
 }
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/dto/SystemExceptionLogProcessDTO.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/dto/SystemExceptionLogProcessDTO.java
@@ -0,0 +1,19 @@
+package cn.iocoder.mall.managementweb.controller.systemlog.dto;
+
+import cn.iocoder.common.framework.vo.PageParam;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@ApiModel("系统异常日志处理 DTO")
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class SystemExceptionLogProcessDTO extends PageParam {
+
+    @ApiModelProperty(value = "系统异常日志编号", required = true, example = "1")
+    private Integer logId;
+    @ApiModelProperty(value = "处理状态", required = true, notes = "对应 SystemExceptionLogProcessStatusEnum 枚举类", example = "1")
+    private Integer processStatus;
+
+}
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemAccessLogVO.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemAccessLogVO.java
@@ -8,7 +8,7 @@ import java.util.*;
@Data
 public class SystemAccessLogVO {

-    @ApiModelProperty(value = "编号", required = true)
+    @ApiModelProperty(value = "编号", required = true, example = "1")
    private Integer id;
    @ApiModelProperty(value = "用户编号", example = "1024")
    private Integer userId;
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemExceptionLogDetailVO.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemExceptionLogDetailVO.java
@@ -1,4 +1,76 @@
 package cn.iocoder.mall.managementweb.controller.systemlog.vo;

+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import lombok.experimental.Accessors;
+
+import java.util.Date;
+
+@ApiModel("系统异常日志明细 DTO")
+@Data
 public class SystemExceptionLogDetailVO {
+
+    @ApiModel("管理员")
+    @Data
+    @Accessors(chain = true)
+    public static class Admin {
+
+        @ApiModelProperty(value = "管理员编号", required = true, example = "1")
+        private Integer id;
+        @ApiModelProperty(value = "真实名字", required = true, example = "小王")
+        private String name;
+
+    }
+
+    @ApiModelProperty(value = "编号", required = true, example = "1")
+    private Integer id;
+    @ApiModelProperty(value = "用户编号", example = "1024")
+    private Integer userId;
+    @ApiModelProperty(value = "用户类型", example = "1")
+    private Integer userType;
+    @ApiModelProperty(value = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab")
+    private String traceId;
+    @ApiModelProperty(value = "应用名", required = true, example = "user-shop-application")
+    private String applicationName;
+    @ApiModelProperty(value = "访问地址", required = true, example = "/management-api/system-access-log/page")
+    private String uri;
+    @ApiModelProperty(value = "参数", required = true, example = "pageNo=1&pageSize=10")
+    private String queryString;
+    @ApiModelProperty(value = "http 方法", required = true, example = "GET")
+    private String method;
+    @ApiModelProperty(value = "userAgent", required = true, example = "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0")
+    private String userAgent;
+    @ApiModelProperty(value = "ip", required = true, example = "127.0.0.1")
+    private String ip;
+    @ApiModelProperty(value = "异常发生时间", required = true)
+    private Date exceptionTime;
+    @ApiModelProperty(value = "异常名, {@link Throwable#getClass()} 的类全名", required = true)
+    private String exceptionName;
+    @ApiModelProperty(value = "异常导致的消息, {@link cn.iocoder.common.framework.util.ExceptionUtil#getMessage(Throwable)}", required = true)
+    private String exceptionMessage;
+    @ApiModelProperty(value = "异常导致的根消息, {@link cn.iocoder.common.framework.util.ExceptionUtil#getRootCauseMessage(Throwable)}", required = true)
+    private String exceptionRootCauseMessage;
+    @ApiModelProperty(value = "异常的栈轨迹, {@link cn.iocoder.common.framework.util.ExceptionUtil#getServiceException(Exception)}", required = true)
+    private String exceptionStackTrace;
+    @ApiModelProperty(value = "异常发生的类全名, {@link StackTraceElement#getClassName()}", required = true)
+    private String exceptionClassName;
+    @ApiModelProperty(value = "异常发生的类文件, {@link StackTraceElement#getFileName()}", required = true)
+    private String exceptionFileName;
+    @ApiModelProperty(value = "异常发生的方法名, {@link StackTraceElement#getMethodName()}", required = true)
+    private String exceptionMethodName;
+    @ApiModelProperty(value = "异常发生的方法所在行, {@link StackTraceElement#getLineNumber()}", required = true)
+    private Integer exceptionLineNumber;
+    @ApiModelProperty(value = "处理状态", required = true, notes = "对应 SystemExceptionLogProcessStatusEnum 枚举类", example = "1")
+    private Integer processStatus;
+    @ApiModelProperty(value = "处理时间")
+    private Date processTime;
+    @ApiModelProperty(value = "创建时间", required = true)
+    private Date createTime;
+
+    /**
+     * 处理的管理员信息
+     */
+    private Admin processAdmin;
+
 }
--- a/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemExceptionLogVO.java
+++ b/management-web-app/src/main/java/cn/iocoder/mall/managementweb/controller/systemlog/vo/SystemExceptionLogVO.java
@@ -8,13 +8,13 @@ import java.util.*;
@Data
 public class SystemExceptionLogVO {

-    @ApiModelProperty(value = "编号", required = true)
+    @ApiModelProperty(value = "编号", required = true, example = "1")
    private Integer id;
-    @ApiModelProperty(value = "用户编号")
+    @ApiModelProperty(value = "用户编号", example = "1024")
    private Integer userId;
-    @ApiModelProperty(value = "用户类型")
+    @ApiModelProperty(value = "用户类型", example = "1")
    private Integer userType;
-    @ApiModelProperty(value = "链路追踪编", required = true)
+    @ApiModelProperty(value = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab")
    private String traceId;
    @ApiModelProperty(value = "应用名", required = true, example = "user-shop-application")
    private String applicationName;