使用 Jetty 11 设置 websocket

Question

我正在尝试从 Jetty 9.4 迁移到 Jetty 11（可能太早了？），但未能调整用于设置 websockets 的代码。我在 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 <= 9.4，甚至是https://github.com/jetty-project/embedded-jetty-websocket-examples。

任何帮助将不胜感激。

Answer 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;
}

这里，TestWebSocketListener是一个简单的实现，WebSocketListener它仅实现每个侦听器方法并将参数打印到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它时，本应由 处理的路径返回 404 ResourceHandler，所以我交换了顺序。

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>