Достъп до ServletContext и HttpSession в @OnMessage на JSR-356 @ServerEndpoint

Сървлетът HttpSession е в JSR-356, достъпен от HandshakeRequest#getHttpSession(), което от своя страна е достъпно, когато се направи заявка за ръкостискане точно преди @OnOpen от @ServerEndpoint. 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);
    }

}

Ето как можете да го използвате, обърнете внимание на configurator атрибут на @ServerEndpoint:

@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 напълно свободен от зависимости на API на сървлета. Бихте могли в modifyHandshake() изпълнението по-добре веднага да извлечете точно тази информация (обикновено променлив Javabean), от която се нуждаете от сесията на сървлета или контекста, и вместо това да ги поставите в картата на потребителските свойства. Ако не направите това, тогава трябва да имате предвид, че една websocket сесия може да живее по-дълго от HTTP сесията. Така че, когато все още носите около HttpSession в крайната точка, тогава може да се натъкнете на IllegalStateException, когато се опитате да получите достъп до него, докато е изтекъл.

В случай, че случайно имате CDI (и може би JSF) под ръка, може да почерпите вдъхновение от изходния код на OmniFaces <o:socket> (връзките са в най-долната част на витрината).

Вижте също:

• Актуализации в реално време от база данни с помощта на JSF/Java EE
• Уведомяване само на конкретен потребител(и) чрез WebSockets, когато нещо е променено в базата данни

Актуализиран код за отговора на 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();
        // ...
    }

}

Изпробвах отговора на BalusC на Tomcat (версии 7.0.56 и 8.0.14). И в двата контейнера параметърът на заявката на modifyHandshake не съдържа HttpSession (и следователно няма servletContext). Тъй като имах нужда от контекста на сървлета само за достъп до "глобални" променливи (т.е. глобални за уеб приложение), аз просто съхраних тези променливи в обикновено статично поле на клас притежател. Това е неелегантно, но проработи.

Това изглежда като грешка в тази конкретна версия на tomcat - някой виждал ли е това?

Понякога не можем да получим session с над ServletAwareConfig на BalusC, това е така, защото сесията все още не е създадена. тъй като ние не търсим сесия, а 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) {
        }
    }

}

ако искаме init сесия веднага, можем да извикаме request.getSession().

Реф.: https://stackoverflow.com/questions/20240591/websocket-httpsession-returns-null