SpringBoot系列(十)统一异常解决与统一结果返回

作者 : 开心源码 本文共4820个字,预计阅读时间需要13分钟 发布时间: 2022-05-13 共266人阅读

SpringBoot系列(十)统一异常解决与统一结果返回

往期推荐

SpringBoot系列(一)idea新建Springboot项目

SpringBoot系列(二)入门知识

springBoot系列(三)配置文件详解

SpringBoot系列(四)web静态资源配置详解

SpringBoot系列(五)Mybatis整合完整详细版

SpringBoot系列(六)集成thymeleaf详解版

Springboot系列(七) 集成接口文档swagger,使用,测试

SpringBoot系列(八)分分钟学会Springboot多种处理跨域方式

SpringBoot系列(九)文件上传的正确姿势

目录

  • 1. 全局异常捕获与解决
  • 2. 统一结果返回与统一异常
  • 3. controller代码测试与结果
  • 4. 404异常特殊解决。
  • 5. 总结

引言:

 日常开发过程中,难免有的程序会由于某些起因抛出异常,而这些异常一般都是利用try ,catch的方式解决异常或者者throw,throws的方式抛出异常不论。这种方法对于程序员来说解决也比较麻烦,对用户来说也不太友好,所以我们希望既能方便程序员编写代码,不用过多的自己去解决各种异常编写重复的代码又能提升客户的体验,这时候全局异常解决就显得很重要也很便捷了,是一种不错的选择。

1. 全局异常捕获与解决

 由于现在主流的都是前后台分离的项目,所以我们的异常解决也根据前后台分离来讲述。

 Springboot对于异常的解决也做了不错的支持,它提供了一个 @ControllerAdvice注解以及 @ExceptionHandler注解,前者是用来开启全局的异常捕获,后者则是说明捕获哪些异常,对那些异常进行解决。

@ControllerAdvicepublic class MyExceptionHandler {    @ExceptionHandler(value =Exception.class)    public String exceptionHandler(Exception e){        System.out.println("发生了一个异常"+e);        return e.getMessage();    }}

 上面这段代码就是说,只需是代码运行过程中有异常就会进行捕获,并输出出这个异常。而后我们随意编写一个会发生异常的代码,测试出来的异常是这样的。

1.png

 这对于我们前后台分离来说并不好,前后台分离之后唯一的交互就是json了,我们也希望将后台的异常变成json返回给前台解决。下面我们看看统一结果解决。

2. 统一结果返回与统一异常

代码:

public class Result<T> {    //能否成功    private Boolean success;    //状态码    private Integer code;    //提醒信息    private String msg;    //数据    private T data;    public Result() {    }    //自己设置返回结果的构造方法    public Result(Boolean success,Integer code, String msg,T data) {        this.success = success;        this.code = code;        this.msg = msg;        this.data = data;    }    //自己设置异常返回的结果    public static Result defineError(DefinitionException de){        Result result = new Result();        result.setSuccess(false);        result.setCode(de.getErrorCode());        result.setMsg(de.getErrorMsg());        result.setData(null);        return result;    }    //其余异常解决方法返回的结果    public static Result otherError(ErrorEnum errorEnum){        Result result = new Result();        result.setMsg(errorEnum.getErrorMsg());        result.setCode(errorEnum.getErrorCode());        result.setSuccess(false);        result.setData(null);        return result;    }}

 说明:其中省略了get,set方法。另外方法之中包含了一个自己设置的枚举。代码如下:

public enum ErrorEnum {    // 数据操作错误定义    SUCCESS(200, "nice"),    NO_PERMISSION(403,"你没得权限"),    NO_AUTH(401,"你能不能先登录一下"),    NOT_FOUND(404, "未找到该资源!"),    INTERNAL_SERVER_ERROR(500, "服务器跑路了"),    ;    /** 错误码 */    private Integer errorCode;    /** 错误信息 */    private String errorMsg;    ErrorEnum(Integer errorCode, String errorMsg) {        this.errorCode = errorCode;        this.errorMsg = errorMsg;    }    public Integer getErrorCode() {        return errorCode;    }    public String getErrorMsg() {        return errorMsg;    }}

