Echtzeit-Updates von der Datenbank mit JSF / Java EE

Vorwort

In dieser Antwort nehme ich an, dass die folgenden:

• Sie sind nicht daran interessiert, mit <p:push> (ich lasse den genauen Grund in der Mitte, du bist wenigstens daran interessiert, mit der neuen Java-EE-7 /JSR356 WebSocket-API).
• Sie möchten eine Anwendung Gültigkeitsbereich push (d.h. alle Benutzer bekommt die gleichen push-Nachricht auf einmal; daher sind Sie nicht daran interessiert, eine Sitzung oder anzeigen Gültigkeitsbereich push).
• Die Sie aufrufen möchten, drücken Sie direkt aus der (MySQL) DB-Seite (also Sie sind nicht daran interessiert, aufrufen drücken von JPA-Seite unter Verwendung einer entity-listener). Bearbeiten: ich werde die beiden Schritte sowieso. Schritt 3a beschrieben, DB-trigger und Schritt 3b beschrieben, JPA auslösen. Verwenden Sie entweder-oder, nicht beides!

1. Erstellen eines WebSocket endpoint

Erstellen Sie zuerst eine @ServerEndpoint - Klasse, die im Grunde sammelt alle websocket-Sitzungen in einer Anwendung, die weit gesetzt. Beachten Sie, dass dies in diesem speziellen Beispiel nur static wie jedes websocket-Sitzung grundsätzlich bekommt seine eigene @ServerEndpoint Instanz (Sie sind im Gegensatz zu servlets somit staatenlos.

@ServerEndpoint("/push")
public class Push {

    private static final Set<Session> SESSIONS = ConcurrentHashMap.newKeySet();

    @OnOpen
    public void onOpen(Session session) {
        SESSIONS.add(session);
    }

    @OnClose
    public void onClose(Session session) {
        SESSIONS.remove(session);
    }

    public static void sendAll(String text) {
        synchronized (SESSIONS) {
            for (Session session : SESSIONS) {
                if (session.isOpen()) {
                    session.getAsyncRemote().sendText(text);
                }
            }
        }
    }

}

Dem obigen Beispiel hat eine zusätzliche Methode sendAll() sendet die angegebene Nachricht an alle offenen websocket-sessions (d.h. application scoped-push). Beachten Sie, dass diese Meldung kann auch ganz gut einen JSON-string.

Wenn Sie wollen, explizit speichern Sie Sie im Anwendungs-Bereich (oder (HTTP) session-scope), dann kann Ihnen der ServletAwareConfig Beispiel in diese Antwort. Sie wissen, ServletContext Attribute anzeigen zu ExternalContext#getApplicationMap() im JSF - (und HttpSession Attribute anzeigen zu ExternalContext#getSessionMap()).

2. Öffnen Sie die WebSocket-client-Seite und hören Sie auf es

Verwenden Sie dieses Stück JavaScript zum öffnen einer websocket und hören Sie auf ihn:

if (window.WebSocket) {
    var ws = new WebSocket("ws://example.com/contextname/push");
    ws.onmessage = function(event) {
        var text = event.data;
        console.log(text);
    };
}
else {
    //Bad luck. Browser doesn't support it. Consider falling back to long polling.
    //See http://caniuse.com/websockets for an overview of supported browsers.
    //There exist jQuery WebSocket plugins with transparent fallback.
}

Ab jetzt ist es lediglich die Anmeldung der eingeschobenen text. Wir möchten mit diesem text als eine Anleitung zum aktualisieren der menu-Komponente. Für dass, wir müssten eine zusätzliche <p:remoteCommand>.

<h:form>
    <p:remoteCommand name="updateMenu" update=":menu" />
</h:form>

Vorstellen, dass Sie senden eine JS-Funktion den Namen als text Push.sendAll("updateMenu")dann könnte man interpretieren, und lösen Sie es wie folgt:

    ws.onmessage = function(event) {
        var functionName = event.data;
        if (window[functionName]) {
            window[functionName]();
        }
    };

Wieder, wenn über einen JSON-string als Nachricht (die könnte man analysieren, indem $.parseJSON(event.data)), mehr Dynamik möglich ist.

3a. Entweder trigger WebSocket push von DB-Seite

Nun müssen wir den Befehl auslösen Push.sendAll("updateMenu") von der DB-Seite. Eine der einfachsten Möglichkeiten, es zu lassen die DB-Feuer eine HTTP-Anfrage an einen web service. Ein plain-vanilla-servlet ist mehr als ausreichend, um zu handeln wie ein web-service:

@WebServlet("/push-update-menu")
public class PushUpdateMenu extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        Push.sendAll("updateMenu");
    }

}

Haben Sie natürlich die Möglichkeit zur Parametrisierung der push-Nachricht basiert auf request-Parameter-oder Pfad-info, wenn nötig. Vergessen Sie nicht, die Durchführung von Sicherheitsüberprüfungen, wenn der Anrufer darf auch aufrufen, servlet, sonst jemand in der Welt außer der DB selbst würde in der Lage sein, um es aufzurufen. Sie könnten überprüfen Sie die Anrufer-IP-Adresse, zum Beispiel, das ist praktisch, wenn beide DB-server und web-server laufen auf der gleichen Maschine.

