Spring Boot統一異常處理方案示例

一、異常處理的原則

1、調用方法的時候返回布爾值來代替返回null，這樣可以 NullPointerException。由於空指針是java異常里最惡心的異常。

2、 catch塊里別不寫代碼。空catch塊是異常處理里的錯誤事件，因為它只是捕獲了異常，卻沒有任何處理或者提示。通常你起碼要打印出異常信息，當然你最好根據需求對異常信息進行處理。

3、能拋受控異常（checked Exception）就盡量不拋受非控異常(unchecked Exception[Error或者RuntimeException的異常])。通過去掉重復的異常處理代碼，可以提高代碼的可讀性。

4、 絕對不要讓你的數據庫相關異常顯示到客戶端。由於絕大多數數據庫和SQLException異常都是受控異常，在Java中，你應該在DAO層把異常信息處理，然后返回處理過的能讓用戶看懂並根據異常提示信息改正操作的異常信息。

5、 在Java中，一定要在數據庫連接，數據庫查詢，流處理后，在finally塊中調用close()方法。

二、示例說明

本示例以“前后端分離模式”進行演示，調試用的異常信息通過日志的形式打印出來，代碼並不完整，僅從異常處理進行部分代碼示例。

1、創建異常類

@Getter //通過lombok插件實現省寫setter或者getter方法
public class SellException extends RuntimeException {

    private Integer code;
    private String message;

    public SellException(ResultEnum resultEnum) {
        super(resultEnum.getMessage());
        this.code = resultEnum.getCode();
    }

    public SellException(Integer code,String message) {
        this.code = code;
        this.message = message;
    }
}

2、使用Handler類捕獲異常，統一格式返回給前端

@ControllerAdvice
public class SellExceptionHandler {

    @ExceptionHandler(value = SellException.class)
    @ResponseBody
    public ResultVO handlerSellerException(SellException e){
        return ResultVOUtil.error(e.getCode(),e.getMessage());  8     }

}

　　統一格式類：

public class ResultVOUtil {

    public static ResultVO success(Object object) {
        ResultVO resultVO = new ResultVO();
        resultVO.setData(object);
        resultVO.setCode(0);
        resultVO.setMsg("成功");
        return resultVO;
    }

    public static ResultVO success() {
        return success(null);
    }

    public static ResultVO error(Integer code,String msg) {
        ResultVO resultVO = new ResultVO(); 17  resultVO.setCode(code); 18  resultVO.setMsg(msg); 19         return resultVO; 20     }

}

@Data
public class ResultVO<T> implements Serializable{

    private static final long serialVersionUID = 8960474786737581150L;

    /**
     * 錯誤碼
     */
    private Integer code;
    /**
     *提示信息
     */
    private String msg;
    /**
     * 具體內容
     */
    private T data;

}

3、異常的信息通過枚舉統一定義，方便定義管理

@Getter
public enum ResultEnum {

    SUCCESS(0,"成功"),

    PARAM_ERROR(1,"參數不正確"),

    PRODUCT_NOT_EXIST(10,"商品不存在"),

    PRODUCT_STOCK_ERROR(11,"商品庫存不正確"),

    ORDER_NOT_EXIST(12,"訂單不存在"),

    ORDERDETAIL_NOT_EXIST(13,"訂單詳情不存在"),

    ORDER_STATUS_ERROR(14,"訂單狀態不正確"),

    ORDER_UPDATE_FAIL(15,"訂單更新失敗"),

    ORDER_DETAIL_EMPTY(16,"訂單詳情為空"),

    CART_EMPTY(18,"購物車為空"),

    ORDER_OWNER_ERROR(19,"該訂單不屬於當前用戶"),
    ;

    private Integer code;
    private String message;

    ResultEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

}

4、使用異常類

① controller層處理頁面傳來參數的校驗，如參數不正確，拋出自定義異常，由handler捕獲返回給頁面。

@RestController
@RequestMapping("/buyer/order")
@Slf4j
public class BuyerOrderController {

    @Autowired
    private OrderService orderService;

    @Autowired
    private BuyerService buyerService;

    //創建訂單
    @PostMapping("/create")
    public ResultVO<Map<String,String>> create(@Valid OrderForm orderForm,
                                               BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            log.error("[創建訂單] 參數不正確,orderForm={}",orderForm);
            throw new SellException(ResultEnum.PARAM_ERROR.getCode(),
                    bindingResult.getFieldError().getDefaultMessage());
        }
        OrderDTO orderDTO = OrderForm2OrderDTOConverter.convert(orderForm);
        if (CollectionUtils.isEmpty(orderDTO.getOrderDetailList())){
            log.error("[創建訂單] 購物不能為空"); 24             throw new SellException(ResultEnum.CART_EMPTY); 25         }

        OrderDTO createResult = orderService.create(orderDTO);
        Map<String,String> map = new HashMap<>();
        map.put("orderId",createResult.getOrderId());

        return ResultVOUtil.success(map);

    }
    //訂單列表
    @GetMapping("/list")
    public ResultVO<List<OrderDTO>> list(@RequestParam("openid") String openid,
                                         @RequestParam(value = "page",defaultValue = "0") Integer page,
                                         @RequestParam(value = "size",defaultValue = "10") Integer size){
        if (StringUtils.isEmpty(openid)){
            log.error("[查詢訂單列表] openid為空");
            throw new SellException(ResultEnum.PARAM_ERROR);
        }
        PageRequest request = new PageRequest(page, size);
        Page<OrderDTO> orderDTOPage = orderService.findList(openid, request);

        return ResultVOUtil.success(orderDTOPage.getContent());
    }

    //訂單詳情
    @GetMapping("/detail")
    public ResultVO<OrderDTO> detail(@RequestParam("openid") String openid,
                                     @RequestParam("orderId") String orderId){

        OrderDTO orderDTO = buyerService.findOrderOne(openid, orderId);
        return ResultVOUtil.success(orderDTO);
    }

    //取消訂單
    @PostMapping("/cancel")
    public ResultVO<OrderDTO> cancel(@RequestParam("openid") String openid,
                                     @RequestParam("orderId") String orderId) {

        buyerService.cancelOrderOne(openid, orderId);
        return ResultVOUtil.success();
    }
}

② service處理返回的結果的異常，拋出自定義異常，由handler捕獲返回給頁面。

@Service
@Slf4j
public class BuyerServiceImpl implements BuyerService {

    @Autowired
    private OrderService orderService;

    @Override
    public OrderDTO findOrderOne(String openid, String orderId) {
       return checkOrderOwner(openid, orderId);
    }

    @Override
    public OrderDTO cancelOrderOne(String openid, String orderId) {
        OrderDTO orderDTO = checkOrderOwner(openid, orderId);
        if (orderDTO == null){
            log.error("[取消訂單] 查不到該訂單,orderDTO={}",orderId); 18             throw new SellException(ResultEnum.ORDER_NOT_EXIST); 19         }
        return orderService.cancel(orderDTO);
    }

    private OrderDTO checkOrderOwner(String openid, String orderId) {
        OrderDTO orderDTO = orderService.findOne(orderId);
        if (orderDTO == null){
            return null;
        }
        if (!orderDTO.getBuyerOpenid().equalsIgnoreCase(openid)){
            log.error("[查詢訂單] 訂單的openid不一致,openid={},orderDTO={}",openid,orderDTO);
            throw new SellException(ResultEnum.ORDER_OWNER_ERROR);
        }
        return orderDTO;
    }

}