spring boot 统一异常处理
需求源自于任何一个业务的编写总会有各种各样的条件判断,需要时时手动抛出异常,又希望让接口返回友好的错误信息。
spring boot提供的帮助是自动将异常重定向到路由为/error的控制器
但是我们又希望手动抛出的异常与正常的数据返回为同一类型
所以我的解决方案由三个步骤组成:
1.一个异常枚举类 StatusCodeEnum.java
public enum StatusCodeEnum implements Serializable {
SUCCESS(0, "成功"),
ERROR(-1, "失败"),
USER_INVALID(60000, "无效用户"),
SYS_ARG_INVALID(11000, "无效参数"), ;
private static final long serialVersionUID = 1L;
private int code;
private String msg; StatusCodeEnum(int code, String msg) {
this.code = code;
this.msg = msg;
}
public int getCode() {
return code;
} public void setCode(int code) {
this.code = code;
} public String getMsg() {
return msg;
} public void setMsg(String msg) {
this.msg = msg;
} //根据code获取对应枚举
public static StatusCodeEnum getByCode(int code) {
StatusCodeEnum[] values = StatusCodeEnum.values(); for (StatusCodeEnum bizStatusCodeEnum : values) {
if (bizStatusCodeEnum.code == code) {
return bizStatusCodeEnum;
}
}
return null;
}
}
2.一个异常调用类 BaseException.java
因为抛出异常只能抛出字符串 所以这里使用了com.alibaba.fastjson.JSON包
public class BaseException {
private int code;
private String message; public static void error(StatusCodeEnum statusCodeEnum) throws Exception
{
error(statusCodeEnum.getCode(),statusCodeEnum.getMsg());
} public static void error(String message) throws Exception
{
error(-1,message);
} public static void error(int code,String message) throws Exception
{
BaseException baseException = new BaseException();
baseException.setCode(code);
baseException.setMessage(message);
throw new Exception(JSON.toJSONString(baseException)) ;
} public int getCode() {
return code;
} public void setCode(int code) {
this.code = code;
} public String getMessage() {
return message;
} public void setMessage(String message) {
this.message = message;
} @Override
public String toString() {
return "BaseException{" +
"code=" + code +
", message='" + message + '\'' +
'}';
}
}
3.异常处理控制器 ErrorController.java
@Controller
public class ErrorController extends AbstractErrorController{ @Autowired
ObjectMapper objectMapper; public ErrorController() {
super(new DefaultErrorAttributes());
} @Override
public String getErrorPath() {
return null;
} @RequestMapping("/error")
@ResponseBody
public BaseRs getErrorPath(HttpServletRequest request, HttpServletResponse response) { Map<String,Object> model = Collections.unmodifiableMap(getErrorAttributes(request,false)); //获取异常 可将异常打印到日志
Throwable cause = getCause(request);
int status = (Integer)model.get("status"); //自定义友好错误信息
String msg = (String)model.get("message"); JSONObject object = JSONObject.parseObject(msg);
int code = object.getInteger("code");
String message = object.getString("message"); return new BaseRs(code,message);
} protected Throwable getCause(HttpServletRequest request)
{
Throwable error = (Throwable)request.getAttribute("javax.servlet.error.exception");
if(null == error){
//MVC有可能会封装异常成ServletException ,需要调用getCause获取真正的异常
while (error instanceof ServletException && error.getCause() != null){
error = ((ServletException) error).getCause();
}
}
return error;
}
}
以上三个文件为异常处理的核心
其中的BaseRs类是统一数据返回
public class BaseRs<T> implements Serializable { private int code; private String message; public BaseRs() {
} /**
* 返回内容
*/
private T content; public int getCode() {
return code;
} public String getMessage() {
return message;
} public T getContent() {
return content;
} public BaseRs(int code, String message) {
this.code = code;
this.message = message;
} public BaseRs(int code, String message, T content) {
this.code = code;
this.message = message;
this.content = content;
} public BaseRs(StatusCodeEnum status) {
this.code = status.getCode();
this.message = status.getMsg();
} public BaseRs(StatusCodeEnum status, T content) {
this.code = status.getCode();
this.message = status.getMsg();
this.content = content;
} public static <V> BaseRs ok(V content) {
return new BaseRs(StatusCodeEnum.SUCCESS, content);
} public static BaseRs ok() {
return new BaseRs(StatusCodeEnum.SUCCESS);
} public static BaseRs error(StatusCodeEnum error) {
return new BaseRs(error);
} public void setCode(StatusCodeEnum status) {
this.code = status.getCode();
} public void setMessage(String message) {
this.message = message;
} public void setContent(T content) {
this.content = content;
} @Override
public String toString() {
return "BaseRs{" +
"code=" + code +
", message='" + message + '\'' +
", content=" + content +
'}';
} public void setCode(int code) {
this.code = code;
}
}
最后的控制层代码以最简洁的方式调用即可:
@Controller
public class IndexController {
@RequestMapping("/a")
@ResponseBody
public BaseRs a() throws Exception{
boolean s = false;
if(!s){
BaseException.error(StatusCodeEnum.USER_INVALID);
}
return new BaseRs(StatusCodeEnum.SUCCESS);
}
}
本篇博客的码云地址: https://gitee.com/zhao-baolin/springboot_error
spring boot 统一异常处理的更多相关文章
- Spring Boot统一异常处理实践
摘要: SpringBoot异常处理. 原文:Spring MVC/Boot 统一异常处理最佳实践 作者:赵俊 前言 在 Web 开发中, 我们经常会需要处理各种异常, 这是一件棘手的事情, 对于很多 ...
- Spring Boot☞ 统一异常处理
效果区: 代码区: package com.wls.integrateplugs.exception.dto; public class ErrorInfo<T> { public st ...
- Spring Boot统一异常处理方案示例
一.异常处理的原则 1.调用方法的时候返回布尔值来代替返回null,这样可以 NullPointerException.由于空指针是java异常里最恶心的异常. 2. catch块里别不写代码.空ca ...
- Spring MVC 统一异常处理
Spring MVC 统一异常处理 看到 Exception 这个单词都心慌 如果有一天你发现好久没有看到Exception这个单词了,那你会不会想念她?我是不会的.她如女孩一样的令人心动又心慌,又或 ...
- 编程小白入门分享三:Spring AOP统一异常处理
Spring AOP统一异常处理 简介 在Controller层,Service层,可能会有很多的try catch代码块.这将会严重影响代码的可读性."美观性".怎样才可以把更多 ...
- Spring Boot全局异常处理
本文为大家分享了Spring Boot全局异常处理,供大家参考,具体内容如下 1.后台处理异常 a.引入thymeleaf依赖 <!-- thymeleaf模板插件 --> <dep ...
- Spring Boot 统一返回结果及异常处理
在 Spring Boot 构建电商基础秒杀项目 (三) 通用的返回对象 & 异常处理 基础上优化.调整 一.通用类 1.1 通用的返回对象 public class CommonReturn ...
- spring boot 统一接口异常返回值
创建业务 Exception 一般在实际项目中,推荐创建自己的 Exception 类型,这样在后期会更容易处理,也比较方便统一,否则,可能每个人都抛出自己喜欢的异常类型,而造成代码混乱 Servic ...
- 使用Spring MVC统一异常处理实战
1 描述 在J2EE项目的开发中,不管是对底层的数据库操作过程,还是业务层的处理过程,还是控制层的处理过程,都不可避免会遇到各种可预知的.不可预知的异常需要处理.每个过程都单独处理异常,系统的代码耦合 ...
随机推荐
- CF741C.Arpa’s overnight party and Mehrdad’s silent entering [构造 二分图染色]
CF741C - Arpa's overnight party and Mehrdad's silent entering 题意: 有 n 对情侣坐成一个圈,有两种食物Kooft and Zahre- ...
- Android Studio 中 Live Templates 的使用
Android Studio 中的 Live Templates 是什么? Live Templates 有什么用处? Live Templates 可以理解为:在你编码过程中,IDE自动生成的代码内 ...
- Spring系列__01HelloWorld
Spring作为一款成熟的Java框架,其优点和意义不用我多说,可以参考:https://m.w3cschool.cn/wkspring/pesy1icl.html 今天开始写一下Spring家族的总 ...
- php一些高级函数方法
PHP高级函数 1.call_user_func (http://php.net/manual/zh/function.call-user-func.php) 2.get_class (http:// ...
- HTMl、CSS、JS的区别:
HTMl.CSS.JS的区别: Html:决定网页的结构和内容----[结构] Css:控制页面的表现样式,如:美化页面----[表现] Js:控制网页的行为,如:给页面加动态的效果----[行为]
- 使用Js进行linq处理
需要引用的文件 <script src="~/js/linq/jquery.linq-vsdoc.js"></script><script src=& ...
- FliterLog代码分析
Filter简介 Filter也称之为过滤器,它是Servlet技术中最实用的技术,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件 ...
- [LeetCode] Split Array into Fibonacci Sequence 分割数组成斐波那契序列
Given a string S of digits, such as S = "123456579", we can split it into a Fibonacci-like ...
- 编写程序,输入一个N,返回角谷变换(达到1所需)的次数
import java.util.Scanner; /** * @author:(LiberHome) * @date:Created in 2019/3/6 17:36 * @description ...
- victory-native的使用
Victory用于构建交互数据可视化的可组合React组件的生态系统 想写又不想写,真尴尬...