ServiceComb HttpServerFilter加载机制浅析

ServiceComb构建微服务时,支持服务在Transport层面增加一层拦截器,类似J2EE规范的Filter机制。

使用方式

1、实现接口org.apache.servicecomb.common.rest.filter.HttpServerFilter,里面包含四个接口

  // Filter的优先级,值越小优先级越高

  int getOrder();

  // 结果是否需要缓存

  default boolean needCacheRequest(OperationMeta operationMeta) {

    return false;

  }

  // 接收到请求之后执行的方法,如果执行结果返回一个非null的Response,则直接使用该结果返回给请求,不会继续后续的逻辑,如果返回的是null,那么继续后面的Filter和业务逻辑。使用较多的就是鉴权操作,鉴权失败,那么需要返回一个401给客户端。

  Response afterReceiveRequest(Invocation invocation, HttpServletRequestEx requestEx);

  // 返回时执行的方法,这里需要注意的是invocation可能为空,所以业务在使用的时候需要先做非空判断

  void beforeSendResponse(Invocation invocation, HttpServletResponseEx responseEx);

2、在src/main/resources下面的META-INF/services下面增加接口实现说明(Java SPI机制),文件名为接口名称org.apache.servicecomb.common.rest.filter.HttpServerFilter,内容为接口实现(支持配置多个),例如:

com.service.article.WebServerFilter

com.service.article.WebServerFilter2

源码分析

1、ServiceComb Rest底层使用的是Vertx框架,所以在接入层是使用的Vertx标准的Verticle加载机制,代码启动程序如下

(1)Spring启动加载完成之后,执行org.apache.servicecomb.core.CseApplicationListener的onApplicationEvent方法,该Bean里面有org.apache.servicecomb.core.transport.TransportManager的Bean的依赖,TransportManager里面会注入所有声明为Bean的org.apache.servicecomb.core.Transport,所以当引入transport-rest-vertx时,会自动加载org.apache.servicecomb.transport.rest.vertx.VertxRestTransport

CseApplicationListener.onApplicationEvent -> TransportManager.init->VertxRestTransport.init->vertx.deployVerticle->RestServerVerticle

(2)

    @Override public void start(Future startFuture) throws Exception {

    super.start();

    // 如果本地未配置地址,则表示不必监听,只需要作为客户端使用即可

    if (endpointObject == null) {

      LOGGER.warn("rest listen address is not configured, will not start.");

      startFuture.complete();

      return;

    }

    Router mainRouter = Router.router(vertx);

    mountAccessLogHandler(mainRouter);

    initDispatcher(mainRouter);

    HttpServer httpServer = createHttpServer();

    httpServer.requestHandler(mainRouter::accept);

    startListen(httpServer, startFuture);

  }

private void initDispatcher(Router mainRouter) { 

    List dispatchers = SPIServiceUtils.getSortedService(VertxHttpDispatcher.class);

    for (VertxHttpDispatcher dispatcher : dispatchers) {

      LOGGER.info("init vertx http dispatcher {}", dispatcher.getClass().getName());

      dispatcher.init(mainRouter);

    }

  }

initDispatcher方法里面有一个SPIServiceUtils.getSortedService,该方法提供Java标准的SPI加载机制,只是里面多了一层排序的功能,现在就是里面需要实现一个getOrder方法,按大小进行排序,越小就越靠前。ServiceComb内置的VertxRestDispatcher是一个最大的INTEGER值,我们自己开发的Edge服务,建议设置为一个较小的值。

所有的Dispatcher都集成AbstractVertxHttpDispatcher,该实现类里面又有一个protected List httpServerFilters = SPIServiceUtils.getSortedService(HttpServerFilter.class);

(3)VertxRestDispatcher接收到Vertx的route的请求之后,走到onRequest方法,又走到Invocation里面,真正执行

  private void onRequest(RoutingContext context) {

    if (transport == null) {

      transport = CseContext.getInstance().getTransportManager().findTransport(Const.RESTFUL);

    }

    HttpServletRequestEx requestEx = new VertxServerRequestToHttpServletRequest(context);

    HttpServletResponseEx responseEx = new VertxServerResponseToHttpServletResponse(context.response());

    RestProducerInvocation restProducerInvocation = new RestProducerInvocation();

    context.put(RestConst.REST_PRODUCER_INVOCATION, restProducerInvocation);

    restProducerInvocation.invoke(transport, requestEx, responseEx, httpServerFilters);

  }

在AbstractRestInvocation的prepareInvoke方法里面调用filter的afterReceiveRequest

protected Response prepareInvoke() throws Throwable {

    this.initProduceProcessor();

    this.setContext();

    invocation.getHandlerContext().put(RestConst.REST_REQUEST, requestEx);

    for (HttpServerFilter filter : httpServerFilters) {

      Response response = filter.afterReceiveRequest(invocation, requestEx);

      if (response != null) {

        return response;

      }

    }

    return null;

  }

在AbstractRestInvocation的sendResponse方法里面调用filter的beforeSendResponse

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,646评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,797评论 6 342
  • 前面对TensorFlow的多线程做了测试,接下来就利用多线程和Queue pipeline地加载数据。数据流如下...
    hzyido阅读 2,052评论 1 3
  • 如果我爱你,而你正巧也爱我—— 那你骑车的时候,我会要你小心一点,还要你到的时候打个电话跟我说。 你忘了吃晚餐...
    霹雳小毛阅读 162评论 0 0
  • 我喜欢两眼放空式的看着窗外,不知道在想什么,或许只是单纯的发呆。那种静止式的安静是外人所打破不了的。 看着来往的人...
    荔枝爱吃猫阅读 302评论 0 0