Spring Boot中通用异常处理

系统管理员 2022-11-21 14:43 250阅读 0赞

# Spring Boot中通用异常处理 #

--------------------

## 一、引入 ##

*  在前后台交互数据过程中会因为数据不当根具具体情况给页面返回相对友好的信息。

--------------------

## 二、流程 ##

*  实体类

@Data
    public class Item {
        
        private Integer id;
        private String name;
        private Long price;
    }

*  自定义异常处理

/**
    * 继承java的RuntimeException异常
    */
    @NoArgsConstructor
    @AllArgsConstructor
    @Getter
    public class LyException extends RuntimeException{
        
        private ExceptionEnum exceptionEnum;
    }

*  模拟业务层：

public Item saveItem(Item item){
        
            //新增商品  Random随机生成一个id
            int id = new Random().nextInt(100);
            item.setId(id);
            return item;
        }

*  web层

@RestController
    @RequestMapping("item")
    public class ItemController {
        
        @Autowired
        private ItemService itemService;
        /**
         * 返回状态码ResponseEntity
         * @param item
         * @return
         */
        @PostMapping
        public ResponseEntity<Item> saveItem(Item item){
        
            //校验价格是否为空
            if (item.getPrice() == null){
        
                //通用异常处理   把异常拦截下来处理
                //需要传两个参数 -->  状态码和消息  但是这里不能传字符串
                //所以可以传一个枚举来代替 -->  PRICE_CANNOT_BE_NULL这个就将状态码和异常信息都传给力通用异常处理器
                throw new LyException(ExceptionEnum.PRICE_CANNOT_BE_NULL);
            }
            item = itemService.saveItem(item);
            //返回状态码.status(HttpStatus.CREATED)就是201，.body(item)结果
            return ResponseEntity.status(HttpStatus.CREATED).body(item);
        }
    }

*  定义所需要的枚举

@Getter
    @NoArgsConstructor
    @AllArgsConstructor
    public enum ExceptionEnum {
        
    	//枚举中定义好状态码和异常信息
        PRICE_CANNOT_BE_NULL(400,"价格不能为空!"),
        ;
        //状态码和异常信息
        private int code;
        private String msg;
    }

*  编写异常结果实体类

@Data
    public class ExceptionResult {
        
        private int status;    //状态码
        private String message; //异常信息
        private Long timestamp;   //时间戳
        //接收枚举
        public ExceptionResult(ExceptionEnum em) {
        
            this.status = em.getCode();
            this.message = em.getMsg();
            this.timestamp = System.currentTimeMillis();
        }
    }

*  通用异常处理

@ControllerAdvice
    public class CommonExceptionHandler {
        
        /**
         * 拦截下异常
         * 返回枚举中设置的异常信息
         * @param e
         * @return
         */
        @ExceptionHandler(LyException.class)
        public ResponseEntity<ExceptionResult> handleRxception(LyException e){
        
            //获取传来的枚举
            ExceptionEnum em = e.getExceptionEnum();
            //分别从枚举中取出状态码和参数显示到页面上
            return ResponseEntity.status(e.getExceptionEnum().getCode())
                    .body(new ExceptionResult(e.getExceptionEnum()));
        }
    }

--------------------

## 三、结果 ##

--------------------

*  正常显示  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gxNTgzNTE2MTI1MA_size_16_color_FFFFFF_t_70_pic_center]
 *  当价格值不正常时  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gxNTgzNTE2MTI1MA_size_16_color_FFFFFF_t_70_pic_center 1]  
    状态码为400，返回错误信息为"价格不能为空!"，这样的处理信息更为友好可控。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gxNTgzNTE2MTI1MA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/d0935fb4a1ca4ba98e337d48a9a60baa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gxNTgzNTE2MTI1MA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/22a204b6b41e4365917013b2dc26c773.png