如何优雅的处理异常?SpringBoot全局异常与数据校验

要思考的问题

在现在的前后端交互中,通常都规范了接口返回方式,如返回的接口状态(成功|失败)以及要返回的数据在那个字段取,或者说失败了以后提示信息从接口哪里返回,因此,如果想做全局异常,并且异常发生后能准确的返回给前端解析,那么需要异常发生时返回给前端的格式与正常失败场景的格式一致。

项目建立

利用idea 工具,很容易的搭建一个SpringBoot项目,要引入的maven依赖如下:

<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-validation</artifactId>

</dependency>

<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-web</artifactId>

</dependency>

<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-test</artifactId>

    <scope>test</scope>

</dependency>

很简单,除了加入web功能还加入了我们需要用到的JSR-303校验框架。

定义成功失败 返回码

public class Code {

    /**

     * 成功

     */

    public static int SUCCESSED = 1;

    /**

     * 失败

     */

    public static int FAILED = -1;

}

定义接口返回响应实体

public class Response<T> implements Serializable{

   /**

    * 

    */

   private static final long serialVersionUID = 4250719891313555820L;

   /**

    * 返回结果集

    */

   private T result;

   /**

    * 返回消息

    */

   private String msg;

   /**

    * 响应码

    */

   private Integer code;

   //set get 略

}

全局异常拦截和验证

定义自定义业务异常

public class MyException extends RuntimeException {

    private static final long serialVersionUID = -5875371379845226068L;

    public MyException(){}

    public MyException(String msg){

        this.msg = msg ;

    }

    /**

     * 异常信息

     */

    private String msg ;

    /**

     * 具体异常码

     */

    private int code = Code.FAILED;

   get set 略 

编写全局异常控制器并对自定义异常做处理

@ControllerAdvice

public class GlobalExceptionHandler {

     private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

@ExceptionHandler(value = MyException.class)

@ResponseBody

public Response<String> myExceptionErrorHandler(MyException ex) throws Exception {

    logger.error("myExceptionErrorHandler info:{}",ex.getMessage());

    Response<String> r = new Response<>();

    r.setMsg(ex.getMsg());

    r.setCode(ex.getCode());

    return r;

}

编写controller模拟抛出业务异常

@RestController

@RequestMapping("/user")

public class UserController {

@PostMapping(value = "/update")

Response<Boolean> update(User user){

    //todo 此处为模拟异常抛出

    if(true){

        throw new MyException("更新失败");

    }

    //todo 此处为模拟返回

    Response<Boolean> response = new Response<>();

    response.setCode(Code.SUCCESSED);

    response.setResult(true);

    return  response;

}

}

postMan模拟请求接口,进行验证

数据绑定异常处理

通常我们操作数据的时候,不仅前端需要进行数据校验,后端也应当进行拦截和进行相应的错误提示,JSR-303校验框架也是我们的一种选择。

编写实体`User`,并对属性进行注解控制

public class User {

    @NotNull(message = "用户名不能为空")

    private String userName;

    private  int age;

   //...

全局异常控制类加入拦截

@ControllerAdvice

public class GlobalExceptionHandler {

     private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

     @ExceptionHandler(value = BindException.class)

     @ResponseBody

     public Response<String> bindExceptionErrorHandler(BindException ex) throws Exception {

          logger.error("bindExceptionErrorHandler info:{}",ex.getMessage());

          Response<String> r = new Response<>();

          StringBuilder sb = new StringBuilder();

          FieldError fieldError = ex.getFieldError();

          sb.append(fieldError.getDefaultMessage());

          r.setMsg(sb.toString());

          r.setCode(Code.FAILED);

          return r;

     }

  //...

编写控制器

@RestController

@RequestMapping("/user")

public class UserController {

    @PostMapping(value = "/add")

    Response<User> add(@Validated User user){

        //todo 此处为模拟返回

        Response<User> response = new Response<>();

        response.setCode(Code.SUCCESSED);

        response.setResult(new User());

        return  response;

    }

  //...

postMan模拟请求

不填写任何属性,模拟添加操作,准确进行拦截和报错

项目结构预览:

结尾

适合的才是最好的,每个团队都应摸索出自己的一套异常解决方案,本文所提仅针对业务异常,希望大家也能有所收获

欢迎工作一到五年的Java工程师朋友们加入Java程序员开发: 854393687

群内提供免费的Java架构学习资料(里面有高可用、高并发、高性能及分布式、Jvm性能调优、Spring源码,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多个知识点的架构资料)合理利用自己每一分每一秒的时间来学习提升自己,不要再用"没有时间“来掩饰自己思想上的懒惰!趁年轻,使劲拼,给未来的自己一个交代!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,492评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,048评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,927评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,293评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,309评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,024评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,638评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,546评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,073评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,188评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,321评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,998评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,678评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,186评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,303评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,663评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,330评论 2 358

推荐阅读更多精彩内容