Damit die DB das Feuer ein HTTP-request an das servlet, die Sie benötigen, erstellen Sie eine wiederverwendbare eine gespeicherte Prozedur, die im Grunde startet das Betriebssystem bestimmte Befehle ausführen eines HTTP GET-Anforderung, z.B. curl. MySQL nicht nativ unterstützt die Ausführung einer OS-spezifischen Befehl, so müssten Sie installieren eine benutzerdefinierte Funktion (UDF) für das erste. Bei mysqludf.org finden Sie eine Reihe von denen SYS ist von unserem Interesse. Es enthält die sys_exec() Funktion, die wir brauchen. Wenn es installiert ist, erstellen Sie die folgende gespeicherte Prozedur in MySQL:

DELIMITER //
CREATE PROCEDURE menu_push()
BEGIN 
SET @result = sys_exec('curl http://example.com/contextname/push-update-menu'); 
END //
DELIMITER ;

Erstellen Sie jetzt insert/update/delete-Trigger wird aufgerufen (vorausgesetzt, die Tabelle Namen benannt ist menu):

CREATE TRIGGER after_menu_insert
AFTER INSERT ON menu
FOR EACH ROW CALL menu_push();

CREATE TRIGGER after_menu_update
AFTER UPDATE ON menu
FOR EACH ROW CALL menu_push();

CREATE TRIGGER after_menu_delete
AFTER DELETE ON menu
FOR EACH ROW CALL menu_push();

3b. Oder trigger WebSocket push von JPA-Seite

Wenn Ihre Anforderung/situation es erlaubt, zu hören auf der JPA-entity-change-events nur, und damit externe änderungen an der DB macht nicht behandelt werden müssen, dann können Sie statt DB-Trigger wie beschrieben in Schritt 3a auch nur mit einem JPA-entity-change-listener. Du kannst dich doch über @EntityListeners annotation auf der @Entity Klasse:

@Entity
@EntityListeners(MenuChangeListener.class)
public class Menu {
    //...
}

Wenn Sie geschehen, verwenden Sie eine einzelne web-Profil, Projekt, wobei alles (EJB/JPA/JSF) geworfen zusammen in das gleiche Projekt, dann kann man nur noch direkt aufrufen Push.sendAll("updateMenu").

public class MenuChangeListener {

    @PostPersist
    @PostUpdate
    @PostRemove
    public void onChange(Menu menu) {
        Push.sendAll("updateMenu");
    }

}

Jedoch in "enterprise-Projekte" -, service-Ebene code (EJB/JPA/etc) ist in der Regel getrennt im EJB-Projekt, während web-layer code (JSF/Servlets/WebSocket/etc) ist gehalten, die in ein Web-Projekt. Die EJB-Projekt sollte keine einzige Abhängigkeit von web-Projekt. In diesem Fall würden Sie besser Feuer CDI Event statt, die das Web-Projekt könnte @Observes.

public class MenuChangeListener {

    //Outcommented because it's broken in current GF/WF versions.
    //@Inject
    //private Event<MenuChangeEvent> event;

    @Inject
    private BeanManager beanManager;

    @PostPersist
    @PostUpdate
    @PostRemove
    public void onChange(Menu menu) {
        //Outcommented because it's broken in current GF/WF versions.
        //event.fire(new MenuChangeEvent(menu));

        beanManager.fireEvent(new MenuChangeEvent(menu));
    }

}

(Hinweis: die outcomments; die Injektion eines CDI - Event kaputt ist, sowohl GlassFish und WildFly in den aktuellen Versionen (4.1 /8.2); die Problemumgehung feuert das Ereignis über BeanManager statt; wenn dies immer noch nicht funktioniert, die CDI-1.1 alternative ist CDI.current().getBeanManager().fireEvent(new MenuChangeEvent(menu)))

public class MenuChangeEvent {

    private Menu menu;

    public MenuChangeEvent(Menu menu) {
        this.menu = menu;
    }

    public Menu getMenu() {
        return menu;
    }

}

Und dann im web-Projekt:

@ApplicationScoped
public class Application {

    public void onMenuChange(@Observes MenuChangeEvent event) {
        Push.sendAll("updateMenu");
    }

}

Update: zum 1. april 2016 (ein halbes Jahr nach der vorigen Antwort), OmniFaces eingeführt mit version 2.3 der <o:Buchse> sollte dies alles weniger umständlich. Die kommende JSF 2.3 <f:websocket> basiert weitgehend auf <o:socket>. Siehe auch Wie kann man server-push-asynchrone änderungen an einer HTML-Seite erstellt von JSF?

InformationsquelleAutor der Antwort BalusC

PrimeFaces hat Umfrage Funktionen zum aktualisieren der Komponente automatisch. Im folgenden Beispiel <h:outputText> wird automatisch aktualisiert, alle 3 Sekunden durch <p:poll>.

Wie zu informieren, die damit verbundenen clients und aktualisieren Sie die oben genannten CSS-Menüs mit der aktuellen Werte aus der Datenbank?

Erstellen einer listener-Methode wie process() wählen Sie Ihr Menü Daten. <p:poll> wird automatisch aktualisieren Sie Ihre menu-Komponente.

<h:form>
    <h:outputText id="count"
                  value="#{AutoCountBean.count}"/> <!-- Replace your menu component-->

    <p:poll interval="3" listener="#{AutoCountBean.process}" update="count" />
</h:form>

@ManagedBean
@ViewScoped
public class AutoCountBean implements Serializable {

    private int count;

    public int getCount() {
        return count;
    }

    public void process() {
        number++; //Replace your select data from db.
    }
}   

InformationsquelleAutor der Antwort CycDemo