Tomcat：在同一个Web应用程序中使用servlet和websocket（jsr356）

Question

我在tomcat中使用Guice-servlets和websocket创建了一个示例webapp，现在一次使用guice过滤器websocket停止工作

基本信息：

在我的web.xml中，我使用GuiceBasedListener初始化了GuiceBasedListener

<web-app>
     <listener>
        <listener-class>test.GuiceBasedListener</listener-class>
    </listener>          
    <filter>
        <filter-name>guiceFilter</filter-name>
        <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>guiceFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

GuieBasedListener Code将所有请求/*绑定到MyDispatcher

public class GuiceBasedListener extends GuiceServletContextListener {
    protected Injector getInjector() {
        return Guice.createInjector( new ServletModule() {
            @Override
            protected void configureServlets() {
                bind(MyDispatcher.class).asEagerSingleton();
                serve("/*").with(MyDispatcher.class);//////IMPORTANT LINE//
            }
        });}}

MyDispatcher代码只响应一个String

public class MyDispatcher extends HttpServlet {    
    @Inject private Injector injector;
    public MyDispatcher() {}    
    public void service(ServletRequest req, ServletResponse resp) throws IOException, ServletException {
        resp.getOutputStream().print("SUCCESS:" + req);
    }
}

我还有一个@ServerEndPoint for Websocket

@ServerEndpoint(value = "/websocket/chat2")
public class WebSocket{
....
    @OnOpen
    public void start(Session session) {        
        System.out.println("Staring:"+this);
   }
....
}

观察：

1. 现在如果我运行应用程序并点击http：// app：8080 / test它会返回SUCCESS
2. 但是，如果我尝试使用ws：// app：8080 / websocket / chat2连接到websocket，则会失败

3. 现在，如果我评论serve("/*").with(MyDispatcher.class); 基本上如果我们关闭guice路由，websocket开始工作

4. 如果我关闭guice-servlet但是在web.xml中添加一个servlet映射，就像下面的websocket仍然有效

   < servlet-mapping > < servlet-name > HelloWorld< / servlet-name > < url-pattern > /* < / url-pattern > < / servlet-mapping >

我错过了什么或做错了什么？

---

编辑：

观察-孔蒂：

5. 我所做的是定义了一个简单的过滤器，它只是用FILTER响应。

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { response.getOutputStream().print("FILTER"); }

并将我的web.xml更改为

<web-app>           
    <filter>
        <filter-name>myFilter</filter-name>
        <filter-class>test.MyFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>myFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>       
</web-app>

现在点击http://localhost:8080/app/x按预期返回FILTER 。 但尝试连接websocket失败，因为请求显示这样的事情。 我还注意到，当我更改String MyFilter返回响应更改的内容长度，这意味着在tomcat处理websocket之前请求到达MyFilter 。

6. 我将web.xml更改为下面，guice和websocket现在工作正常..所以我认为Guice不尊重在GuiceFilter之后注册的WsFilter

    <filter> <filter-name>myFilter</filter-name> <filter-class>org.apache.tomcat.websocket.server.WsFilter</filter-class> </filter> <filter-mapping> <filter-name>myFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter> <filter-name>guiceFilter</filter-name> <filter-class>com.google.inject.servlet.GuiceFilter</filter-class> </filter> <filter-mapping> <filter-name>guiceFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> 

---

TOMCAT 8.0，Window 7，Java 1.7，Guice 4.0，Guice-servlet-4.0

Answer 1

这对我来说也像Guice问题（正如评论中已经提到的）。 即使使用覆盖/*的servlet映射，在同一应用程序中使用servlet和WebSockets应该不是问题。

有关servlet和过滤器的2个相关内容：

• 如前所述，当获取websocket升级请求（一种非常特殊的http请求）时，通常Tomcat不应让它通过过滤器。 看起来Guice以某种方式打破了这个。
• 过滤器按照其在web.xml中定义的映射的顺序应用。

因此，如果WsFilter是第一个，它将首先拦截请求，然后检查它是否是WebSocket升级请求 。
如果它确实是WebSocket连接，则过滤器不会将其传递给链的其余部分 。
如果它是另一种类型的请求（GET，POST ...），它将传递它，然后Guice将做它的事情。

（所以你在这里找到了第一个解决方案）

如果Guice过滤器是第一个，你使用serve("/*")... ，那么它会破坏你的WS。

如果你注释掉serve("/*")... ，那么Guice过滤器是否优先并不重要，WsFilter甚至可以不存在：你的WS可以到达（它可以单独建立GuiceFilter）。

因此Guice在servlet映射之上有自己的“拦截层”，我认为这就是破坏WebSockets的原因。 我不知道在Guice中是否存在错误或任何需要修复的内容（我的意思是，但不知道到底是什么），但您可以为Guice指定异常（与web.xml servlet映射不同）。
替换这个：

serve("/*").with(TestServlet.class);

有了这个：

serveRegex("/(?!websocket/).*").with(TestServlet.class);
// Regex that accepts /.* but excludes /websocket/.*

这样，您可以将servlet映射保留在/* ，并在不需要时删除WsFilter 。 （经过测试，适合我）

这是第二个解决方案，它的优点是它还允许为非WebSocket内容指定异常。