【问题标题】:Set up websockets with Jetty 11使用 Jetty 11 设置 websocket
【发布时间】:2021-04-03 04:44:50
【问题描述】:

我正在尝试从 Jetty 9.4 迁移到 Jetty 11(可能为时过早?)并且未能调整代码以设置 websocket。我在 9.4 中实现这一点的方式如下:

Server server = new Server();
HttpConfiguration httpConfig = new HttpConfiguration();
httpConfig.setSendServerVersion(false);
HttpConnectionFactory httpFactory = new HttpConnectionFactory(httpConfig);
ServerConnector httpConnector = new ServerConnector(server, httpFactory);
httpConnector.setPort(port);
server.setConnectors(new Connector[] { httpConnector });

// Setup the basic application "context" for this application at "/"
// This is also known as the handler tree (in jetty speak)
ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS);
context.setContextPath("/");

// Add a websocket to a specific path spec
ServletHolder holderEvents2 = new ServletHolder("websocket", EventsServlet.class);
context.addServlet(holderEvents2, "/events/*");

HandlerList handlers = new HandlerList();
handlers.setHandlers(new Handler[] { context, new DefaultHandler() });

server.setHandler(handlers);

public class EventsServlet extends WebSocketServlet {

    @Override
    public void configure(WebSocketServletFactory factory) {
        // register a socket class as default
        factory.register(EchoSocket.class);
    }
}

public class EchoSocket implements WebSocketListener {
    // ...
}

由于不再有 WebSocketServlet 类,我摆弄了一下,找到了 JettyWebSocketServlet 类。根据它的JavaDoc,我认为它应该如下:

public class EventsServlet extends JettyWebSocketServlet {

    @Override
    protected void configure(JettyWebSocketServletFactory factory) {
        // register a socket class as default
//      factory.register(EchoSocket.class);
           factory.addMapping("/", (req,res)->new EchoSocket());

    }
}

但 addMapping 的行实际上从未执行过。此外,JettyWebSocketServletFactory 没有 JettyWebSocketServlet 的 JavaDoc 建议的名为 setDefaultMaxFrameSize 的方法。

我似乎能在网上找到的只是 Jetty https://github.com/jetty-project/embedded-jetty-websocket-examples。

任何帮助将不胜感激。

