【问题标题】:Jetty 9.x ProxyServlet - how to set up ServletContext correctly in XMLJetty 9.x ProxyServlet - 如何在 XML 中正确设置 ServletContext
【发布时间】:2018-09-28 14:00:21
【问题描述】:

旨在通过运行 webapp servlet 和代理 servlet 以及其他工具(如部署和控制台日志记录)在本地启动 Jetty。所有 Jetty 配置都在 XML 文件中。

代理 servlet 会将前缀为 /media/*GET 请求反向代理到外部站点 https://example-server/。所以http://localhost:8080/media/image.jpg 将传递给https://media-server/image.jpg

这是我jetty.xml的摘录:

<Set name="handler">
  <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection">
    <Set name="handlers">
     <Array type="org.eclipse.jetty.server.Handler">
       <Item>
         <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/>
       </Item>
       <Item>
         <New id="context" class="org.eclipse.jetty.servlet.ServletContextHandler">
           <Arg><Get class="org.eclipse.jetty.servlet.ServletContextHandler" name="SESSIONS"/></Arg>
           <Call name="setContextPath" arg="/"/>
           <Set name="servletHandler">
             <New id="handler" class="org.eclipse.jetty.servlet.ServletHandler">
               <Call id="holder" name="addServletWithMapping" arg="org.eclipse.jetty.proxy.ProxyServlet$Transparent,/media/*">
                 <Call name="setInitParameter" arg="proxyTo,https://media-server"/>
                 <Call name="setInitParameter" arg="prefix,/media"/>
               </Call>
             </New>
           </Set>
         </New>
       </Item>
       <Item>
         <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/>
       </Item>
     </Array>
    </Set>
  </New>
</Set>

上面的 XML 应该等同于这个 Java 代码。

ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS);
context.setContextPath("/");
ServletHandler handler = new ServletHandler();
ServletHolder holder = handler.addServletWithMapping(ProxyServlet$Transparent.class, "/media/*");
holder.setInitParameter("proxyTo", "https://media-server");
holder.setInitParameter("prefix", "/media");
context.setServletHandler(handler);

这是改编自默认的jetty.xmlhttps://dzone.com/articles/configuring-jetty-servlet-proxy

根据 DZone 指南,我更新了 Jetty 9.x 的类名。所以org.eclipse.jetty.servlets.ProxyServlet 现在是org.eclipse.jetty.proxy.ProxyServlet 并且proxyToprefix 参数必须以小写p 开头。

检查 jetty-proxy-9.4.12.v20180830.jar 是否作为库包含在 Jetty 的启动配置中。

对于日志记录,Jetty 命令行包括 -Dorg.eclipse.jetty.proxy.LEVEL=DEBUG(我建议其他任何人使用此方法来解决 ProxyServlet。)

问题:什么都没有发生。 ProxyServlet 未在 GET 对 `http://localhost:8080/media/image.jpg' 的请求上激活。

这是显示ServletContextHandler 正在启动的日志行。

2018-09-28 15:26:46.045:INFO:oejsh.ContextHandler:main: Started o.e.j.s.ServletContextHandler@1e028a9{"",null,AVAILABLE}

我想有一个简单的解决方案,比如正确设置 ServletContext,但我不知道如何在 XML 中做到这一点,非常感谢一些帮助。 Jetty documentation 在这个很薄。

现在,如果我将jetty.xml 更改为下面的这个,那么代理确实会在GET 向`http://localhost:8080/media/image.jpg'发出请求时激活。

<Set name="handler">
  <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection">
    <Set name="handlers">
     <Array type="org.eclipse.jetty.server.Handler">
       <Item>
         <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/>
       </Item>
       <Item>
         <New id="handler" class="org.eclipse.jetty.servlet.ServletHandler">
           <Call id="holder" name="addServletWithMapping" arg="org.eclipse.jetty.proxy.ProxyServlet$Transparent,/media/*">
             <Call name="setInitParameter" arg="proxyTo,https://media-server"/>
             <Call name="setInitParameter" arg="prefix,/media"/>
           </Call>
         </New>
       </Item>
       <Item>
         <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/>
       </Item>
     </Array>
    </Set>
  </New>
</Set>

日志显示 ProxyServlet 像这样激活:

2018-09-28 14:22:14.904:DBUG:oejpP.194a1b5:qtp22374712-13: org.eclipse.jetty.proxy.ProxyServlet$Transparent-194a1b5 @ null/media to https://media-server
2018-09-28 14:22:14.904:DBUG:oejpP.194a1b5:qtp22374712-13: 21964987 rewriting: http://localhost:8080/media/image.jpg -> null

但是这里的代理失败了,因为它有一个null 上下文。所以前缀(source code)设置为null/media是因为ServletContext.getContextPath()为空。由于this source code,这会导致重定向到null。将_prefix 设置为null/media,没有什么能与之匹配。可能这是一个错误,我已经打开了一个问题。

【问题讨论】:

    标签: xml configuration reverse-proxy jetty-9


    【解决方案1】:

    这是一个使用来自${jetty.base} 目录的ProxyServlet 的示例。

    $ mkdir proxy-example-base
    $ cd proxy-example-base/
    $ java -jar ../../jetty-home-9.4.12.v20180830/start.jar --add-to-start=http,deploy,proxy
    INFO  : webapp          transitively enabled, ini template available with --add-to-start=webapp
    INFO  : server          transitively enabled, ini template available with --add-to-start=server
    INFO  : proxy           initialized in ${jetty.base}/start.ini
    INFO  : security        transitively enabled
    INFO  : servlet         transitively enabled
    INFO  : http            initialized in ${jetty.base}/start.ini
    INFO  : client          transitively enabled
    INFO  : threadpool      transitively enabled, ini template available with --add-to-start=threadpool
    INFO  : deploy          initialized in ${jetty.base}/start.ini
    MKDIR : ${jetty.base}/webapps
    INFO  : Base directory was modified
    $ ls -la
    total 8
    drwxr-xr-x   4 joakim  staff   136 Oct  1 14:10 ./
    drwxr-xr-x  17 joakim  staff   578 Oct  1 14:10 ../
    -rw-r--r--   1 joakim  staff  2146 Oct  1 14:10 start.ini
    drwxr-xr-x   3 joakim  staff   102 Oct  1 14:11 webapps/
    $ cp ~/Downloads/media-proxy.xml webapps/
    $ cat webapps/media-proxy.xml
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd">
    <Configure class="org.eclipse.jetty.servlet.ServletContextHandler">
      <Set name="contextPath">/</Set>
      <Call name="addServlet">
        <Arg>org.eclipse.jetty.proxy.ProxyServlet$Transparent.class</Arg>
        <Arg>/media/*</Arg>
        <Set name="InitOrder">1</Set>
        <Call name="setInitParameter">
          <Arg>proxyTo</Arg>
          <Arg>https://media-server/</Arg>
        </Call>
        <Call name="setInitParameter">
          <Arg>prefix</Arg>
          <Arg>/media</Arg>
        </Call>
      </Call>
    </Configure>
    

    其工作方式是将${jetty.base} 配置为启用proxy 码头模块,这会将代理类放在服务器类路径中。

    然后开启deployjetty模块,在${jetty.base}/webapps/目录下查找webapps的配置并部署。

    最后,一个可部署的 XML 设置为在 / contextPath 处有一个 javax.servlet.ServletContext,以及一个已定义的 servlet,即带有一些 init 参数的 ProxyServlet$Transparent

    【讨论】:

    • 谢谢,非常感谢。此 XML 似乎等同于以下 Java 代码:ServletContextHandler context = new ServletContextHandler(); context.setContextPath("/"); ServletHolder = context.addServlet(ProxyServlet$Transparent.class, "/media/*"); holder.setInitOrder(1); holder.setInitParameter("proxyTo", "https://media-server"); holder.setInitParameter("prefix", "/media");
    【解决方案2】:

    一个变通解决方案 - 不完全是我想要做的,但它有效 - 是从与 webapp 关联的web.xml 启动 ProxyServlet。

    <servlet>
      <servlet-name>JettyProxy</servlet-name>
      <servlet-class>org.eclipse.jetty.proxy.ProxyServlet$Transparent</servlet-class>
      <init-param>
        <param-name>proxyTo</param-name>
        <param-value>https://media-server</param-value>
      </init-param>
      <init-param>
        <param-name>prefix</param-name>
        <param-value>/media</param-value>
      </init-param>
      <load-on-startup>1</load-on-startup>
      <async-supported>true</async-supported>
    </servlet>
    <servlet-mapping>
      <servlet-name>JettyProxy</servlet-name>
      <url-pattern>/media/*</url-pattern>
    </servlet-mapping>
    

    其他问题:

    • web.xml 中定义的任何过滤器现在也需要 &lt;async-supported&gt;true&lt;/async-supported&gt;
    • 您的项目现在需要 jetty-proxy 库 jar 作为依赖项(版本必须与您的 Jetty 版本匹配),如下所示:

      <dependency>
         <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-proxy</artifactId>
        <version>9.4.12.v20180830</version>
      </dependency>
      

    web.xml 以这种方式执行此操作与从 Jetty 自己的配置执行此操作之间存在一些差异,就像我想在 OP 中执行的那样。

    1. 代理 URL 现在必须采用这种形式(其中 webapp 是 webapp 名称):http://localhost:8080/webapp/media/image.jpg
    2. 当 Jetty 版本发生变化时,Web 应用程序必须更新 web.xml - 对于远程托管的应用程序来说可能是个问题
    3. 每个 web 应用都必须包含此内容,而不是“内置”到 Jetty 中
    4. 与 Jetty 能够为不同的路径设置不同的 servlet 相比,感觉不优雅 - 这里是否会影响性能,因为代理的 URL 现在也被 web 应用的过滤器解析?
    5. 在代理请求周期完成时可能会阻塞 webapp 的线程(需要测试...)

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-02-14
      • 1970-01-01
      • 2012-04-08
      • 2015-04-24
      • 1970-01-01
      相关资源
      最近更新 更多