SpringBoot 中的全局异常处理主要起作用的两个注解是 @ControllerAdvice 和 @ExceptionHandler ,其中 @ControllerAdvice 是组件注解,添加了这个注解的类能够拦截 Controller 的请求,而 ExceptionHandler 注解可以设置全局处理控制里的异常类型来拦截要处理的异常。
<dependencies>
<!-- JPA 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- web 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql 连接类 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- lombok 依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- 单元测试依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
public class Message<T> implements Serializable {
/**
* 状态码
*/
private Integer code;
/**
* 返回信息
*/
private String message;
/**
* 返回的数据类
*/
private T data;
/**
* 时间
*/
private Long time;
// getter、setter 以及 构造方法略。。。
}
public class MessageUtil {
/**
* 成功并返回数据实体类
* @param o
* @param <E>
* @return
*/
public static <E>Message<E> ok(E o){
return new Message<>(200, "success", o, new Date().getTime());
}
/**
* 成功,但无数据实体类返回
* @return
*/
public static <E>Message<E> ok(){
return new Message<>(200, "success", null, new Date().getTime());
}
/**
* 失败,有自定义异常返回
* @param code
* @param msg
* @return
*/
public static <E>Message<E> error(Integer code,String msg){
return new Message<>(code, msg, null, new Date().getTime());
}
}
public class CustomException extends RuntimeException{
/**
* 状态码
*/
private Integer code;
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public CustomException(Integer code, String message){
super(message);
this.code = code;
}
}
@RestControllerAdvice // 控制器增强处理(返回 JSON 格式数据),添加了这个注解的类能被 classpath 扫描自动发现
public class ExceptionHandle {
@ExceptionHandler(value = Exception.class) // 捕获 Controller 中抛出的指定类型的异常,也可以指定其他异常
public <E>Message<E> handler(Exception exception){
if (exception instanceof CustomException){
CustomException customException = (CustomException) exception;
return MessageUtil.error(customException.getCode(), customException.getMessage());
} else {
return MessageUtil.error(120, "异常信息:" + exception.getMessage());
}
}
}
@RestController
@RequestMapping("/student")
public class StudentController {
@Autowired
private StudentService studentService;
@GetMapping("/{id}")
public Message<Student> findStudentById(@PathVariable("id") Integer id){
if (id < 0){
//测试自定义错误
throw new CustomException(110, "参数不能是负数!");
} else if (id == 0){
//硬编码,为了测试
Integer i = 1/id;
return null;
} else {
Student student = studentService.findStudentById(id);
return MessageUtil.ok(student);
}
}
}