java - Jetty 中的 JSR-356 javax websockets(嵌入式和非嵌入式)

Question

鉴于:

我想将 web 应用程序(打包为 WAR，其中包含 web.xml)部署到 Jetty 服务器。

在该应用程序中，我希望能够配置 JSR-356 指定的 javax websocket 端点。我更喜欢通过 ServerEndpointConfig 提供这些端点，而不是注释扫描。

有许多资源举例说明了嵌入式 Jetty，利用了著名的 WebSocketServerContainerInitializer.configureContext(context); API。显然我做不到。

还有其他的，直接跳转到 ServletContextListener 并通过著名的 context.getAttribute("javax.websocket.server.ServerContainer" 获取 ServerContainer >)。到目前为止，我通过这个 API 得到了几乎NULL，所以显然没有添加容器。

问题:

缺少的配置是什么？最好可以通过 web.xml 来完成吗？如果它是关于像 jetty.xml 或 jetty.ini 这样的配置文件 - 例子会很好，再次，最好是 xml 语法。 p>

更新:

根据下面的答案(已接受的答案)以及我实际上尝试在这里描述的 - 已知的配置方式绝对工作得很好。说已知我的意思是通过将 --module=websocket 添加到非嵌入式 Jetty 的某些 *.ini 文件，或者通过调用 WebSocketServerContainerInitializer.configureContext 用于嵌入式。

因此重新表述这个问题:是否有人有任何经验/知识可以通过纯粹基于 XML 的配置来启用 websocket 模块？

Answer 1

如果使用 ${jetty.base}和${jetty.home} recommended installation process for Standalone Jetty ，您应该转到您的 ${jetty.base}实例目录并启用 websocket模块。

$ cd /path/to/mybase
$ java -jar /opt/jetty/jetty-home-9.4.14.v20181114/start.jar --add-to-start=websocket
$ grep "websocket" start.ini
--module=websocket

现在你已经启用了 websocket ${jetty.base}实例。

如果您希望 Jetty 通过字节码扫描部署的 Web 应用程序中的注释来发现您的服务器 WebSocket 端点，那么您还需要 annotations模块。

$ cd /path/to/mybase
$ java -jar /opt/jetty/jetty-home-9.4.14.v20181114/start.jar --add-to-start=annotations
$ grep "annotations" start.ini
--module=annotations

完成后，您可以执行以下一项(或多项)操作，将 Websocket 服务器端点部署到您的 Web 应用程序中。

• 只需使用 @ServerEndpoint 注释您的类即可(来自javax.websocket.server.ServerEndpoint)
• 或者，如果您想以编程方式添加 WebSocket 服务器端点，您有 2 个选择。
  1. 提供 javax.websocket.server.ServerApplicationConfig 的实现在您的项目中并返回您希望 Jetty 部署的服务器端点。
  2. 在 WebApp 启动/初始化期间获取 javax.websocket.server.ServerContainer 来自ServletContext.getAttribute("javax.websocket.server.ServerContainer")并使用它的 addEndpoint()方法。请注意，这只能通过 ServletContextListener.contextInitialized(ServletContextEvent sce) 来实现。或 ServletContainerInitializer.onStartup(Set<Class<?>> c, ServletContext ctx)

为什么这可以在独立的 Jetty 中工作？独立的 Jetty 正在做什么来实现这一目标？

发生以下情况:

• websocket module添加 lib/websocket/*.jar到服务器类路径
• websocket模块依赖于client和annotations模块
• client module添加lib/jetty-client-<jetty.version>.jar到服务器类路径
• annotations module添加lib/jetty-annotations-<jetty.version>.jar和lib/annotations/*.jar到服务器类路径
• annotations模块取决于plus模块
• annotations模块选择 etc/jetty-annotations.xml 用于启动时执行
• annotations模块按名称添加 JPMS 模块 org.objectweb.asm
• plus module添加lib/jetty-plus-<jetty.version>.jar到服务器类路径
• plus模块选择 etc/jetty-plus.xml 用于启动时执行
• plus模块取决于server , security , jndi , webapp ，和transactions模块

(我将跳过以此方式选择的其余模块)

简而言之，只需添加 websocket模块您将获得以下服务器类路径条目

lib/websocket/*.jar
lib/jetty-client-<jetty.version>.jar
lib/jetty-annotations-<jetty.version>.jar
lib/annotations/*.jar
lib/jetty-plus-<jetty.version>.jar

以及以下 XML 文件

lib/jetty-annotations.xml
lib/jetty-plus.xml

这两个 XML 文件都只是修改默认的 Configuration列表在服务器端，使得 Configuration他们引入的行为可用于所有已部署的 Web 应用程序。

您也可以 set the Configuration on the WebAppContext (在启动之前)针对 web 应用程序的特定行为。

示例:

WebAppContext context = new WebAppContext();
context.setContextPath("/");
context.setBaseResource(Resource.newResource(rootResourceUrl));

context.setConfigurations(new Configuration[] {
            new AnnotationConfiguration(),
            new WebXmlConfiguration(),
            new WebInfConfiguration(),
            new PlusConfiguration(), 
            new MetaInfConfiguration(),
            new FragmentConfiguration(), 
            new EnvConfiguration()});    

handlerList.addHandler(context);

Note: for javax.websocket you must use a WebAppContext, as the behaviors defined for its initialization require a full Web App to function. While you can use a ServletContextHandler with javax.websocket endpoints, this style is 100% manually defined, intialized, and declared, with no automatic bytecode / annotation scanning features that JSR-356 relies on.

您也可以从命令行查看所有这些。

显示 Activity ${jetty.base}配置、XML 属性值是什么、服务器类路径是什么以及将执行什么 XML(以及以什么顺序!!)

$ cd /path/to/mybase
$ java -jar /opt/jetty/jetty-home-9.4.14.v20181114/start.jar --list-config

显示模块列表及其关联方式(以及在 ${jetty.base} 配置中选择的模块)

$ cd /path/to/mybase
$ java -jar /opt/jetty/jetty-home-9.4.14.v20181114/start.jar --list-modules