场景
当我们在处理项目出错的地方的时候(异常处理),往往不能给用户一个友好的提示(状态码、错误信息以及时间),下面我们一起来学习一个通用的自定义异常处理。
一、全局异常处理类
import com.leyou.common.exception.LyException;
import com.leyou.common.vo.ExceptionResult;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class CommonExceptionHandler {
// 自定义异常
@ExceptionHandler(LyException.class)
public ResponseEntity<ExceptionResult> handlerException(LyException e){
return ResponseEntity.status(e.getExceptionEnum().getCode()).body(new ExceptionResult(e.getExceptionEnum()));
}
}
@ControllerAdvice 默认拦截所有的controller类
@ExceptionHandler(LyException.class) 拦截所有的LyException异常
我们可以发现这个异常类可以拦截所有的LyException异常,并且去处理。
ResponseEntity标识整个http相应:状态码、头部信息以及相应体内容。因此我们可以使用其对http响应实现完整配置。所以我们可以通过ResponseEntity来返回状态码和错误信息。
又因为我们在抛出异常的时候需要携带状态码和错误信息给用户,所以把异常信息定义成一个枚举类型,并且将返回结果封装成一个对象,下面通过代码向大家展示。
二、创建枚举
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
@Getter
@NoArgsConstructor
@AllArgsConstructor
public enum ExceptionEnum {
// 类似单例,这相当于new一个对象,枚举的构造方法默认私有
PRICE_CANNOT_BE_NULL("价格不能为空!", 400),
CATEGORY_NOT_FOUND("商品分类没查到", 404),
BRAND_NOT_FOUND("品牌列表不能为空", 404),
BRAND_SAVE_ERROR("品牌保存失败", 500),
UPLOAD_FILE_ERROR("文件下载失败", 500),
INVALID_FILE_TYPE("无效的文件类型", 400)
;
private String msg;
private int code;
}
@Getter 自动注入get方法
@NoArgsConstructor 自动创建无参构造函数
@AllArgsConstructor 自动创建含有所有已声明字段属性参数的构造函数
我们可以把错误提示定义成一个个枚举。
三、自定义异常类
@Getter
@NoArgsConstructor
@AllArgsConstructor
public class LyException extends RuntimeException {
private ExceptionEnum exceptionEnum; //这是一个枚举
}
我们在创建异常对象的时候传入一个枚举就可以了。
四、定义结果类
创建这个类的目的是为了给用户返回一个结构清晰的提示信息
import com.leyou.common.enums.ExceptionEnum;
import lombok.Data;
@Data
public class ExceptionResult {
private int code;
private String msg;
private Long timestamp;
public ExceptionResult(ExceptionEnum em) {
this.code = em.getCode();
this.msg = em.getMsg();
this.timestamp = System.currentTimeMillis();
}
}
这个类包含状态码,错误信息以及时间,就可以向用户清楚的展示异常信息。
五、举例说明
假如我们在处理业务的时候可以抛出LyException异常这个异常将会被异常处理类CommonExceptionHandler的handlerException方法拦截并通过ResponseEntity返回状态码和异常信息。
总结
本文介绍了一个通用的自定义异常处理,这个可以广泛应用在我们的项目中,希望对你有帮助。