在 JSR-356 @ServerEndpoint 的 @OnMessage 中访问 ServletContext 和 HttpSession

Question

我需要从 @ServerEndpoint 中获取 ServletContext 才能找到 Spring ApplicationContext 并查找 Bean。

目前我最好的方法是在 JNDI 命名上下文中绑定该 bean 并在 Endpoint 中查找它。欢迎任何更好的解决方案。

我也在寻找一种合理的方式来同步 servlet 的 HttpSession 和 websocket 的 Session。

Answer 1

BalusC 上面的ServletAwareConfig 有时我们不能得到session，这是因为会话还没有创建。因为我们不是在寻找会话而是寻找servletContext，所以在tomcat中我们可以这样做：

public static class ServletAwareConfig extends ServerEndpointConfig.Configurator {

    @Override
    public void modifyHandshake(ServerEndpointConfig config, HandshakeRequest request, HandshakeResponse response) {
        try {
            Field reqfld = request.getClass().getDeclaredField("request");
            reqfld.setAccessible(true);
            HttpServletRequest req = (HttpServletRequest) reqfld.get(request);
            ServletContext ctxt = req.getServletContext();
            Map<String, Object> up = config.getUserProperties();
            up.put("servletContext", ctxt);
        } catch (NoSuchFieldException e) {
        } catch (SecurityException e) {
        } catch (IllegalArgumentException e) {
        } catch (IllegalAccessException e) {
        }
    }

}

如果我们想立即初始化会话，我们可以调用 request.getSession()。

参考：Websocket - httpSession returns null

Answer 2

servlet HttpSession 在 JSR-356 中由 HandshakeRequest#getHttpSession() 提供，当在 @ServerEndpoint 的 @OnOpen 之前发出握手请求时，它反过来可用。 ServletContext 反过来只能通过HttpSession#getServletContext() 获得。那就是一石二鸟。

为了捕获握手请求，实现ServerEndpointConfig.Configurator 并覆盖modifyHandshake() 方法。 HandshakeRequest 在这里可用作方法参数。您可以将HttpSession 放入EndpointConfig#getUserProperties()。 EndpointConfig 又可用作方法参数@OnOpen。

这是ServerEndpointConfig.Configurator 实现的启动示例：

public class ServletAwareConfig extends ServerEndpointConfig.Configurator {

    @Override
    public void modifyHandshake(ServerEndpointConfig config, HandshakeRequest request, HandshakeResponse response) {
        HttpSession httpSession = (HttpSession) request.getHttpSession();
        config.getUserProperties().put("httpSession", httpSession);
    }

}

这里是你如何使用它，注意@ServerEndpoint的configurator属性：

@ServerEndpoint(value="/your_socket", configurator=ServletAwareConfig.class)
public class YourSocket {

    private EndpointConfig config;

    @OnOpen
    public void onOpen(Session websocketSession, EndpointConfig config) {
        this.config = config;
    }

    @OnMessage
    public void onMessage(String message) {
        HttpSession httpSession = (HttpSession) config.getUserProperties().get("httpSession");
        ServletContext servletContext = httpSession.getServletContext();
        // ...
    }

}

作为设计提示，最好让您的@ServerEndpoint 完全不依赖于servlet API。您最好在modifyHandshake() 实现中立即准确地从servlet 会话或上下文中提取所需的那个 信息（通常是一个可变Javabean），然后将它们放入用户属性映射中。如果你不这样做，那么你应该记住，websocket 会话可以比 HTTP 会话存活得更长。因此，当您仍然将HttpSession 带入端点时，当您尝试在它过期时访问它时，您可能会遇到IllegalStateException。

如果您碰巧手头有 CDI（可能还有 JSF），您可以从 OmniFaces <o:socket> 的源代码中获得灵感（链接在展示的最底部）。

另见：

• Real time updates from database using JSF/Java EE
• Notify only specific user(s) through WebSockets, when something is modified in the database

Answer 3

我在 Tomcat（版本 7.0.56 和 8.0.14）上试用了 BalusC 的答案。在这两个容器上， modifyHandshake 的请求参数不包含 HttpSession（因此不包含 servletContext）。 由于我只需要 servlet 上下文来访问“全局”变量（即 Web 应用程序全局变量），因此我只是将这些变量存储在持有者类的普通静态字段中。这很不雅，但确实有效。

这看起来像是这个特定 tomcat 版本中的一个错误 - 有没有人也看到过这个？

Answer 4

更新了 BalusC 答案的代码，onOpen 方法需要用@OnOpen 修饰。那么就不需要再扩展 Endpoint 类了：

@ServerEndpoint(value="/your_socket", configurator=ServletAwareConfig.class)
public class YourSocket {

    private EndpointConfig config;

    @OnOpen
    public void onOpen(Session websocketSession, EndpointConfig config) {
        this.config = config;
    }

    @OnMessage
    public void onMessage(String message) {
        HttpSession httpSession = (HttpSession) config.getUserProperties().get("httpSession");
        ServletContext servletContext = httpSession.getServletContext();
        // ...
    }

}