Spring Cloud zuul自定義統一異常處理實現
阿新 • • 發佈:2019-01-09
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();
}