看一下即将发布的JSF 2.3 Push支持

最新推荐文章于 2022-01-21 10:14:10 发布

dnc8371

最新推荐文章于 2022-01-21 10:14:10 发布

阅读量205

点赞数

文章标签： java python websocket socket javascript ViewUI

如前几篇文章所述，下一版本的JavaServer Faces（Mojarra）已添加了许多增强功能。 JSF 2.3计划于2017年与Java EE 8一起发布，但是您现在可以通过从源代码构建或运行里程碑版本来尝试JSF的一些增强和更新，以进行测试。

对API的此类增强之一是通过f:websocket标签和Push API添加了基于单向（服务器到客户端）的websocket推送通信。 OmniFaces团队开发了基于o：socket的JSF解决方案，该解决方案是OmniFaces实用程序库的一部分。具体来说，JSR 372专家组成员Bauke Scholtz和Arjan Tijms对Mojarra代码库做出了此以及许多其他增强和修复。

启用f:websocket支持的补丁尚未应用于Mojarra 2.3分支，但是您可以从发行版JAVASERVERFACES_SPEC_PUBLIC-1396获得补丁。在将修补程序应用于本地Mojarra克隆之前，应确保从中央2.3分支更新源，以确保已应用最新更新。用法很简单，非常类似于OmniFaces站点上有据可查的o:socket功能，请执行以下步骤来使用f:websocket 。

首先，添加

javax.faces.ENABLE_WEBSOCKET_ENDPOINT

应用程序的web.xml的context参数，并将其值设置为true。

<context-param>
    <param-name>javax.faces.ENABLE_WEBSOCKET_ENDPOINT</param-name>
    <param-value>true</param-value>
 </context-param>

客户端代码

在您的客户端（JSF视图）上，添加f:websocket标记，并指定要连接的通道。您还必须指定一个onmessage侦听器，该侦听器将在收到消息后执行指定JavaScript函数。还可以指定可选属性onclose ，以允许指定JavaScript函数在连接关闭时执行。在以下示例中，我们指定套接字将与名为dukeSocketListener的onmessage侦听器连接到名为“ duke”的通道：

<f:websocket channel="duke" onmessage="dukeMessageListener"/>

可以使用三个参数（推送消息JSON对象，通道名称，消息事件）调用onmessage侦听器。如果您只是希望传递一条消息，它可能类似于以下内容：

function dukeMessageListener(message) {
        PF('broadcastGrowl').show(message);
}

如果指定了可选的onclose侦听器，则相应的函数可以接受三个参数（关闭原因码–整数，通道名称，消息事件），但仅需要第一个。

在大多数情况下，其目的是向服务器发送一条消息，以通知具有相同websocket通道规范的所有客户端视图。 f:websocket上有一个可选的scope属性，可以将其设置为“ session”，这会将消息限制为仅在当前会话中使用相同websocket通道的所有客户端视图。

最后，如果需要，可以将可选port属性设置为指定除HTTP端口以外的TCP端口号。

服务器端代码

由于我们计划将消息从服务器推送到所有连接的客户端，因此让我们看一下服务器端代码。可以通过包含@Push批注将新的PushContext注入到任何CDI工件中，并且上下文名称可以对应于通道名称，或者可以在@Push批注上指定可选的channel属性以指示要访问的通道该消息应广播。

@Inject @Push
    private PushContext duke;
...
public void sendMessage(Object message){
    duke.send(message);
}

该消息将被编码为JSON，并传递到为f:websocket的onmessage属性指定的客户端上JavaScript函数的message参数。可以发送任何类型的容器作为消息，可以是普通的String，JavaBean，Map，Collection等。

用法示例

假设我们有一个用于Web应用程序的管理控制台，并且我们想为管理员提供一种向客户端发出警报的方法。这样，管理控制台可以具有用于消息输入的文本区域，以及用于调用消息发送的命令按钮。

<h:inputText id="pushMessage" value="#{testBean.pushMessage}"/>
<h:commandButton action="#{testBean.sendAdminMessage}" value="Send Message"/>

然后，JSF控制器类testBean将具有sendAdminMessage方法，该方法将存储在pushMessage字符串中的消息发送到我们的sendMessage方法。

@Inject @Push
    private PushContext duke;

...

public void sendAdminMessage(){
    sendMessage(pushMessage);
    FacesContext.getCurrentInstance().addMessage(null, new FacesMessage("Message has been broadcasted"));
}

...

public void sendMessage(Object message){

    duke.send(message);
}

任何将收到消息的客户端都应包含f:websocket标记，指向duke通道。客户端还应该至少包括在收到消息时要调用JavaScript函数。

<f:websocket channel="duke" onmessage="dukeMessageListener"/>


<p:growl id="messages"/>


function dukeMessageListener(message) {
        facesmessage.severity = 'info';
        PF('broadcastGrowl').show(message);
}

在此特定示例中，PrimeFaces咆哮消息组件将在收到消息时进行更新。

由于JSR 372专家组成员的所有杰出贡献，JSF 2.3的状态良好。