Spring统一异常处理

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注解表示将返回的内容写在响应体中,方法体中的操作是获取异常信息并拼接放在响应体中。

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