From c4459d1b8d701a4405f74ea92cfc87752a285b55 Mon Sep 17 00:00:00 2001 From: Charles7c Date: Sun, 17 Dec 2023 19:50:23 +0800 Subject: [PATCH] =?UTF-8?q?refactor(extension/crud):=20=E6=96=B0=E5=A2=9E?= =?UTF-8?q?=E5=85=A8=E5=B1=80=E5=BC=82=E5=B8=B8=E5=A4=84=E7=90=86=E5=99=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...balExceptionHandlerAutoConfiguration.java} | 7 +- .../crud/handler/GlobalExceptionHandler.java | 187 ++++++++++++++++++ ...ot.autoconfigure.AutoConfiguration.imports | 2 +- 3 files changed, 192 insertions(+), 4 deletions(-) rename continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/{GlobalErrorHandlerAutoConfiguration.java => GlobalExceptionHandlerAutoConfiguration.java} (84%) create mode 100644 continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/handler/GlobalExceptionHandler.java diff --git a/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalErrorHandlerAutoConfiguration.java b/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalExceptionHandlerAutoConfiguration.java similarity index 84% rename from continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalErrorHandlerAutoConfiguration.java rename to continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalExceptionHandlerAutoConfiguration.java index 9bc8f9a9..a820c17b 100644 --- a/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalErrorHandlerAutoConfiguration.java +++ b/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/autoconfigure/GlobalExceptionHandlerAutoConfiguration.java @@ -23,17 +23,18 @@ import org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorContro import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Import; import top.charles7c.continew.starter.extension.crud.handler.GlobalErrorHandler; +import top.charles7c.continew.starter.extension.crud.handler.GlobalExceptionHandler; /** - * 全局错误处理器自动配置 + * 全局异常处理器自动配置 * * @author Charles7c * @since 1.0.0 */ @Slf4j @AutoConfiguration -@Import(GlobalErrorHandler.class) +@Import({GlobalExceptionHandler.class, GlobalErrorHandler.class}) @ConditionalOnMissingBean(BasicErrorController.class) @ComponentScan("top.charles7c.continew.starter.extension.crud.handler") -public class GlobalErrorHandlerAutoConfiguration { +public class GlobalExceptionHandlerAutoConfiguration { } diff --git a/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/handler/GlobalExceptionHandler.java b/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/handler/GlobalExceptionHandler.java new file mode 100644 index 00000000..671189a1 --- /dev/null +++ b/continew-starter-extension/continew-starter-extension-crud/src/main/java/top/charles7c/continew/starter/extension/crud/handler/GlobalExceptionHandler.java @@ -0,0 +1,187 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + *

+ * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * http://www.gnu.org/licenses/lgpl.html + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package top.charles7c.continew.starter.extension.crud.handler; + +import cn.dev33.satoken.exception.NotLoginException; +import cn.dev33.satoken.exception.NotPermissionException; +import cn.dev33.satoken.exception.NotRoleException; +import cn.hutool.core.collection.CollUtil; +import cn.hutool.core.util.NumberUtil; +import cn.hutool.core.util.StrUtil; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.validation.ConstraintViolation; +import jakarta.validation.ConstraintViolationException; +import lombok.extern.slf4j.Slf4j; +import org.springframework.context.support.DefaultMessageSourceResolvable; +import org.springframework.http.HttpStatus; +import org.springframework.validation.BindException; +import org.springframework.web.HttpRequestMethodNotSupportedException; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; +import org.springframework.web.multipart.MaxUploadSizeExceededException; +import top.charles7c.continew.starter.core.constant.StringConstants; +import top.charles7c.continew.starter.core.exception.BadRequestException; +import top.charles7c.continew.starter.core.exception.BusinessException; +import top.charles7c.continew.starter.core.util.ExceptionUtils; +import top.charles7c.continew.starter.extension.crud.model.resp.R; + +import java.util.Objects; + +/** + * 全局异常处理器 + * + * @author Charles7c + * @since 1.1.0 + */ +@Slf4j +@RestControllerAdvice +public class GlobalExceptionHandler { + + /** + * 拦截自定义验证异常-错误请求 + */ + @ExceptionHandler(BadRequestException.class) + public R handleBadRequestException(BadRequestException e, HttpServletRequest request) { + log.warn("请求地址 [{}]，自定义验证失败。", request.getRequestURI(), e); + return R.fail(HttpStatus.BAD_REQUEST.value(), e.getMessage()); + } + + /** + * 拦截校验异常-违反约束异常 + */ + @ExceptionHandler(ConstraintViolationException.class) + public R constraintViolationException(ConstraintViolationException e, HttpServletRequest request) { + log.warn("请求地址 [{}]，参数验证失败。", request.getRequestURI(), e); + String errorMsg = + CollUtil.join(e.getConstraintViolations(), StringConstants.CHINESE_COMMA, ConstraintViolation::getMessage); + return R.fail(HttpStatus.BAD_REQUEST.value(), errorMsg); + } + + /** + * 拦截校验异常-绑定异常 + */ + @ExceptionHandler(BindException.class) + public R handleBindException(BindException e, HttpServletRequest request) { + log.warn("请求地址 [{}]，参数验证失败。", request.getRequestURI(), e); + String errorMsg = CollUtil.join(e.getAllErrors(), StringConstants.CHINESE_COMMA, + DefaultMessageSourceResolvable::getDefaultMessage); + return R.fail(HttpStatus.BAD_REQUEST.value(), errorMsg); + } + + /** + * 拦截校验异常-方法参数无效异常 + */ + @ExceptionHandler(MethodArgumentNotValidException.class) + public R handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) { + log.warn("请求地址 [{}]，参数验证失败。", request.getRequestURI(), e); + String errorMsg = ExceptionUtils + .exToNull(() -> Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage()); + return R.fail(HttpStatus.BAD_REQUEST.value(), errorMsg); + } + + /** + * 拦截校验异常-方法参数类型不匹配异常 + */ + @ExceptionHandler(MethodArgumentTypeMismatchException.class) + public R handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e, + HttpServletRequest request) { + String errorMsg = StrUtil.format("参数名：[{}]，期望参数类型：[{}]", e.getName(), e.getParameter().getParameterType()); + log.warn("请求地址 [{}]，参数转换失败，{}。", request.getRequestURI(), errorMsg, e); + return R.fail(HttpStatus.BAD_REQUEST.value(), errorMsg); + } + + /** + * 拦截文件上传异常-超过上传大小限制 + */ + @ExceptionHandler(MaxUploadSizeExceededException.class) + public R handleMaxUploadSizeExceededException(MaxUploadSizeExceededException e, HttpServletRequest request) { + log.warn("请求地址 [{}]，上传文件失败，文件大小超过限制。", request.getRequestURI(), e); + String sizeLimit = StrUtil.subBetween(e.getMessage(), "The maximum size ", " for"); + String errorMsg = String.format("请上传小于 %sMB 的文件", NumberUtil.parseLong(sizeLimit) / 1024 / 1024); + return R.fail(HttpStatus.BAD_REQUEST.value(), errorMsg); + } + + /** + * 认证异常-登录认证 + */ + @ExceptionHandler(NotLoginException.class) + public R handleNotLoginException(NotLoginException e, HttpServletRequest request) { + log.error("请求地址 [{}]，认证失败，无法访问系统资源。", request.getRequestURI(), e); + String errorMsg = switch (e.getType()) { + case NotLoginException.KICK_OUT -> "您已被踢下线。"; + case NotLoginException.BE_REPLACED_MESSAGE -> "您已被顶下线。"; + default -> "您的登录状态已过期，请重新登录。"; + }; + return R.fail(HttpStatus.UNAUTHORIZED.value(), errorMsg); + } + + /** + * 认证异常-权限认证 + */ + @ExceptionHandler(NotPermissionException.class) + public R handleNotPermissionException(NotPermissionException e, HttpServletRequest request) { + log.error("请求地址 [{}]，权限码校验失败。", request.getRequestURI(), e); + return R.fail(HttpStatus.FORBIDDEN.value(), "没有访问权限，请联系管理员授权"); + } + + /** + * 认证异常-角色认证 + */ + @ExceptionHandler(NotRoleException.class) + public R handleNotRoleException(NotRoleException e, HttpServletRequest request) { + log.error("请求地址 [{}]，角色权限校验失败。", request.getRequestURI(), e); + return R.fail(HttpStatus.FORBIDDEN.value(), "没有访问权限，请联系管理员授权"); + } + + /** + * 拦截校验异常-请求方式不支持异常 + */ + @ExceptionHandler(HttpRequestMethodNotSupportedException.class) + public R handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException e, HttpServletRequest request) { + log.error("请求地址 [{}]，不支持 [{}] 请求。", request.getRequestURI(), e.getMethod()); + return R.fail(HttpStatus.METHOD_NOT_ALLOWED.value(), e.getMessage()); + } + + /** + * 拦截业务异常 + */ + @ExceptionHandler(BusinessException.class) + public R handleServiceException(BusinessException e, HttpServletRequest request) { + log.error("请求地址 [{}]，发生业务异常。", request.getRequestURI(), e); + return R.fail(HttpStatus.INTERNAL_SERVER_ERROR.value(), e.getMessage()); + } + + /** + * 拦截未知的运行时异常 + */ + @ExceptionHandler(RuntimeException.class) + public R handleRuntimeException(RuntimeException e, HttpServletRequest request) { + log.error("请求地址 [{}]，发生系统异常。", request.getRequestURI(), e); + return R.fail(e.getMessage()); + } + + /** + * 拦截未知的系统异常 + */ + @ExceptionHandler(Throwable.class) + public R handleException(Throwable e, HttpServletRequest request) { + log.error("请求地址 [{}]，发生未知异常。", request.getRequestURI(), e); + return R.fail(e.getMessage()); + } +} \ No newline at end of file diff --git a/continew-starter-extension/continew-starter-extension-crud/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/continew-starter-extension/continew-starter-extension-crud/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports index d0ae80fc..7f744310 100644 --- a/continew-starter-extension/continew-starter-extension-crud/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports +++ b/continew-starter-extension/continew-starter-extension-crud/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -1,2 +1,2 @@ top.charles7c.continew.starter.extension.crud.autoconfigure.CrudAutoConfiguration -top.charles7c.continew.starter.extension.crud.autoconfigure.GlobalErrorHandlerAutoConfiguration \ No newline at end of file +top.charles7c.continew.starter.extension.crud.autoconfigure.GlobalExceptionHandlerAutoConfiguration \ No newline at end of file