root/ludu-cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

完善 Dubbo Provider 统一异常过滤器

Browse Source
This commit is contained in:
YunaiV 2020-07-17 20:59:47 +08:00
parent e3f2e15c43
commit c5596919f5
3 changed files with 42 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
common/common-framework/src/main/java/cn/iocoder/common/framework/exception/ServiceException.java
View File

@ -1,5 +1,7 @@
package cn.iocoder.common.framework.exception;
import cn.iocoder.common.framework.vo.CommonResult;
/**
* 服务异常
*
@ -33,6 +35,12 @@ public final class ServiceException extends RuntimeException {
* 错误码
*/
private final Integer code;
/**
* 错误明细，内部调试错误
*
* 和 {@link CommonResult#getDetailMessage()} 一致的设计
*/
private String detailMessage;
public ServiceException(Integer code, String message) {
super(message);
@ -43,6 +51,13 @@ public final class ServiceException extends RuntimeException {
return code;
}
public String getDetailMessage() {
return detailMessage;
}
public ServiceException setDetailMessage(String detailMessage) {
this.detailMessage = detailMessage;
return this;
}
}

56
common/mall-spring-boot-starter-dubbo/src/main/java/cn/iocoder/mall/dubbo/core/filter/DubboProviderExceptionFilter.java
View File

@ -29,47 +29,29 @@ public class DubboProviderExceptionFilter implements Filter, Filter.Listener {
try {
// 转换异常
Throwable exception = appResponse.getException();
// 1. 参数校验异常
if (exception instanceof ConstraintViolationException) {
exception = this.constraintViolationExceptionHandler((ConstraintViolationException) exception);
// 2. 非 ServiceException 业务异常，转换成 ServiceException 业务异常，避免可能存在的反序列化问题
} if (!(exception instanceof ServiceException)) {
exception = this.defaultExceptionHandler(exception, invocation);
}
assert exception != null;
ServiceException serviceException = (ServiceException) exception;
// 根据不同的方法 schema 返回结果
// 第一种情况，则根据返回参数类型是否是 CommonResult 的情况，则将 ServiceException 转换成 CommonResult
// 第一种情况，返回参数类型是 CommonResult 的情况，则将 ServiceException 转换成 CommonResult
if (isReturnCommonResult(invocation)) {
// 清空异常
appResponse.setException(null);
// 设置结果
CommonResult exceptionResult = new CommonResult();
exceptionResult.setCode(serviceException.getCode());
exceptionResult.setMessage(serviceException.getMessage());
exceptionResult.setDetailMessage(serviceException.getDetailMessage());
appResponse.setValue(exceptionResult);
// 处理非 ServiceException 业务异常，转换成 ServiceException 业务异常
if (!(exception instanceof ServiceException)) {
logger.error("[onResponse][service({}) method({}) params({}) 执行异常]",
invocation.getServiceName(), invocation.getServiceName(), invocation.getArguments(), exception);
//
}
}
// 1. 处理 ServiceException 异常的情况
if (exception instanceof ServiceException) {
ServiceException serviceException = (ServiceException) exception;
// 则根据返回参数类型是否是 CommonResult 的情况，则将 ServiceException 转换成 CommonResult
if (isReturnCommonResult(invocation)) {
// 通用返回
CommonResult exceptionResult = new CommonResult();
exceptionResult.setCode(serviceException.getCode());
exceptionResult.setMessage(serviceException.getMessage());
appResponse.setValue(exceptionResult);
// 清空异常
appResponse.setException(null);
// 如果不是 CommonResult 的情况，则将 ServiceException 转换成 DubboInvokeException 避免可能存在的反序列化问题
} else {
RpcContext context = RpcContext.getContext();
appResponse.setException(new DubboInvokeException(exception.getMessage(), context.getLocalHost(), context.getLocalHostName()));
}
// 2. 处理非 ServiceException 异常的情况
// 第二种情况，未包装成 CommonResult 的情况，则直接抛出 ServiceException 异常
} else {
RpcContext context = RpcContext.getContext();
appResponse.setException(new DubboInvokeException(exception.getMessage(), context.getLocalHost(), context.getLocalHostName()));
appResponse.setException(serviceException);
}
} catch (Throwable e) {
logger.warn("Fail to ExceptionFilter when called by " + RpcContext.getContext().getRemoteHost() + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName() + ", exception: " + e.getClass().getName() + ": " + e.getMessage(), e);
@ -109,8 +91,20 @@ public class DubboProviderExceptionFilter implements Filter, Filter.Listener {
String.format("请求参数不正确:%s", constraintViolation.getMessage()));
}
private ServiceException defaultExceptionHandler() {
/**
* 处理系统异常，兜底处理所有的一切
*/
private ServiceException defaultExceptionHandler(Throwable exception, Invocation invocation) {
logger.error("[defaultExceptionHandler][service({}) method({}) params({}) 执行异常]",
invocation.getServiceName(), invocation.getServiceName(), invocation.getArguments(), exception);
return ServiceExceptionUtil.exception0(GlobalErrorCodeEnum.INTERNAL_SERVER_ERROR.getCode(),
GlobalErrorCodeEnum.INTERNAL_SERVER_ERROR.getMessage())
.setDetailMessage(this.buildDetailMessage(exception, invocation));
}
private String buildDetailMessage(Throwable exception, Invocation invocation) {
return String.format("Service(%s) Method(%s) 发生异常(%s)",
invocation.getServiceName(), invocation.getMethodName(), ExceptionUtil.getRootCauseMessage(exception));
}
}

4
common/mall-spring-boot-starter-web/src/main/java/cn/iocoder/mall/web/core/handler/GlobalExceptionHandler.java
View File

@ -155,7 +155,7 @@ public class GlobalExceptionHandler {
*/
@ExceptionHandler(value = Exception.class)
public CommonResult defaultExceptionHandler(HttpServletRequest req, Throwable e) {
logger.error("[exceptionHandler]", e);
logger.error("[defaultExceptionHandler]", e);
// 插入异常日志
SystemExceptionLogCreateDTO exceptionLog = new SystemExceptionLogCreateDTO();
try {
@ -166,7 +166,7 @@ public class GlobalExceptionHandler {
// 执行插入 exceptionLog
addExceptionLog(exceptionLog);
} catch (Throwable th) {
logger.error("[exceptionHandler][插入访问日志({}) 发生异常({})", JSON.toJSONString(exceptionLog), ExceptionUtils.getRootCauseMessage(th));
logger.error("[defaultExceptionHandler][插入访问日志({}) 发生异常({})", JSON.toJSONString(exceptionLog), ExceptionUtils.getRootCauseMessage(th));
}
// 返回 ERROR CommonResult
return CommonResult.error(GlobalErrorCodeEnum.INTERNAL_SERVER_ERROR.getCode(), GlobalErrorCodeEnum.INTERNAL_SERVER_ERROR.getMessage());