美文网首页
Spring统一异常处理

Spring统一异常处理

作者: 拼搏男孩 | 来源:发表于2020-08-26 09:17 被阅读0次

    Spring的统一异常处理有两种方式,一种是在某个controller内部进行异常处理,只能处理这个controller方法发生的异常,另外一种是定义一个全局异常处理类。

    1、三个注解的区别

    @NotEmpty 用在集合类上面
    加了@NotEmpty的String类、Collection、Map、数组,是不能为null或者长度为0的(String Collection Map的isEmpty()方法)

    @NotBlank只用于String,不能为null且trim()之后size>0

    @NotNull:不能为null,但可以为empty,没有Size的约束

    2、在一个controller内部进行异常处理

    首先,我们需要指定处理哪种类型的异常,既可以处理自带的异常也可以自己编写一个类继承RuntimeException类。这里以自己编写的异常类为例:

    public abstract class BaseException extends RuntimeException {
        private static final long serialVersionUID = 5162654603282955432L;
        protected String code;
        protected String message;
    
        public BaseException(String msg) {
            super(msg);
        }
    
        public abstract String getCode();
    
        public abstract String getMessage();
    }
    

    这个类也是一个抽象类,下面有很多具体的子类,比如这个:

    public class CustomException extends BaseException {
        public CustomException(String code, String message) {
            super(message);
            this.code = code;
            this.message = message;
        }
    
        public String getCode() {
            return this.code;
        }
    
        public String getMessage() {
            return this.message;
        }
    }
    

    然后在一个controller内部进行异常处理

    public class BaseController {
        Logger logger = LoggerFactory.getLogger(BaseController.class);
    
        @ExceptionHandler(BaseException.class)
        @ResponseStatus(value = HttpStatus.OK)
        public BaseResponse returnValidErr(BaseException ex) throws IOException {
            BaseResponse baseResponse = new BaseResponse();
            baseResponse.setCode(ex.getCode());
            baseResponse.setMessage(ex.getMessage());//
            logger.error("http response, {}", ex);
            return baseResponse;
        }
    
    
    }
    

    @ExceptionHandler注解指定要处理哪种类型的异常,包括其子类。@RepsonseStatus注解指定http响应码。这个类在实际开发过程中可以作为具体controller的父类,这样就不需要在每个controller中都写一遍了。还有就是在想要抛出异常的时候throw CustomException就行了,由于service中的方法抛出的异常最后还是会交由controller进行处理,所以上面的方式也能处理service中抛出的异常。

    3、创建一个单独的异常处理类

    现在需要对前端传过来的参数进行校验,不能为空,如果说自己在业务代码中进行校验的话有点复杂,所以我采用使用注解的方式

    import lombok.Data;
    import lombok.ToString;
    
    import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.NotNull;
    
    @Data
    @ToString
    public class PlaceOrderReq {
        @NotBlank(message = "请输入交易序号")
        private String tradeId;
        @NotBlank(message = "请输入卡号")
        private String cardNo;
        @NotNull(message = "请输入金额")
        private Integer money;
    }
    

    @NotBlank、@NotNull与@NotEmpty这三个注解的作用在上面已经说过了,之前hibernate的包中提供这三个注解,现在javax已经提供了,所以就没必要再用hibernate包的注解了。上面的注解的作用就是不能传入空的交易序号与卡号,也不能不传入金额。注解中指定了message,抛出的异常信息。

    import org.springframework.validation.annotation.Validated;
    public class MyController{
        
        @PostMapping("/interface/placeOrder")
        public BaseResponse placeOrder(@RequestBody @Validated PlaceOrderReq request){
            BaseResponse response = new BaseResponse();
            return response;
        }
    }
    

    @Validated注解加在请求参数上,表示对请求参数进行校验。这个注解是Spring提供的,区别于javax的@Validate注解,提供了更多功能。如果校验异常的话会抛出MethodArgumentNotValidException这个异常,所以只需要在全局异常处理类中对这个异常进行处理就行了。

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.http.HttpStatus;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.ObjectError;
    import org.springframework.web.bind.MethodArgumentNotValidException;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.ResponseStatus;
    
    import java.util.List;
    
    /**
     * @author huwl
     */
    @ControllerAdvice
    public class GlobalExceptionHandler {
        Logger logger = LoggerFactory.getLogger(this.getClass());
        @ExceptionHandler(MethodArgumentNotValidException.class)
        @ResponseStatus(HttpStatus.OK)
        @ResponseBody
        public BaseResponse handlerException(MethodArgumentNotValidException e){
            BindingResult bindingResult = e.getBindingResult();
            List<ObjectError> errors = bindingResult.getAllErrors();
    
            StringBuilder errorMsg=new StringBuilder();
            errors.forEach(x -> errorMsg.append(x.getDefaultMessage()).append(";"));
            logger.error("---MethodArgumentNotValidException Handler--- ERROR: {}", errorMsg.toString());
            return new BaseResponse().setCode(MessConst.PARAM_CHECK_ERR).setMessage(errorMsg.toString());
        }
    }
    

    这个是一个全局异常处理类,@ControllerAdvice表明它会处理所有controller中抛出的异常,如果你自己已经进行处理了就不会再次处理了,@ExceptionHandler注解表示将要处理哪个异常,这里指定的是MethodArgumentNotValidException这个异常,@ResponseBody注解表示将返回的内容写在响应体中,方法体中的操作是获取异常信息并拼接放在响应体中。

    相关文章

      网友评论

          本文标题:Spring统一异常处理

          本文链接:https://www.haomeiwen.com/subject/gecxsktx.html