欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-08-13 21:46:14
zuul在springcloud微服务体系中提供filer和router功能,是微服务不可或缺的部分。filer处理默认实现的外还可以自定义进行授权、限流、安全校验等,ro...

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自定义统一异常处理实现方法,希望对大家有所帮助