🧑🎓 个人主页:Silence Lamb]
📖 本章内容:【统一异常处理-全局异常】
1️⃣统一返回实体定义
/**
* Author: 花棉袄
* CreateDate: 2022年08月23日
* Describe: 统一返回实体定义
*/
public class AjaxResult extends HashMap<String, Object>
{
private static final long serialVersionUID = 1L;
/** 状态码 */
public static final String CODE_TAG = "code";
/** 返回内容 */
public static final String MSG_TAG = "msg";
/** 数据对象 */
public static final String DATA_TAG = "data";
/**
* 初始化一个新创建的 AjaxResult 对象,使其表示一个空消息。
*/
public AjaxResult()
{
}
/**
* 初始化一个新创建的 AjaxResult 对象
*
* @param code 状态码
* @param msg 返回内容
*/
public AjaxResult(int code, String msg)
{
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
}
/**
* 初始化一个新创建的 AjaxResult 对象
*
* @param code 状态码
* @param msg 返回内容
* @param data 数据对象
*/
public AjaxResult(int code, String msg, Object data)
{
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
if (StringUtils.isNotNull(data))
{
super.put(DATA_TAG, data);
}
}
/**
* 返回成功消息
*
* @return 成功消息
*/
public static AjaxResult success()
{
return AjaxResult.success("操作成功");
}
/**
* 返回成功数据
*
* @return 成功消息
*/
public static AjaxResult success(Object data)
{
return AjaxResult.success("操作成功", data);
}
/**
* 返回成功消息
*
* @param msg 返回内容
* @return 成功消息
*/
public static AjaxResult success(String msg)
{
return AjaxResult.success(msg, null);
}
/**
* 返回成功消息
*
* @param msg 返回内容
* @param data 数据对象
* @return 成功消息
*/
public static AjaxResult success(String msg, Object data)
{
return new AjaxResult(HTTPCodeMessage.SUCCESS.getCode(), msg, data);
}
/**
* 返回错误消息
*
* @return
*/
public static AjaxResult error()
{
return AjaxResult.error("操作失败");
}
/**
* 返回错误消息
*
* @param msg 返回内容
* @return 警告消息
*/
public static AjaxResult error(String msg)
{
return AjaxResult.error(msg, null);
}
/**
* 返回错误消息
*
* @param msg 返回内容
* @param data 数据对象
* @return 警告消息
*/
public static AjaxResult error(String msg, Object data)
{
return new AjaxResult(HTTPCodeMessage.ERROR.getCode(), msg, data);
}
/**
* 返回错误消息
*
* @param code 状态码
* @param msg 返回内容
* @return 警告消息
*/
public static AjaxResult error(int code, String msg)
{
return new AjaxResult(code, msg, null);
}
public static AjaxResult error(int code, String msg ,Object data)
{
return new AjaxResult(code, msg, data);
}
/**
* 方便链式调用
*
* @param key 键
* @param value 值
* @return 数据对象
*/
@Override
public AjaxResult put(String key, Object value)
{
super.put(key, value);
return this;
}
}
2️⃣字符串工具类
/**
* Author: 花棉袄
* Date: 2022年08月20日
* Describe: 字符串工具类
*/
public class StringUtils extends org.apache.commons.lang3.StringUtils {
/**
* 空字符串
*/
private static final String NULLSTR = "";
/**
* 下划线
*/
private static final char SEPARATOR = '_';
/**
* 获取参数不为空值
*
* @param value defaultValue 要判断的value
* @return value 返回值
*/
public static <T> T nvl(T value, T defaultValue) {
return value != null ? value : defaultValue;
}
/**
* * 判断一个Collection是否为空, 包含List,Set,Queue
*
* @param coll 要判断的Collection
* @return true:为空 false:非空
*/
public static boolean isEmpty(Collection<?> coll) {
return isNull(coll) || coll.isEmpty();
}
/**
* * 判断一个Collection是否非空,包含List,Set,Queue
*
* @param coll 要判断的Collection
* @return true:非空 false:空
*/
public static boolean isNotEmpty(Collection<?> coll) {
return !isEmpty(coll);
}
/**
* * 判断一个对象数组是否为空
*
* @param objects 要判断的对象数组
* * @return true:为空 false:非空
*/
public static boolean isEmpty(Object[] objects) {
return isNull(objects) || (objects.length == 0);
}
/**
* * 判断一个对象数组是否非空
*
* @param objects 要判断的对象数组
* @return true:非空 false:空
*/
public static boolean isNotEmpty(Object[] objects) {
return !isEmpty(objects);
}
/**
* * 判断一个Map是否为空
*
* @param map 要判断的Map
* @return true:为空 false:非空
*/
public static boolean isEmpty(Map<?, ?> map) {
return isNull(map) || map.isEmpty();
}
/**
* * 判断一个Map是否为空
*
* @param map 要判断的Map
* @return true:非空 false:空
*/
public static boolean isNotEmpty(Map<?, ?> map) {
return !isEmpty(map);
}
/**
* * 判断一个字符串是否为空串
*
* @param str String
* @return true:为空 false:非空
*/
public static boolean isEmpty(String str) {
return isNull(str) || NULLSTR.equals(str.trim());
}
/**
* * 判断一个字符串是否为非空串
*
* @param str String
* @return true:非空串 false:空串
*/
public static boolean isNotEmpty(String str) {
return !isEmpty(str);
}
/**
* * 判断一个对象是否为空
*
* @param object Object
* @return true:为空 false:非空
*/
public static boolean isNull(Object object) {
return object == null;
}
/**
* * 判断一个对象是否非空
*
* @param object Object
* @return true:非空 false:空
*/
public static boolean isNotNull(Object object) {
return !isNull(object);
}
/**
* * 判断一个对象是否是数组类型(Java基本型别的数组)
*
* @param object 对象
* @return true:是数组 false:不是数组
*/
public static boolean isArray(Object object) {
return isNotNull(object) && object.getClass().isArray();
}
/**
* 去空格
*/
public static String trim(String str) {
return (str == null ? "" : str.trim());
}
/**
* 截取字符串
*
* @param str 字符串
* @param start 开始
* @return 结果
*/
public static String substring(final String str, int start) {
if (str == null) {
return NULLSTR;
}
if (start < 0) {
start = str.length() + start;
}
if (start < 0) {
start = 0;
}
if (start > str.length()) {
return NULLSTR;
}
return str.substring(start);
}
/**
* 截取字符串
*
* @param str 字符串
* @param start 开始
* @param end 结束
* @return 结果
*/
public static String substring(final String str, int start, int end) {
if (str == null) {
return NULLSTR;
}
if (end < 0) {
end = str.length() + end;
}
if (start < 0) {
start = str.length() + start;
}
if (end > str.length()) {
end = str.length();
}
if (start > end) {
return NULLSTR;
}
if (start < 0) {
start = 0;
}
if (end < 0) {
end = 0;
}
return str.substring(start, end);
}
/**
* 格式化文本, {} 表示占位符<br>
* 此方法只是简单将占位符 {} 按照顺序替换为参数<br>
* 如果想输出 {} 使用 \\转义 { 即可,如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可<br>
* 例:<br>
* 通常使用:format("this is {} for {}", "a", "b") -> this is a for b<br>
* 转义{}: format("this is \\{} for {}", "a", "b") -> this is \{} for a<br>
* 转义\: format("this is \\\\{} for {}", "a", "b") -> this is \a for b<br>
*
* @param template 文本模板,被替换的部分用 {} 表示
* @param params 参数值
* @return 格式化后的文本
*/
public static String format(String template, Object... params) {
if (isEmpty(params) || isEmpty(template)) {
return template;
}
return StringFormatter.format(template, params);
}
/**
* 是否为http(s)://开头
*
* @param link 链接
* @return 结果
*/
public static boolean isHttp(String link) {
return StringUtils.startsWithAny(link, HTTP, HTTPS);
}
/**
* 字符串转set
*
* @param str 字符串
* @param sep 分隔符
* @return set集合
*/
public static final Set<String> str2Set(String str, String sep) {
return new HashSet<String>(str2List(str, sep, true, false));
}
/**
* 字符串转list
*
* @param str 字符串
* @param sep 分隔符
* @param filterBlank 过滤纯空白
* @param trim 去掉首尾空白
* @return list集合
*/
public static final List<String> str2List(String str, String sep, boolean filterBlank, boolean trim) {
List<String> list = new ArrayList<String>();
if (StringUtils.isEmpty(str)) {
return list;
}
// 过滤空白字符串
if (filterBlank && StringUtils.isBlank(str)) {
return list;
}
String[] split = str.split(sep);
for (String string : split) {
if (filterBlank && StringUtils.isBlank(string)) {
continue;
}
if (trim) {
string = string.trim();
}
list.add(string);
}
return list;
}
/**
* 查找指定字符串是否包含指定字符串列表中的任意一个字符串同时串忽略大小写
*
* @param cs 指定字符串
* @param searchCharSequences 需要检查的字符串数组
* @return 是否包含任意一个字符串
*/
public static boolean containsAnyIgnoreCase(CharSequence cs, CharSequence... searchCharSequences) {
if (isEmpty(cs) || isEmpty(searchCharSequences)) {
return false;
}
for (CharSequence testStr : searchCharSequences) {
if (containsIgnoreCase(cs, testStr)) {
return true;
}
}
return false;
}
/**
* 驼峰转下划线命名
*/
public static String toUnderScoreCase(String str) {
if (str == null) {
return null;
}
StringBuilder sb = new StringBuilder();
// 前置字符是否大写
boolean preCharIsUpperCase = true;
// 当前字符是否大写
boolean curreCharIsUpperCase = true;
// 下一字符是否大写
boolean nexteCharIsUpperCase = true;
for (int i = 0; i < str.length(); i++) {
char c = str.charAt(i);
if (i > 0) {
preCharIsUpperCase = Character.isUpperCase(str.charAt(i - 1));
} else {
preCharIsUpperCase = false;
}
curreCharIsUpperCase = Character.isUpperCase(c);
if (i < (str.length() - 1)) {
nexteCharIsUpperCase = Character.isUpperCase(str.charAt(i + 1));
}
if (preCharIsUpperCase && curreCharIsUpperCase && !nexteCharIsUpperCase) {
sb.append(SEPARATOR);
} else if ((i != 0 && !preCharIsUpperCase) && curreCharIsUpperCase) {
sb.append(SEPARATOR);
}
sb.append(Character.toLowerCase(c));
}
return sb.toString();
}
/**
* 是否包含字符串
*
* @param str 验证字符串
* @param strs 字符串组
* @return 包含返回true
*/
public static boolean inStringIgnoreCase(String str, String... strs) {
if (str != null && strs != null) {
for (String s : strs) {
if (str.equalsIgnoreCase(trim(s))) {
return true;
}
}
}
return false;
}
/**
* 将下划线大写方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空,则返回空字符串。 例如:HELLO_WORLD->HelloWorld
*
* @param name 转换前的下划线大写方式命名的字符串
* @return 转换后的驼峰式命名的字符串
*/
public static String convertToCamelCase(String name) {
StringBuilder result = new StringBuilder();
// 快速检查
if (name == null || name.isEmpty()) {
// 没必要转换
return "";
} else if (!name.contains("_")) {
// 不含下划线,仅将首字母大写
return name.substring(0, 1).toUpperCase() + name.substring(1);
}
// 用下划线将原始字符串分割
String[] camels = name.split("_");
for (String camel : camels) {
// 跳过原始字符串中开头、结尾的下换线或双重下划线
if (camel.isEmpty()) {
continue;
}
// 首字母大写
result.append(camel.substring(0, 1).toUpperCase());
result.append(camel.substring(1).toLowerCase());
}
return result.toString();
}
/**
* 驼峰式命名法 例如:user_name->userName
*/
public static String toCamelCase(String s) {
if (s == null) {
return null;
}
s = s.toLowerCase();
StringBuilder sb = new StringBuilder(s.length());
boolean upperCase = false;
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (c == SEPARATOR) {
upperCase = true;
} else if (upperCase) {
sb.append(Character.toUpperCase(c));
upperCase = false;
} else {
sb.append(c);
}
}
return sb.toString();
}
/**
* 查找指定字符串是否匹配指定字符串列表中的任意一个字符串
*
* @param str 指定字符串
* @param strs 需要检查的字符串数组
* @return 是否匹配
*/
public static boolean matches(String str, List<String> strs) {
if (isEmpty(str) || isEmpty(strs)) {
return false;
}
for (String pattern : strs) {
if (isMatch(pattern, str)) {
return true;
}
}
return false;
}
/**
* 判断url是否与规则配置:
* ? 表示单个字符;
* * 表示一层路径内的任意字符串,不可跨层级;
* ** 表示任意层路径;
*
* @param pattern 匹配规则
* @param url 需要匹配的url
* @return
*/
public static boolean isMatch(String pattern, String url) {
AntPathMatcher matcher = new AntPathMatcher();
return matcher.match(pattern, url);
}
@SuppressWarnings("unchecked")
public static <T> T cast(Object obj) {
return (T) obj;
}
/**
* 数字左边补齐0,使之达到指定长度。注意,如果数字转换为字符串后,长度大于size,则只保留 最后size个字符。
*
* @param num 数字对象
* @param size 字符串指定长度
* @return 返回数字的字符串格式,该字符串为指定长度。
*/
public static final String padl(final Number num, final int size) {
return padl(num.toString(), size, '0');
}
/**
* 字符串左补齐。如果原始字符串s长度大于size,则只保留最后size个字符。
*
* @param s 原始字符串
* @param size 字符串指定长度
* @param c 用于补齐的字符
* @return 返回指定长度的字符串,由原字符串左补齐或截取得到。
*/
public static final String padl(final String s, final int size, final char c) {
final StringBuilder sb = new StringBuilder(size);
if (s != null) {
final int len = s.length();
if (s.length() <= size) {
for (int i = size - len; i > 0; i--) {
sb.append(c);
}
sb.append(s);
} else {
return s.substring(len - size, len);
}
} else {
for (int i = size; i > 0; i--) {
sb.append(c);
}
}
return sb.toString();
}
}
3️⃣返回值状态码信息
/**
* Author: 花棉袄
* CreateDate: 2022年08月22日
* Describe: 返回状态码信息
*/
public enum HTTPCodeMessage {
/**
* 2XX
*/
SUCCESS(200, "操作成功!"),
/**
* 3xx
*/
MOVED_PERM(301, "资源已被移除"),
SEE_OTHER(303, "重定向"),
NOT_MODIFIED(304, "资源没有被修改"),
/**
* 4XX
*/
BAD_REQUEST(400, "错误的请求"),
UNAUTHORIZED(401, "没有权限,要求用户的身份认证"),
PAYMENT_REQUIRED(402, "Payment Required"),
FORBIDDEN(403, "访问受限,授权过期"),
NOT_FOUND(404, "Not Found"),
METHOD_NOT_ALLOWED(405, "不允许的方法"),
NOT_ACCEPTABLE(406, "Not Acceptable"),
PROXY_AUTHENTICATION_REQUIRED(407, "需要代理身份验证"),
REQUEST_TIMEOUT(408, "Request Timeout"),
CONFLICT(409, "资源冲突"),
GONE(410, "资源已经不存在(过去存在)"),
LENGTH_REQUIRED(411, "Length Required"),
PRECONDITION_FAILED(412, "前提条件失败"),
PAYLOAD_TOO_LARGE(413, "有效载荷太大"),
REQUEST_ENTITY_TOO_LARGE(413, "请求的实体太大"),
URI_TOO_LONG(414, "URI 太长"),
REQUEST_URI_TOO_LONG(414, "请求 URI 太长"),
UNSUPPORTED_MEDIA_TYPE(415, "不支持的媒体类型"),
REQUESTED_RANGE_NOT_SATISFIABLE(416, "请求的范围不满足"),
EXPECTATION_FAILED(417, "预期失败"),
I_AM_A_TEAPOT(418, "I'm a teapot"),
INSUFFICIENT_SPACE_ON_RESOURCE(419, "资源空间不足"),
METHOD_FAILURE(420, "方法失败"),
DESTINATION_LOCKED(421, "Destination Locked"),
UNPROCESSABLE_ENTITY(422, "无法处理的实体"),
LOCKED(423, "Locked"),
FAILED_DEPENDENCY(424, "Failed Dependency"),
TOO_EARLY(425, "Too Early"),
UPGRADE_REQUIRED(426, "Upgrade Required"),
PRECONDITION_REQUIRED(428, "Precondition Required"),
TOO_MANY_REQUESTS(429, "Too Many Requests"),
REQUEST_HEADER_FIELDS_TOO_LARGE(431, "Request Header Fields Too Large"),
UNAVAILABLE_FOR_LEGAL_REASONS(451, "Unavailable For Legal Reasons"),
/**
* 5XX
*/
SYSTEM_EXCEPTION(500, "系统异常!"),
SYSTEM_RUN_EXCEPTION(501, "未知的运行时异常"),
CUSTOM_EXCEPTION(502, "自定义异常"),
SERVICE_UNAVAILABLE(503, "系统繁忙,请稍后重试!"),
NOT_IMPLEMENTED(504, "接口未实现"),
SERVICE_EXCEPTION(505, "自定义业务异常"),
PARAMETER_BINDING_EXCEPTION(506, "请求参数绑定异常"),
PARAMETER_FORMAT_EXCEPTION(507, "类型不匹配异常"),
Http_Message_Conversion_Exception(508, "Http消息不可读异常"),
DATA_ACCESS_EXCEPTION(509, "数据访问异常");
private String message;
private int code;
HTTPCodeMessage(int code, String message) {
this.message = message;
this.code = code;
}
public String getMessage() {
return message;
}
public int getCode() {
return code;
}
}
4️⃣读取异常工具类
/**
* @Author: 花棉袄
* @CreateDate: 2022年08月24日
* @Describe: 错误信息处理工具类
*/
public class ExceptionUtils {
/**
* 获取exception的详细错误信息
*/
public static String getExceptionMessage(Throwable e)
{
StringWriter sw = new StringWriter();
e.printStackTrace(new PrintWriter(sw, true));
return sw.toString();
}
public static String getRootErrorMessage(Exception e)
{
Throwable root = org.apache.commons.lang3.exception.ExceptionUtils.getRootCause(e);
root = (root == null ? e : root);
if (root == null)
{
return "";
}
String msg = root.getMessage();
if (msg == null)
{
return "null";
}
return StringUtils.defaultString(msg);
}
}
5️⃣全局异常处理器
@RestControllerAdvice
public class GlobalExceptionHandler {
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ApiModelProperty("权限校验异常")
@ExceptionHandler(AccessDeniedException.class)
public AjaxResult handleAccessDeniedException(AccessDeniedException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',权限校验失败:'{}'", requestURI, e.getMessage());
return AjaxResult.error(UNAUTHORIZED.getCode(), UNAUTHORIZED.getMessage())
.put(requestURI, e.getMessage());
}
@ApiModelProperty("请求方式不支持")
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
public AjaxResult handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException e,
HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',不支持'{}'请求", requestURI, e.getMethod());
System.out.println();
return AjaxResult.error(
METHOD_NOT_ALLOWED.getCode(),
METHOD_NOT_ALLOWED.getMessage())
.put("error", "不支持" + e.getMethod() + "请求");
}
@ApiModelProperty("请求参数绑定异常")
@ExceptionHandler(ServletRequestBindingException.class)
public AjaxResult handleMissingServletRequestParameterException(ServletRequestBindingException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',请求参数异常:'{}'.", requestURI, getRootErrorMessage(e));
return AjaxResult.error(
PARAMETER_BINDING_EXCEPTION.getCode(),
PARAMETER_BINDING_EXCEPTION.getMessage()
).put("path", requestURI).put("error", getRootErrorMessage(e));
}
@ApiModelProperty("参数格式不符合要求")
@ExceptionHandler(MethodArgumentTypeMismatchException.class)
public AjaxResult handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',参数格式不符合要求:'{}'.", requestURI, ExceptionUtils.getRootErrorMessage(e));
String[] s = e.getMessage().split(" ");
return AjaxResult.error(
PARAMETER_FORMAT_EXCEPTION.getCode(),
PARAMETER_FORMAT_EXCEPTION.getMessage()
).put("path", requestURI).put("error", "参数类型应该为:" + s[10].split("'")[1]);
}
@ApiModelProperty("Http 消息不可读异常")
@ExceptionHandler(HttpMessageConversionException.class)
public AjaxResult handleHttpMessageNotReadableException(HttpMessageConversionException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',Http消息不可读异常:'{}'.", requestURI, e.getMessage());
return AjaxResult.error(
Http_Message_Conversion_Exception.getCode(),
Http_Message_Conversion_Exception.getMessage()
).put("path", requestURI).put("error", getRootErrorMessage(e));
}
@ApiModelProperty("数据访问异常")
@ExceptionHandler(DataAccessException.class)
public AjaxResult handleMysqlDataTruncation(DataAccessException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',数据访问异常:'{}'.", requestURI, getRootErrorMessage(e));
return AjaxResult.error(
DATA_ACCESS_EXCEPTION.getCode(),
DATA_ACCESS_EXCEPTION.getMessage()
).put("path", requestURI).put("error", getRootErrorMessage(e));
}
@ApiModelProperty("自定义校验异常")
@ExceptionHandler(BindException.class)
public AjaxResult handleValidException(BindException e, HttpServletRequest request) {
log.error("数据校验出现问题:{},异常类型:{}", e.getMessage(), e.getClass());
BindingResult bindingResult = e.getBindingResult();
String requestURI = request.getRequestURI();
Map<String, String> errorMap = new HashMap();
bindingResult.getFieldErrors().forEach((fieldError) -> {
errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
});
return AjaxResult.error(
JSRCodeMessage.CHECK_PARAMETERS_ERROR.getCode(),
JSRCodeMessage.CHECK_PARAMETERS_ERROR.getMessage()
).put("path", requestURI).put("errors", errorMap);
}
@ApiModelProperty("自定义业务异常")
@ExceptionHandler(ServiceException.class)
public AjaxResult handleServiceException(ServiceException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',业务名称:'{}',自定义业务异常:'{}'.", requestURI, e.getName(), e.getClass());
Integer code = e.getCode();
if (StringUtils.isNotNull(code)) {
return AjaxResult.error(code, e.getMessage()).put("name", e.getName());
}
return AjaxResult.error(SERVICE_EXCEPTION.getCode(), e.getMessage()).put("name", e.getName());
}
@ApiModelProperty("未知的运行时异常")
@ExceptionHandler(RuntimeException.class)
public AjaxResult handleRuntimeException(RuntimeException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',拦截未知的运行时异常:'{}'.", requestURI, e);
return AjaxResult.error(
SYSTEM_RUN_EXCEPTION.getCode(),
SYSTEM_RUN_EXCEPTION.getMessage()
).put("ExceptionName", e.getClass()).put("error", getRootErrorMessage(e));
}
@ApiModelProperty("系统未知异常")
@ExceptionHandler(Exception.class)
public AjaxResult handleException(Exception e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址:'{}',系统未知异常:'{}'.", requestURI, e);
return AjaxResult.error(
SYSTEM_EXCEPTION.getCode(),
SYSTEM_EXCEPTION.getMessage()
).put("ExceptionName", e.getClass()).put("path", requestURI).put("error", getRootErrorMessage(e));
}
}
6️⃣自定义异常
🌳 创建自定义业务异常
/**
* Author: 花棉袄
* Date: 2022年08月20日
* Describe: 自定义业务异常
*/
public final class ServiceException extends RuntimeException {
private static final long serialVersionUID = 1L;
@ApiModelProperty("业务名称")
private String name;
@ApiModelProperty("错误码")
private Integer code;
@ApiModelProperty("错误提示")
private String message;
@ApiModelProperty("错误明细,内部调试错误")
private String detailMessage;
public ServiceException() {
}
public ServiceException(String message) {
this.message = message;
}
public ServiceException(String message, Integer code) {
this.message = message;
this.code = code;
}
public ServiceException(String name, String message, Integer code) {
this.name = name;
this.message = message;
this.code = code;
}
public ServiceException(String name, String message) {
this.name = name;
this.message = message;
}
public String getDetailMessage() {
return detailMessage;
}
public String getName() {
return name;
}
@Override
public String getMessage() {
return message;
}
public Integer getCode() {
return code;
}
public ServiceException setMessage(String message) {
this.message = message;
return this;
}
public ServiceException setDetailMessage(String detailMessage) {
this.detailMessage = detailMessage;
return this;
}
}
🌳 创建自定义异常处理器
@Slf4j
@RestControllerAdvice
public class ServiceExceptionHandler {
@ApiModelProperty("自定义业务异常")
@ExceptionHandler(ServiceException.class)
public AjaxResult handleServiceException(ServiceException e, HttpServletRequest request) {
String requestURI = request.getRequestURI();
log.error("请求地址'{}',业务名称'{}',拦截未知的运行时异常'{}'.", requestURI , e.getName(), e.getMessage());
Integer code = e.getCode();
if (StringUtils.isNotNull(code)) {
return AjaxResult.error(code, e.getMessage()).put("name", e.getName());
}
return AjaxResult.error(SERVICE_EXCEPTION.getCode(), e.getMessage()).put("name", e.getName());
}
}