Spring Cloud zuul自定义统一异常处理实现方法

时间:2021-05-20

Zuul在springcloud微服务体系中提供filer和router功能,是微服务不可或缺的部分。filer处理默认实现的外还可以自定义进行授权、限流、安全校验等,router完全可以替代Nginx反向代理。Zuul异常处理就是由SendErrorFilter完成。

在我们应用过程我们发现使用默认的异常filter有两个问题不是很友好:

1.无法快速识别出是否是请求路由的服务超时还是没有任何可用节点,发生错误只能查看日志通过堆栈去定位;

2.无法兼容自定义的譬如{code:500,msg:”xx error”}格式的响应包格式。

接下来我们讨论的是如何自定义异常处理、自定义异常提示信息等。

首先,我们必须禁用默认的SendErrorFilter,官方已经提供了开关配置,直接配置即可

zuul.SendErrorFilter.post.disable=true

自定义ErrorFilter,这里就不多说,直接贴代码

public class ErrorFilter extends ZuulFilter { private static final String ERROR_STATUS_CODE_KEY = "error.status_code"; private Logger log = LoggerFactory.getLogger(ErrorFilter.class); public static final String DEFAULT_ERR_MSG = "系统繁忙,请稍后再试"; @Override public String filterType() { return "post"; } @Override public int filterOrder() { return 0; } @Override public boolean shouldFilter() { RequestContext ctx = RequestContext.getCurrentContext(); return ctx.containsKey(ERROR_STATUS_CODE_KEY); } @Override public Object run() { RequestContext ctx = RequestContext.getCurrentContext(); try { HttpServletRequest request = ctx.getRequest(); int statusCode = (Integer) ctx.get(ERROR_STATUS_CODE_KEY); String message = (String) ctx.get("error.message"); if (ctx.containsKey("error.exception")) { Throwable e = (Exception) ctx.get("error.exception"); Throwable re = getOriginException(e); if(re instanceof java.net.ConnectException){ message = "Real Service Connection refused"; log.warn("uri:{},error:{}" ,request.getRequestURI(),re.getMessage()); }else if(re instanceof java.net.SocketTimeoutException){ message = "Real Service Timeout"; log.warn("uri:{},error:{}" ,request.getRequestURI(),re.getMessage()); }else if(re instanceof com.netflix.client.ClientException){ message = re.getMessage(); log.warn("uri:{},error:{}" ,request.getRequestURI(),re.getMessage()); }else{ log.warn("Error during filtering",e); } } if(StringUtils.isBlank(message))message = DEFAULT_ERR_MSG; request.setAttribute("javax.servlet.error.status_code", statusCode); request.setAttribute("javax.servlet.error.message", message); WebUtils.responseOutJson(ctx.getResponse(), JsonUtils.toJson(new WrapperResponse<>(statusCode, message))); } catch (Exception e) { String error = "Error during filtering[ErrorFilter]"; log.error(error,e); WebUtils.responseOutJson(ctx.getResponse(), JsonUtils.toJson(new WrapperResponse<>(500, error))); } return null; } private Throwable getOriginException(Throwable e){ e = e.getCause(); while(e.getCause() != null){ e = e.getCause(); } return e; }}

最后注册我们自定义的ErrorFilter

@Bean public ErrorFilter errorFilter(){ return new ErrorFilter();}

总结

以上所述是小编给大家介绍的Spring Cloud zuul自定义统一异常处理实现方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!

声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。

相关文章