 说明:枚举类中定义了常见的错误码以及错误的提醒信息。
这里我们就定义好了统一的结果返回,其中里面的静态方法是用来当程序异常的时候转换成异常返回规定的格式。

 而后我们需要自己设置异常解决类。代码如下:

public class DefinitionException extends RuntimeException{    protected Integer errorCode;    protected String errorMsg;    public DefinitionException(){    }    public DefinitionException(Integer errorCode, String errorMsg) {        this.errorCode = errorCode;        this.errorMsg = errorMsg;    }    public Integer getErrorCode() {        return errorCode;    }    public void setErrorCode(Integer errorCode) {        this.errorCode = errorCode;    }    public String getErrorMsg() {        return errorMsg;    }    public void setErrorMsg(String errorMsg) {        this.errorMsg = errorMsg;    }}

 其中包含了错误的状态码,错误的提醒信息。而后我们可以自己设置一个全局异常解决类,来解决各种异常,包括自己定义的异常和内部异常。这样可以简化不少代码,不用自己对每个异常都使用try,catch的方式来实现。

@ControllerAdvicepublic class GlobalExceptionHandler {    /**     * 解决自己设置异常     *     */    @ExceptionHandler(value = DefinitionException.class)    @ResponseBody    public Result bizExceptionHandler(DefinitionException e) {        return Result.defineError(e);    }    /**     * 解决其余异常     *     */    @ExceptionHandler(value = Exception.class)    @ResponseBody    public Result exceptionHandler( Exception e) {        return Result.otherError(ErrorEnum.INTERNAL_SERVER_ERROR);    }}

 说明:每个方法上面加上一个 @ResponseBody的注解,用于将对象解析成json,方便前后台的交互,也可以使用 @ResponseBody放在异常类上面。

3. controller代码测试与结果

 controller代码:

@RestController@RequestMapping("/result")public class ResultController {    @GetMapping("/getStudent")    public Result getStudent(){        Student student = new Student();        student.setAge(21);        student.setId(111);        student.setName("学习笔记");        Result result = new Result();        result.setCode(200);        result.setSuccess(true);        result.setData(student);        result.setMsg("学生列表信息");        return result;    }    @RequestMapping("/getDeException")    public Result DeException(){        throw new DefinitionException(400,"我出错了");    }    @RequestMapping("/getException")    public Result Exception(){        Result result = new Result();        int a=1/0;        return result;    }}

 其中的Student类就是前面一直在用的类了。包含三个属性。其中省略了get,set方法。

public class Student  {    /**    * 唯一标识id    */    private Integer id;    /**    * 姓名    */    private String name;    /**    * 年龄    */    private Integer age;}

 而后启动项目,来挨个测试。首先测试正常没有异常发生的数据。
浏览器输入:localhost:8095/result/getStudent

2.png

 可以看到数据是正常返回json串。没有异常。
而后我们测试第二个自己设置异常解决接口。浏览器输入localhost:8095/result/getDeException。

3.png

 可以看到这个自己设置的异常是捕获到了,并且返回了一个json串。
最后我们测试一下其余的异常。浏览器输入:localhost:8095/result/getException

4.png

 到这里我们就解决完了异常并且正确的返回了前台。
这里说一下,测试接口又很多方法,可以使用postman,或者者idea自带的接口测试工具都很好用。

 但是,你可能会发现一个问题,这种方法是不能解决404异常的,捕获不到。该怎样办呢?

4. 404异常特殊解决。

 默认情况下,SpringBoot是不会抛出404异常的,所以@ControllerAdvice也不能捕获到404异常。我们可以通过以下配置来让这个注解能捕获到404异常。

spring.mvc.throw-exception-if-no-handler-found=truespring.resources.add-mappings=false

其中第一句是表示:当发现404异常时直接抛出异常。第二句关闭默认的静态资源路径映射。这样404错误也能被捕获到,但是这个配置会让你的静态资源访问出现问题,也就是不适合前后台不分离的情况。

5. 总结

 本文讲解了如何解决捕获全局异常以及怎样自己设置异常,顺便说明了统一结果的返回格式,并特殊解决的404,not found的异常,将其作为统一结果返回。假如你觉得本文有用,点个赞吧!

QQ截图20200418173928.png

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » SpringBoot系列(十)统一异常解决与统一结果返回

发表回复