使用 Jetty 11 设置 websocket

问题描述

我正在尝试从 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 。

任何帮助将不胜感激。

解决方法

我遇到了类似的问题，尽管我在 Jetty 9.4 下运行的版本与您的略有不同，使用的是 WebSocketHandler 而不是 WebSocketServlet。我在使用旧方法时遇到了一些问题，因为在 Jetty 9.4 下我必须将我的侦听器类作为 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，它从存储在类路径中的资源树（在 /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>

感谢 mdf 的详细解释，我能够修复我的代码。最后只好换了

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

与

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

有了这个，我也可以摆脱 EventsServlet 类。

使用以下软件包从 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 尚未创建

现在我的应用程序适用于 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();
}

java java jetty websocket websocket websocket