使用 Jetty 11 设置 websockets

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 class，我四处摸索，找到了 class 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 作为 Class 对象传递，这使得依赖注入变得很痛苦。

我现在已经在 Jetty 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，它从存储在 class 路径中的资源树中提供一些简单的静态资源（在/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>

Answer 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 class。

Answer 3

您可以在 Jetty 11 示例中找到信息https://github.com/jetty-project/embedded-jetty-websocket-examples/blob/10.0.x/native-jetty-websocket-example/src/main/java/org/eclipse/jetty/demo/EventServer.java

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

org.eclipse.jetty:jetty-server:11.0.0
org.eclipse.jetty:jetty-servlet:11.0.0
org.eclipse.jetty:jetty-annotations:11.0.0
org.eclipse.jetty.websocket:websocket-jetty-server:11.0.0
org.eclipse.jetty.websocket:websocket-jetty-client:11.0.0

请注意 websocket-client 和 websocket-server 的名称已更改为 websocket-jetty-client 和 websocket-jetty-server

正如@mdf 所指出的 JettyWebSocketServletContainerInitializer.configure 可以消除以下消息：

WebSocketComponents has not been created

现在我的应用可以在 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();
}

使用 Jetty 11 设置 websockets

Set up websockets with Jetty 11

java

jetty

websocket