标签分类
技术文章
当前位置:主页 > 计算机编程 > java > SpringBoot使用统一异常处理详解

SpringBoot使用统一异常处理实例讲解

  • 发布时间:
  • 作者:码农之家原创
  • 点击:194

SpringBoot使用统一异常处理详解

这篇文章主要知识点是关于SpringBoot,异常处理,SpringBoot使用统一异常处理详解,spring boot 默认异常处理的实现 的内容,如果大家想对相关知识点有系统深入的学习,可以参阅以下电子书

Spring Boot 2企业应用实战
  • 类型:Spring大小:92.99 MB格式:PDF出版:电子工业出版社作者:疯狂软件
立即下载

更多相关的学习资源可以参阅 程序设计电子书Java电子书、等栏目。

场景:针对异常处理,我们原来的做法是一般在最外层捕获异常即可,例如在Controller中

@Controller
public class HelloController {
 
  private static final Logger logger = LoggerFactory.getLogger(HelloController.class);
 
  @GetMapping(value = "/hello")
  @ResponseBody
  public Result hello() {
    try {
      //TODO 具体的逻辑省略……
    } catch (Exception e) {
      logger.error("hello接口异常={}", e);
      return ResultUtil.success(-1, "system error", null);
    }
    return ResultUtil.success(0, "success", null);
  }
}

这样的话也能解决部分问题,但是无法获取到自己指定的异常,引入全局统一异常处理的话将会极大的改善代码,减少冗余代码的产生。

自定义异常类:注意要继承自RuntimeException而不是Exception,继承自Exception的话,当抛出自定义异常时spring事务不会回滚

public class GlobalException extends RuntimeException {
 
  private Integer code; //因为我需要将异常信息也返回给接口中,所以添加code区分
 
  public GlobalException(Integer code,String message) {
    super(message);  //把自定义的message传递个异常父类
    this.code = code;
  }
 
  public Integer getCode() {
    return code;
  }
 
  public void setCode(Integer code) {
    this.code = code;
  }
}

自定义统一异常处理器:比较关键的两个注解@ControllerAdvice、@ExceptionHandler

@ControllerAdvice
public class ExceptionHandle {
 
  @ResponseBody  //因为我需要将抛出的异常返回给接口,所以加上此注解
  @ExceptionHandler
  public Result handle(Exception e) {
    if (e instanceof GlobalException) {
      GlobalException ge = (GlobalException) e;
      return ResultUtil.success1(ge.getCode(), ge.getMessage());
    }
    return ResultUtil.success1(-1, "system error!");
  }
 
}

写个测试类测试下

@GetMapping(value = "/hello1")
@ResponseBody
public Result hello(@RequestParam(value = "age", defaultValue = "50", required = false) Integer age) throws GlobalException {
  if (age < 10) {
    throw new GlobalException(ConstantEnum.LESS10.getCode(), ConstantEnum.LESS10.getMsg());
  } else if (age > 50) {
    throw new GlobalException(ConstantEnum.MORE50.getCode(), ConstantEnum.MORE50.getMsg());
  } else {
    return ResultUtil.success1(0, "success");
  }
}

把code、message封装在了ConstantEnum枚举里面,方便统一维护

public enum ConstantEnum {
 
  ERROR(-1, "system error!"),
  SUCCESS(100, "success"),
  LESS10(101, "自定义异常信息-我小于10岁"),
  MORE50(5001, "自定义异常信息-我大于50岁");
 
  private Integer code;
  private String msg;
 
  public Integer getCode() {
    return code;
  }
 
  public String getMsg() {
    return msg;
  }
 
  ConstantEnum(Integer code, String msg) {
    this.code = code;
    this.msg = msg;
  }
}

SpringBoot使用统一异常处理详解

这样就实现了全局的统一异常处理,非常方便且优雅,快快在你的项目中用起来吧!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。

spring boot 默认异常处理的实现

本周在看陈杰写的自定义异常的微信异常时,使用的是自定义异常状态码和信息,在出错时将他抛出,并用@ExceptionHandler注解定义一个全局异常处理器,根据异常的内容向前台发送状态码和信息,处理异常的代码如下图:

