一、Spring MVC的统一处理异常机制
在Spring MVC中，存在统一处理异常的机制，
具体表现为：无论是哪个处理请求的过程中出现异常，每种类型的异常只需要编写一段处理异常的代码即可！
统一处理异常的核心是定义处理异常的方法：
- 返回值类型：可参考处理请求的方法
- 方法名称：自定义
- 参数列表：至少包含被处理的异常对象，另外，可按需添加存在多个参数时，各参数不区分先后顺序。
- 注解：必须添加
@ExceptionHandler注解，表示此方法是处理异常的方法
在项目的根包下创建ex.handler.GlobalExceptionHandler类，作为当前项目的“全局异常处理器”类。
在类上添加@RestControllerAdvice注解，此类中特定的方法，将可以作用于整个项目中任何处理请求的过程中！
将统一处理异常的代码编写在此类中（各控制器类中不再需要重复的处理异常的方法）：
例如：
package com.luoyang.small.ex.handler;
import com.luoyang.small.ex.CustomServiceException;
import com.luoyang.small.web.JsonResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
* 统一处理异常
*
* @author luoyang
* @date 2023/12/17
*/
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler
public JsonResult handleServiceException(CustomServiceException e) {
log.warn("统一处理CustomServiceException，异常信息：{}", e.getMessage());
return JsonResult.fail(e);
}
}
二、辅助代码示例
其中对应的CustomServiceException.java
public class CustomServiceException extends RuntimeException {
private ServiceCode serviceCode;
public CustomServiceException(ServiceCode serviceCode, String message) {
super(message);
this.serviceCode = serviceCode;
}
public ServiceCode getServiceCode() {
return serviceCode;
}
}
其中对应的ServiceCode.java
public enum ServiceCode {
OK(200),
ERR_NOT_FOUND(404),
ERR_CONFLICT(409),
ERR_CUSTOM(1000);
// 以下属性，表示每个枚举类型的对象都有一个Integer value属性，此属性的值将通过构造方法传入
private Integer value;
ServiceCode(Integer value) {
this.value = value;
}
// 用于通过枚举对象获取Integer value属性的值
public Integer getValue() {
return value;
}
}
其中对应的JsonResult.java
@Data
@Slf4j
@NoArgsConstructor
@AllArgsConstructor
//@JsonInclude(JsonInclude.Include.NON_NULL) //配置在类上，所以属性为空是都不展示该属性
public class JsonResult implements Serializable {
private Integer code;
private String message;
public static JsonResult ok() {
JsonResult jsonResult = new JsonResult();
jsonResult.setCode(ServiceCode.OK.getValue());
return jsonResult;
}
public static JsonResult fail(ServiceCode serviceCode, String message) {
JsonResult jsonResult = new JsonResult();
jsonResult.setCode(serviceCode.getValue());
jsonResult.setMessage(message);
log.error("JsonResult fail serviceCode {}, message{}", serviceCode, message);
return jsonResult;
}
public static JsonResult fail(CustomServiceException e) {
return fail(e.getServiceCode(), e.getMessage());
}
}
三、异常各处抛出，一个类统一处理
CustomServiceException异常各处抛出，如下：GlobalExceptionHandler.handleServiceException统一处理 ，
当客户端向服务器端提交请求，例如“添加相册”，如果服务器端的控制器中处理请求的方法中调用Service方法时出现异常，但是，处理请求的方法不必对此异常进行处理，例如：
当处理请求的方法不使用try..catch...捕获异常，如果出现异常，相当于此处理请求的方法会抛出异常！
注意：重点就是在自定义全局类（如：GlobalExceptionHandler）上添加@RestControllerAdvice注解，此类中特定的方法（例如handleServiceException(CustomServiceException e) 统一处理异常的方法）将可以作用于整个项目中任何处理请求的过程中！
创造价值，乐哉分享！
一起入门后端 204146007
