SpringBoot处理实际开发中常见的七种全局异常详解（全面详细+Gitee源码）

news/2025/1/13 8:48:46/

前言：在日常的开发工作中，项目在运行过程中多多少少是避免不了报错的，对于报错信息肯定不可以把全部信息都抛给客户端去显示，这里就需要我们对常见的七种异常情况统一进行处理，让整个项目更加优雅。

目录

一、基本介绍

二、项目整体结构图

三、基础配置 

1、导入pom.xml依赖

2、application.yml配置

四、常用类封装

1、HttpStatus状态码常量类

2、AjaxResult统一封装返回的结果类

3、ServiceException业务异常类封装

4、User实体类

五、数据库查询

1、UserMapper.xml文件

2、Mapper接口

六、ExceptionAdvice核心全局拦截配置类

七、异常测试

1、权限校验异常

2、请求方式异常

3、参数校验异常

4、运行异常

5、业务异常

6、全局异常

7、其他异常

八、Gitee源码 

一、基本介绍

这次博客的主角就是@RestControllerAdvice这个注解，这个一个组合注解由@ControllerAdvice和@ResponseBody组成，@RestControllerAdvice会帮助我们把信息转成json格式返回。

在全局异常处理类只需要在类上标注@RestControllerAdvice，并在处理相应异常的方法上使用@ExceptionHandler注解，写明处理哪个异常即可。

废话不多说，本博客列举了实际开发中常见的七种异常进行配置，直接上代码！

二、项目整体结构图

这是项目最后的运行的整个结构

三、基础配置 

1、导入pom.xml依赖

项目中引入的依赖包都贴出来了，一共这么多复制即可。

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- lombok --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><!-- 常用工具类 --><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId></dependency><!-- 参数验证依赖 --><dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version></dependency><dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.1.5.Final</version></dependency><!-- mysql驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope><version>8.0.26</version></dependency><!--Mybatis依赖--><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.2.2</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies>

2、application.yml配置

server:port: 8080spring:datasource:username: 账号password: 密码url: jdbc:mysql://地址:3306/数据库?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTCdriver-class-name: com.mysql.cj.jdbc.Drivermybatis:mapper-locations: classpath:mapping/*.xml

四、常用类封装

1、HttpStatus状态码常量类

这边定义了目前常见的响应的状态码，直接拷贝即可。

package com.example.exception.constant;/*** 返回状态码* @author HTT*/
public class HttpStatus
{/*** 操作成功*/public static final int SUCCESS = 200;/*** 对象创建成功*/public static final int CREATED = 201;/*** 请求已经被接受*/public static final int ACCEPTED = 202;/*** 操作已经执行成功，但是没有返回数据*/public static final int NO_CONTENT = 204;/*** 资源已被移除*/public static final int MOVED_PERM = 301;/*** 重定向*/public static final int SEE_OTHER = 303;/*** 资源没有被修改*/public static final int NOT_MODIFIED = 304;/*** 参数列表错误（缺少，格式不匹配）*/public static final int BAD_REQUEST = 400;/*** 未授权*/public static final int UNAUTHORIZED = 401;/*** 访问受限，授权过期*/public static final int FORBIDDEN = 403;/*** 资源，服务未找到*/public static final int NOT_FOUND = 404;/*** 不允许的http方法*/public static final int BAD_METHOD = 405;/*** 资源冲突，或者资源被锁*/public static final int CONFLICT = 409;/*** 不支持的数据，媒体类型*/public static final int UNSUPPORTED_TYPE = 415;/*** 系统内部错误*/public static final int ERROR = 500;/*** 接口未实现*/public static final int NOT_IMPLEMENTED = 501;
}

2、AjaxResult统一封装返回的结果类