//处理微信登录的异常
  @ExceptionHandler(value = WechatLoginException.class)
  public String WechatLoginExceptionHandler(HttpServletRequest request, HttpServletResponse response, WechatLoginException e){
    logger.error("微信登录异常:---Host {} invokes url {} ERROR: {}", request.getRemoteHost(), request.getRequestURL(), e.getMessage());
    response.setStatus(e.getCode());
    return e.getMessage();
  }

在这里我看的时候有点疑惑,将状态码写入响应,而信息却直接返回了,询问陈杰,前台果然没有接受到e.getMessage()的信息,我上网搜索了一下,推荐他使用response.sendError(code, message)这个方法来返回异常的信息,但是这么一试之后却遭到了奇怪的问题.

莫名的拦截器

项目配置了一个拦截器,专门用来对用户进行验证是否登录的,这个是前提.在使用response.setStatus()方法时,前台能正确的接受到传入的状态码,而使用response.sendError()时,前台却接受到的一直是401用户未登录的状态码,打了断点进行调试,分别在拦截器,跑出异常的方法,处理异常的方法打上断点,测试使用response.setStatus()和response.sendError()方法来查看执行顺序,结果让我感到惊奇:

使用response.setStatus()执行顺序:

spring boot 默认异常处理的实现

使用response.sendError()执行顺序:

spring boot 默认异常处理的实现

出现了令人惊奇两点:

1.setStatus()请求时没有经过拦截器
2.sendError()在异常处理完毕后经过了一次拦截器

查看注册拦截器配置,解决了第一个问题的疑惑:

public void addInterceptors(InterceptorRegistry registry) {
    // 添加拦截器,去除对登录的拦截
    registry.addInterceptor(authInterceptor)
    .excludePathPatterns("/user/login")
    .excludePathPatterns("/user/wechatLogin");
  }

这个异常是用户登录时抛出的,在注册时将登录路径给忽略了,因为我们只是拦截未登录的请求,而请求登录的请求不应该拦截,这是正确的,但第二点却怎么也不明白,本应忽略拦截的请求,为什么换了sendError()方法后,却在异常处理完毕后经过了异常拦截器?

springboot的默认异常处理

对比两个方法的不同:setStatus()只是改了一下状态吗,而sendError()还有请求错误的意味,于是猜想是不是请求错误才会出现这种情况,将方法直接改为throw new RuntimeException()(没有处理异常),发现拦截器拦截的请求的url居然是一个/error的url.

spring boot 默认异常处理的实现

这个/error的url并未在项目中定义过任何的控制器中,也从未发起这样的请求,上网一查询,原来这是Spring Boot提供了一个默认的映射:/error,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面用来展示异常内容.
但是我们的拦截器把这个请求拦截了(并且这个请求没有携带正确的cookie),所以直接就返回了401错误,response中也没有我们定义的状态码和信息了.

json还是html

一切真相大白了,但忽然想到如果是浏览器发起的请求,服务器错误后springboot默认异常处理返回的是html,但是如果像我们前后台分离的请求,返回就不应该是html而是json的错误信息了,这个要怎么区分呢?
使用google插件发送请求,返回的body是这样的:

spring boot 默认异常处理的实现

而用浏览器发起的请求返回的却是一个html页面:

<html>
<body>
<h1>Whitelabel Error Page</h1>
<p>This application has no explicit mapping for /error, so you are seeing this as a fallback.</p>
<div id='created'>Sat Apr 13 21:34:34 CST 2019</div>
<div>There was an unexpected error (type=Internal Server Error, status=500).</div>
<div>No message available</div>
</body>
</html>

仔细查看两者发起的请求不同,在浏览器发起请求信息requestheader上发现了Accept字段:

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8

顿时就明白了,在发送请求时spring-boot根据Accept字段来给你返回响应的内容,例如application/json返回json,text/html返回html,真是感叹spring-boot真是太周全了.

总结

spring-boot好心帮你默认请求异常,但是却给你带来了麻烦,感觉还是自己理解的不够多,学习路还远着呢。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。

以上就是本次给大家分享的全部知识点内容总结,大家还可以在下方相关文章里找到解决axios.interceptors.respon、 详解vue axios封装请求状态、 vue项目中使用md5加密以及、 等java文章进一步学习,感谢大家的阅读和支持。

