美文网首页
ServiceComb HttpServerFilter加载机制

ServiceComb HttpServerFilter加载机制

作者: jeho0815 | 来源:发表于2018-01-20 16:51 被阅读0次

    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

    相关文章

      网友评论

          本文标题:ServiceComb HttpServerFilter加载机制

          本文链接:https://www.haomeiwen.com/subject/rbytaxtx.html