package com.example.exception.domain;import com.example.exception.constant.HttpStatus;
import org.apache.commons.lang3.ObjectUtils;import java.util.HashMap;/*** 操作消息提醒* * @author HTT*/
public class AjaxResult extends HashMap<String, Object>
{private static final long serialVersionUID = 1L;/** 状态码 */public static final String CODE_TAG = "code";/** 返回内容 */public static final String MSG_TAG = "msg";/** 数据对象 */public static final String DATA_TAG = "data";/*** 初始化一个新创建的 AjaxResult 对象，使其表示一个空消息。*/public AjaxResult(){}/*** 初始化一个新创建的 AjaxResult 对象* * @param code 状态码* @param msg 返回内容*/public AjaxResult(int code, String msg){super.put(CODE_TAG, code);super.put(MSG_TAG, msg);}/*** 初始化一个新创建的 AjaxResult 对象* * @param code 状态码* @param msg 返回内容* @param data 数据对象*/public AjaxResult(int code, String msg, Object data){super.put(CODE_TAG, code);super.put(MSG_TAG, msg);if (ObjectUtils.isNotEmpty(data)){super.put(DATA_TAG, data);}}/*** 返回成功消息* * @return 成功消息*/public static AjaxResult success(){return AjaxResult.success("操作成功");}/*** 返回成功数据* * @return 成功消息*/public static AjaxResult success(Object data){return AjaxResult.success("操作成功", data);}/*** 返回成功消息* * @param msg 返回内容* @return 成功消息*/public static AjaxResult success(String msg){return AjaxResult.success(msg, null);}/*** 返回成功消息* * @param msg 返回内容* @param data 数据对象* @return 成功消息*/public static AjaxResult success(String msg, Object data){return new AjaxResult(HttpStatus.SUCCESS, msg, data);}/*** 返回错误消息* * @return*/public static AjaxResult error(){return AjaxResult.error("操作失败");}/*** 返回错误消息* * @param msg 返回内容* @return 警告消息*/public static AjaxResult error(String msg){return AjaxResult.error(msg, null);}/*** 返回错误消息* * @param msg 返回内容* @param data 数据对象* @return 警告消息*/public static AjaxResult error(String msg, Object data){return new AjaxResult(HttpStatus.ERROR, msg, data);}/*** 返回错误消息* * @param code 状态码* @param msg 返回内容* @return 警告消息*/public static AjaxResult error(int code, String msg){return new AjaxResult(code, msg, null);}/*** 方便链式调用** @param key 键* @param value 值* @return 数据对象*/@Overridepublic AjaxResult put(String key, Object value){super.put(key, value);return this;}
}

3、ServiceException业务异常类封装

package com.example.exception.exception;/*** 业务异常类封装* @author HTT*/
public final class ServiceException extends RuntimeException
{private static final long serialVersionUID = 1L;/*** 错误码*/private Integer code;/*** 错误提示*/private String message;/*** 错误明细，内部调试错误*/private String detailMessage;/*** 空构造方法，避免反序列化问题*/public ServiceException(){}public ServiceException(String message){this.message = message;}public ServiceException(String message, Integer code){this.message = message;this.code = code;}public String getDetailMessage(){return detailMessage;}@Overridepublic String getMessage(){return message;}public Integer getCode(){return code;}public ServiceException setMessage(String message){this.message = message;return this;}public ServiceException setDetailMessage(String detailMessage){this.detailMessage = detailMessage;return this;}
}

4、User实体类

package com.example.exception.domain;import lombok.Data;import javax.validation.constraints.NotBlank;@Data
public class User {@NotBlank(message = "用户名不能为空")private String username;@NotBlank(message = "密码不能为空")private String password;
}

五、数据库查询

1、UserMapper.xml文件

这边我故意查询的是我数据库中目前不存在的表none_txt

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.exception.mapper.UserMapper"><select id="select" resultType="Integer">SELECT * FROM none_txt</select>
</mapper>

2、Mapper接口

package com.example.exception.mapper;import org.apache.ibatis.annotations.Mapper;@Mapper
public interface UserMapper {public void select();
}

六、ExceptionAdvice核心全局拦截配置类

这边我一共列举了实际项目开发当中常见的七种异常情况：

1、AccessDeniedException：权限校验异常

2、HttpRequestMethodNotSupportedException：请求方式不支持

3、MethodArgumentNotValidException：参数验证失败异常

4、RuntimeException：拦截未知的运行时异常

5、ServiceException：业务自定义异常

6、Exception：全局异常

7、handlerOtherException：自定义验证异常