【问题讨论】:

    标签: java websocket jetty


    【解决方案1】:

    我遇到了类似的问题,虽然我在 Jetty 9.4 下运行的版本与你的有点不同,使用 WebSocketHandler 而不是 WebSocketServlet。我在使用旧方法时遇到了一些问题,因为在 Jetty 9.4 下,我必须将侦听器类作为 Class 对象传递,这使得依赖注入很痛苦。

    我现在已经在 J​​etty 11.0.0 下工作了。几天前,我在尝试解决如何在 Jetty 11 中执行此操作时发现了您的问题,它启发了我真正开始工作,所以谢谢!

    FWIW,我的 Jetty 9.4 版本(用于简单测试)如下所示:

    public static void main(String[] argv) throws Exception
    {
        int serverPort = Integer.getInteger("server.port", 8080);
    
        Server server = new Server(serverPort);
        ContextHandlerCollection handlers = new ContextHandlerCollection();
    
        WebSocketHandler wsh = new WebSocketHandler.Simple (TestWebSocketListener.class);
        handlers.addHandler(createContextHandler("/ws", wsh));
    
        ResourceHandler rh = new ResourceHandler();
        rh.setDirectoriesListed(false);
        rh.setBaseResource(Resource.newClassPathResource("/WEB-STATIC/"));
        handlers.addHandler(createContextHandler("/", rh));
    
        server.setHandler(handlers);
    
        server.start();
        server.join();
    }
    
    // Convenience method to create and configure a ContextHandler.
    private static ContextHandler createContextHandler(String contextPath, Handler wrappedHandler)
    {
        ContextHandler ch = new ContextHandler (contextPath);
        ch.setHandler(wrappedHandler);
        ch.clearAliasChecks();
        ch.setAllowNullPathInfo(true);
        return ch;
    }
    

    这里,TestWebSocketListenerWebSocketListener 的一个简单实现,它只是实现每个侦听器方法并将参数打印到System.err。 (我确实说过这是一个微不足道的测试。)我还在 onWebSocketText 回调中向客户端发送了一条消息,只是为了检查它是否有效。

    我在这里没有使用DefaultHandler - 相反,我明确地创建了一个ResourceHandler,它从存储在类路径中的资源树中提供一些简单的静态资源(在/WEB-STATIC/ 前缀下)。

    我在 Jetty 11.0.0 下工作的版本只是将上面的 main 方法更改为:

    public static void main(String[] argv) throws Exception
    {
        int serverPort = Integer.getInteger("server.port", 8080);
    
        Server server = new Server(serverPort);
        ContextHandlerCollection handlers = new ContextHandlerCollection();
    
        ResourceHandler rh = new ResourceHandler();
        rh.setDirectoriesListed(false);
        rh.setBaseResource(Resource.newClassPathResource("/WEB-STATIC/"));
        handlers.addHandler(createContextHandler("/", rh));
    
        Servlet websocketServlet = new JettyWebSocketServlet() {
            @Override protected void configure(JettyWebSocketServletFactory factory) {
                factory.addMapping("/", (req, res) -> new TestWebSocketListener());
            }
        };
        ServletContextHandler servletContextHandler = new ServletContextHandler();
        servletContextHandler.addServlet(new ServletHolder(websocketServlet), "/ws");
        JettyWebSocketServletContainerInitializer.configure(servletContextHandler, null);
        handlers.addHandler(servletContextHandler);
    
        server.setHandler(handlers);
    
        server.start();
        server.join();
    }
    

    JettyWebSocketServletContainerInitializer.configure 的调用很重要:否则我会收到抱怨WebSocket 组件未初始化的异常。

    需要注意的一点是,两个处理程序的顺序已更改 - 以前,WebSocketHandler 是在 ResourceHandler 之前添加的。但是,当使用ServletContextHandler 时,对于应该由ResourceHandler 处理的路径返回 404,所以我交换了顺序。

    TestWebSocketListener 在两个版本之间是相同的。显然,现在我控制了构造函数调用,对我来说添加依赖注入要容易得多!

    我必须更改的另一件事是我拉入的 Maven 工件的名称。websocket-server 工件似乎不再存在于 Jetty 11 中,所以我更改了这个:

    <dependency>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-server</artifactId>
        <version>9.4.35.v20201120</version>
    </dependency>
    <dependency>
        <groupId>org.eclipse.jetty.websocket</groupId>
        <artifactId>websocket-server</artifactId>
        <version>9.4.35.v20201120</version>
    </dependency>
    

    到这里:

    <dependency>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-server</artifactId>
        <version>11.0.0</version>
    </dependency>
    <dependency>
        <groupId>org.eclipse.jetty.websocket</groupId>
        <artifactId>websocket-jetty-server</artifactId>
        <version>11.0.0</version>
    </dependency>
    

    【讨论】:

    • 非常感谢详细而有用的回答,帮助我解决了我的问题。我将添加我的代码的最终解决方案作为另一个答案。
    【解决方案2】:

    感谢 mdf 的详细解释,我能够修复我的代码。最后,我只需要更换

    ServletHolder holderEvents = new ServletHolder("websocket", EventsServlet.class);
    context.addServlet(holderEvents, "/events/*");
    

    Servlet websocketServlet = new JettyWebSocketServlet() {
        @Override
        protected void configure(JettyWebSocketServletFactory factory) {
            factory.addMapping("/", (req, res) -> new EchoSocket());
        }
    };
    context.addServlet(new ServletHolder(websocketServlet), "/events/*");
    JettyWebSocketServletContainerInitializer.configure(context, null);
    

    这样我也可以摆脱 EventsServlet 类。

    【讨论】:

      【解决方案3】:

      使用以下软件包从 jetty 9 升级

      1. org.eclipse.jetty:jetty-server:11.0.0
      2. org.eclipse.jetty:jetty-servlet:11.0.0
      3. org.eclipse.jetty:jetty-annotations:11.0.0
      4. org.eclipse.jetty.websocket:websocket-jetty-server:11.0.0
      5. org.eclipse.jetty.websocket:websocket-jetty-client:11.0.0

      请注意,websocket-clientwebsocket-server 的名称更改为 websocket-jetty-clientwebsocket-jetty-server

      正如@mdf JettyWebSocketServletContainerInitializer.configure 所指出的那样,可以摆脱以下消息:

      WebSocketComponents 尚未创建

      现在我的应用可以在 jetty 11 上运行。

      这是我的 WebsocketServlet

      import org.eclipse.jetty.websocket.server.JettyWebSocketServlet;
      import org.eclipse.jetty.websocket.server.JettyWebSocketServletFactory;
      
      public class KernelServlet extends JettyWebSocketServlet {
          @Override
          public void configure(JettyWebSocketServletFactory factory) {
              factory.register(KernelHandler.class);
          }
      }
      

      这是服务器初始化代码

      Server server = new Server(port);
      ServletContextHandler contextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS);
      contextHandler.setContextPath("/");
      contextHandler.addServlet(WebClientServlet.class, "/client");
      contextHandler.addServlet(KernelServlet.class, "/kernel");
      JettyWebSocketServletContainerInitializer.configure(contextHandler, null);
      try {
          server.setHandler(contextHandler);
          server.start();
          server.join();
      } catch (Exception e) {
          e.printStackTrace();
      }
      

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 2016-04-17
        • 1970-01-01
        • 2017-12-06
        • 1970-01-01
        • 2013-08-27
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多