上一篇:java对synchronized的优化知识点总结

下一篇:java异常与处理机制分析

展开 +

收起 -

学习笔记
网友NO.460131

springboot结合全局异常处理实现登录注册验证

在学校做一个校企合作项目,注册登录这一块需要对注册登录进行输入合法的服务器端验证,因为是前后端分离开发,所以要求返回JSON数据。 方法有很多,这觉得用全局异常处理比较容易上手 全局异常处理 首先来创建一个sprIngboot的web项目或模块,目录结构如下 实体类User.java @Datapublic class User { private String userName; private String passwold;} 实体类UserResult.java 把数据封装到这里返回到客户端 @Data@NoArgsConstructor@AllArgsConstructorpublic class UserResult { private int code; private String msg;} 接下来自定义异常,都继承自Exception UserNullException.java 当用户名为空抛出这个异常 public class UserNullException extends Exception{ public UserNullException() { super("用户名不能为空"); }} PasswoldNullException.java 当密码为空抛出这个异常 public class PasswoldNullException extends Exception { public PasswoldNullException() { super("密码不能为空"); }} UserNamePasswordNullException.java 当用户名和密码都为空抛出这个异常 public class UserNamePasswordNullException extends Exception { public UserNamePasswordNullException() { super("请输入用户名和密码"); }} UserNameValidationException.jva 当输入不符合要求的用户名时抛出此异常 public class UserNameValidationException extends Exception{ public UserNameValidationException() { super("请输入6到16位的数字或字母组合"); }} UserNam……

网友NO.925238

SpringBoot学习之全局异常处理设置(返回JSON)

SpringBoot学习——全局异常处理设置(返回JSON) 需求 现在习惯使用ajax的方式发起请求,所以经常需要服务端返回一个json或者字符串。 控制全局的异常处理。 如果在单个方法中使用try,catch把方法包裹起来,工作量大,而且会异常的抛出而导致@Transactional注解的方法事务不会回滚。 说明 使用@ControllerAdvice注解 使用@ExceptionHandler注解 @ControllerAdvice 该注解是spring2.3以后新增的一个注解,主要是用来Controller的一些公共的需求的低侵入性增强提供辅助,作用于@RequestMapping标注的方法上。 @ExceptionHandler 该注解是配合@ExceptionHandler一起使用的注解,自定义错误处理器,可自己组装json字符串,并返回到页面。 代码 创建一个全局异常处理类,如下: 如果向实现,不同的异常有不同的操作的话,只需要将 @ExceptionHandler的value的值不一样就可以了,可以同时实现多个不同的异常处理,但不能出现包含状态。 import javax.servlet.http.HttpServletRequest;import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.ResponseBody;@ControllerAdvice@ResponseBodypublic class GlobalExceptionHandler { /** * 所有异常报错 * @param request * @param exception * @return * @throws Exception */ @ExceptionHandler(value=Exception.class) public ……

网友NO.817874

Spring Boot 数据校验@Valid+统一异常处理的实现

1.先在你需要校验的实体类上面加上所需要的注解 为了测试,我自己就简单写了。@NotNull 和 @NotBlank 不能为空 @Entity @Table(name = "User") @Data public class User implements Serializable { @Id @NotNull(message = "id不能为空") @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id; @NonNull @NotBlank(message = "姓名不能为空") @Column(name = "name") private String name; public User() { } public User(Integer id,String name) { this.id=id; this.name = name; }} 下面是我从别的博客收集的所有参数校验注解的使用规则方法 空检查 @Null 验证对象是否为null @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. @NotEmpty 检查约束元素是否为NULL或者是EMPTY. Booelan检查 @AssertTrue 验证 Boolean 对象是否为 true @AssertFalse 验证 Boolean 对象是否为 false 长度检查 @Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内 @Length(min=, max=) Validates that the annotated string is between min and max included. 日期检查 @Past 验证 Date 和 Calendar 对象是否在当前时间之前 @Future 验证 Date 和 Calendar 对象是否在当前时间之后 @Pattern 验证 String 对象是否符合正则表达式的规则 数值检查 建议使用在Stirng,Integer类型,不建议使用在int类型上……

<
1
>

Copyright 2018-2019 xz577.com 码农之家

版权责任说明