package com.example.exception.exception;import com.example.exception.constant.HttpStatus;
import com.example.exception.domain.AjaxResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;import javax.servlet.http.HttpServletRequest;
import java.nio.file.AccessDeniedException;/*** @author HTT*/
@RestControllerAdvice
@Slf4j
public class ExceptionAdvice {/*** 权限校验异常* @param e* @param request* @return*/@ExceptionHandler(AccessDeniedException.class)public AjaxResult handleAccessDeniedException(AccessDeniedException e,HttpServletRequest request) {String requestURI = request.getRequestURI();log.error("请求地址{},权限校验失败{}", requestURI, e.getMessage());return AjaxResult.error(HttpStatus.FORBIDDEN, "没有权限，请联系管理员授权");}/*** 请求方式不支持* @param e* @param request* @return*/@ExceptionHandler(HttpRequestMethodNotSupportedException.class)public AjaxResult handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException e,HttpServletRequest request) {String requestURI = request.getRequestURI();log.error("请求地址{},不支持{}请求", requestURI, e.getMethod());return AjaxResult.error(e.getMessage());}/*** 参数验证失败异常* @param e* @param request* @return*/@ExceptionHandler(MethodArgumentNotValidException.class)public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e,HttpServletRequest request) {String requestURI = request.getRequestURI();String message = e.getBindingResult().getFieldError().getDefaultMessage();log.error("请求地址{},参数验证失败{}", requestURI, e.getObjectName(),e);return AjaxResult.error(message);}/*** 拦截未知的运行时异常* @param e* @param request* @return*/@ExceptionHandler(RuntimeException.class)public AjaxResult handleRuntimeException(RuntimeException e,HttpServletRequest request) {String requestURI = request.getRequestURI();log.error("请求地址{},发生未知运行异常", requestURI, e);return handlerOtherException(e);}/*** 业务自定义异常* @param e* @param request* @return*/@ExceptionHandler(ServiceException.class)public AjaxResult handleServiceException(ServiceException e,HttpServletRequest request) {String requestURI = request.getRequestURI();Integer code = e.getCode();log.error("请求地址{},发生业务自定义异常{}",requestURI,e.getMessage(), e);return code != null ? AjaxResult.error(code, e.getMessage()) : AjaxResult.error(e.getMessage());}/*** 全局异常* @param e* @param request* @return*/@ExceptionHandler(Exception.class)public AjaxResult handleException(Exception e,HttpServletRequest request){String requestURI = request.getRequestURI();log.error("请求地址{},发生系统异常",requestURI,e);return AjaxResult.error(e.getMessage());}/*** 其他特殊异常* @param e* @return*/public AjaxResult handlerOtherException(Exception e){if(e.getCause() != null && e.getCause().toString().startsWith("java.sql.SQL")){return AjaxResult.error(HttpStatus.ERROR, "数据库异常！");}else{return AjaxResult.error(e.getMessage());}}
}

七、异常测试

这边我们逐一对每一个异常进行拦截测试。

1、权限校验异常

测试运行代码：

    /*** 权限测试*/@GetMapping("/auth")public void auth() throws AccessDeniedException {throw new AccessDeniedException("暂无权限");}

浏览器输入：http://localhost:8080/user/auth

浏览器显示如下：

 后台日志显示如下：

2、请求方式异常

测试运行代码：

    /*** 请求不支持异常测试*/@PostMapping("/request")public void request() {System.out.println("request");}

浏览器输入：http://localhost:8080/user/request

浏览器显示如下： 

后台日志显示如下：

3、参数校验异常

测试运行代码：

    /*** 参数验证异常测试* @param user*/@PostMapping("/valid")public void Valid(@Valid @RequestBody User user){System.out.println(user.toString());}

使用postman测试：

后台日志显示如下：

4、运行异常

测试运行代码：

    /*** 运行异常*/@GetMapping("/runtimeException")public void runtimeException(){throw new RuntimeException();}

浏览器输入：http://localhost:8080/user/request

浏览器显示如下： 

后台日志显示如下：

5、业务异常

测试运行代码：

    /*** 业务自定义异常*/@GetMapping("/serviceException")public void serviceException() {throw new ServiceException("业务异常！");}

浏览器输入：http://localhost:8080/user/request

浏览器显示如下： 

后台日志显示如下：

6、全局异常

测试运行代码：

    /*** 全局异常*/@GetMapping("/exception")public void exception() throws Exception {throw new Exception("全局异常！");}

浏览器输入：http://localhost:8080/user/exception

浏览器显示如下： 

​

 后台日志显示如下：

​

7、其他异常

这边我自己定义了一个在数据库查询的过程当中，如果表、字段或者视图不存在会抛出SQLSyntaxErrorException异常，而这个异常是继承RuntimeException异常的，进行了特殊处理，不然会把SQL语句也暴漏给客户端显示。

测试代码如下：

    @Resourceprivate UserMapper userMapper;/*** 其他异常*/@GetMapping("/otherException")public void otherException() throws Exception {userMapper.select();}

如果把这段代码注释掉：

if(e.getCause() != null && e.getCause().toString().startsWith("java.sql.SQL")){return AjaxResult.error(HttpStatus.ERROR, "数据库异常！");
}

浏览器输入：http://localhost:8080/user/otherException

浏览器显示如下：

显而易见，当我们注释掉了这段自定义的异常以后，返回给前端的错误信息中居然还包含了我们的SQL执行语句，这显然是不合理的，应该是浏览器端只能提示一个例如数据库异常的通用提示，具体信息在我们的后台进行记录。 

所以当我们加上那段自定义异常，再执行一遍看效果：

后台日志显示如下：

八、Gitee源码 

SpringBoot处理实际开发中常见的七种全局异常详解: 在日常的开发工作中，项目在运行过程中多多少少是避免不了报错的，对于报错信息肯定不可以把全部信息都抛给客户端去显示，这里就需要我们对常见的七种异常情况统一进行处理，让整个项目更加优雅。


http://www.ppmy.cn/news/590631.html

相关文章

中国市场手机销量继续下滑，苹果却意外成为最大赢家

中国市场手机销量继续下滑，苹果却意外成为最大赢家

分析机构给出的数据显示一季度中国市场的手机出货量同比下滑了20%&#xff0c;销量再创2014年以来的新低纪录&#xff0c;不过在市场整体下行的时候&#xff0c;苹果却意外取得了国内手机市场第一名&#xff0c;这是苹果首次在淡季取得国内手机市场第一名。 一季度的数据显示苹…
阅读更多...
手机销量腰斩，消费者不仅不愿换国产手机，连iPhone也被反噬

手机销量腰斩，消费者不仅不愿换国产手机，连iPhone也被反噬

分析机构给出了2022年中国市场手机销量的数据&#xff0c;数据显示中国市场的手机销量已跌至2.55亿部&#xff0c;较2016年的高点已经腰斩&#xff0c;让业界担忧的是消费者不愿换国产手机了&#xff0c;如今连iPhone换新的意愿也减弱了。 据分析机构的数据指2022年中国市场的手…
阅读更多...
京东/淘宝前四名手机销量排行

京东/淘宝前四名手机销量排行

Apple 型号 : Iphone11 屏幕分分辨率: iphone11屏幕尺寸6.1英寸&#xff0c;分辨率是1792x828&#xff0c;对比度1400:1&#xff0c;是iphone11系列中分辨率最低的&#xff0c; 系统 : 搭载ios系统 ios版本号 : ios13 型号: Iphone12 Pro Max: 屏幕分分辨率: Phone 12 Pr…
阅读更多...
日系家电份额下跌 黄金周销量谁来补缺？

日系家电份额下跌 黄金周销量谁来补缺？

往年的黄金周是各大家电厂商降价促销的好时机&#xff0c;但今年受钓鱼岛事件影响&#xff0c;日系家电在“十一黄金周”期间的促销恐怕难以达到以往的效果。业内人士预计销量将比往年黄金周低三至四成。 奥维咨询平板显示事业部副总经理刘闯接受记者采访时表示&#xff0c;日系…
阅读更多...
【Python】计算手机销量年增长率

【Python】计算手机销量年增长率

文件smartphone.txt存放着某些公司手机年销量数据&#xff0c;每行为每家公司若干年销量&#xff08;百万&#xff09;&#xff0c;数据间的分隔符为制表符。打开文件请注明文件编码格式&#xff1a;with open("smartPhone.txt",encoding"gbk") as f:编写函…
阅读更多...
中国有钱人抢购iPhone，推动苹果销量猛增重夺全球手机市场第二名

中国有钱人抢购iPhone，推动苹果销量猛增重夺全球手机市场第二名

市调机构IDC公布了今年三季度的全球智能手机市场的数据&#xff0c;数据显示苹果在全球前五当中同比增速最高&#xff0c;排名也从第三名回升至第二名&#xff0c;中国消费者是iPhone出货量增长的主要推动力。 IDC公布的三季度全球智能手机出货量数据显示&#xff0c;前五名当中…
阅读更多...
【LC困难】1384. 按年度列出销售总额

【LC困难】1384. 按年度列出销售总额

❤️博客主页: 楚生辉 ❤️系列专栏:【LeetCode刷题】 ❤️一句短话: 坚持不懈&#xff0c;孜孜不倦 1.题目描述 Product 表&#xff1a; ------------------------ | Column Name | Type | ------------------------ | product_id | int | | product_name | v…
阅读更多...
拼多多618手机品牌官旗销量同比增长124%，4000+高价位手机同比增长156%

拼多多618手机品牌官旗销量同比增长124%，4000+高价位手机同比增长156%

6月19日&#xff0c;拼多多发布了618手机“真香”战报。截至18日23:59的数据显示&#xff0c;在全网最高性价比的优势下&#xff0c;平台手机类目在618期间继续保持了强劲势头&#xff0c;全类目销售额同比增长148%&#xff0c;订单量同比增长118%。 ▲在618期间&#xff0c;拼…
阅读更多...
最新文章

Copyright @ 2022~2023