什么可以<f:metadata> ,<f:viewParam> 和<f:viewAction>用于?

Question

任何人都可以澄清我们一般如何使用这个片段，或者在现实世界中的例子吗？

<f:metadata>
    <f:viewParam id="id" value="#{bean.id}" />
    <f:viewAction action="#{bean.init}" />
</f:metadata>

Answer 1

处理GET参数

<f:viewParam>管理 GET 参数的设置、转换和验证。 它就像<h:inputText> ，但是对于 GET 参数。

下面的例子

<f:metadata>
    <f:viewParam name="id" value="#{bean.id}" />
</f:metadata>

基本上执行以下操作：

• 通过名称id获取请求参数值。
• 如有必要，转换并验证它（您可以使用required 、 validator和converter属性并在其中嵌套<f:converter>和<f:validator> ，就像<h:inputText> ）
• 如果转换和验证成功，则将其设置为由#{bean.id}值表示的 bean 属性，或者如果value属性不存在，则将其设置为 name id上的请求属性，以便它在#{id}中可用风景。

因此，当您以foo.xhtml?id=10打开页面时，参数值10以这种方式在 bean 中设置，就在视图呈现之前。

至于验证，以下示例将参数设置为required="true"并仅允许 10 到 20 之间的值。任何验证失败都会导致显示一条消息。

<f:metadata>
    <f:viewParam id="id" name="id" value="#{bean.id}" required="true">
        <f:validateLongRange minimum="10" maximum="20" />
    </f:viewParam>
</f:metadata>
<h:message for="id" />

---

对 GET 参数执行业务操作

您可以<f:viewAction>使用<f:viewAction> 。

<f:metadata>
    <f:viewParam id="id" name="id" value="#{bean.id}" required="true">
        <f:validateLongRange minimum="10" maximum="20" />
    </f:viewParam>
    <f:viewAction action="#{bean.onload}" />
</f:metadata>
<h:message for="id" />

和

public void onload() {
    // ...
}

然而<f:viewAction>自 JSF 2.2 以来是新的（ <f:viewParam>自 JSF 2.0 以来已经存在）。 如果您无法升级，那么最好的办法是使用<f:event>代替。

<f:event type="preRenderView" listener="#{bean.onload}" />

然而，这在每个请求上都会被调用。 您需要明确检查请求是否不是回发：

public void onload() {
    if (!FacesContext.getCurrentInstance().isPostback()) {
        // ...
    }
}

如果您还想跳过“转换/验证失败”的情况，请执行以下操作：

public void onload() {
    FacesContext facesContext = FacesContext.getCurrentInstance();
    if (!facesContext.isPostback() && !facesContext.isValidationFailed()) {
        // ...
    }
}

以这种方式使用<f:event>本质上是一种解决方法/hack，这正是在 JSF 2.2 中引入<f:viewAction>原因。

---

将视图参数传递给下一个视图

您可以通过将includeViewParams属性设置为true或添加includeViewParams=true请求参数来“传递”导航链接中的视图参数。

<h:link outcome="next" includeViewParams="true">
<!-- Or -->
<h:link outcome="next?includeViewParams=true">

使用上面的<f:metadata>示例基本上生成以下链接

<a href="next.xhtml?id=10">

与原始参数值。

这种方法只需要next.xhtml在同一个参数上也有一个<f:viewParam> ，否则它不会被传递。

---

在 JSF 中使用 GET 表单

<f:viewParam>还可以与“纯 HTML”GET 表单结合使用。

<f:metadata>
    <f:viewParam id="query" name="query" value="#{bean.query}" />
    <f:viewAction action="#{bean.search}" />
</f:metadata>
...
<form>
    <label for="query">Query</label>
    <input type="text" name="query" value="#{empty bean.query ? param.query : bean.query}" />
    <input type="submit" value="Search" />
    <h:message for="query" />
</form>
...
<h:dataTable value="#{bean.results}" var="result" rendered="#{not empty bean.results}">
     ...
</h:dataTable>

基本上这个@RequestScoped bean：

private String query;
private List<Result> results;

public void search() {
    results = service.search(query);
}

请注意， <h:message>用于<f:viewParam> ，而不是纯 HTML <input type="text"> ！ 另请注意，当#{bean.query}为空时，输入值会显示#{param.query} ，因为否则当出现验证或转换错误时，提交的值根本不会显示。 请注意，此构造对于 JSF 输入组件无效（它已经在“幕后”这样做了）。

---

也可以看看：

• ViewParam vs @ManagedProperty(value = "#{param.id}")
• JSF 2.0 中的通信 - 处理 GET 请求参数

Answer 2

将参数从 View 发送到另一个 View，从 Sender View 到 Receiver View 使用 viewParam 和 includeViewParams=true

在发件人中

1. 声明要发送的参数。 我们可以发送字符串、对象、...

发件人.xhtml

<f:metadata>
      <f:viewParam name="ID" value="#{senderMB._strID}" />
</f:metadata>

2. 我们将发送参数 ID，它将包含在“includeViewParams=true”中，作为点击按钮事件的返回字符串 点击按钮使用来自 senderMB._arrData 的 dto 触发 senderMB.clickBtnDetail(dto)

发件人.xhtml

<p:dataTable rowIndexVar="index" id="dataTale"value="#{senderMB._arrData}" var="dto">
      <p:commandButton action="#{senderMB.clickBtnDetail(dto)}" value="見る" 
      ajax="false"/>
</p:dataTable>

在 senderMB.clickBtnDetail(dto) 中，我们使用从按钮事件 (dto) 获得的参数分配 _strID，这里是 Sender_DTO 并分配给 senderMB._strID

Sender_MB.java
    public String clickBtnDetail(sender_DTO sender_dto) {
        this._strID = sender_dto.getStrID();
        return "Receiver?faces-redirect=true&includeViewParams=true";
    }

点击后的链接会变成http://localhost:8080/my_project/view/Receiver.xhtml?*ID=12345*

在接收

1. 获取viewParam Receiver.xhtml 在Receiver中我们声明f:viewParam从get请求（receive）中获取param，receiver的param名称必须与sender（page）一致

接收器.xhtml

<f:metadata><f:viewParam name="ID" value="#{receiver_MB._strID}"/></f:metadata>

它将从发送者视图中获取参数 ID 并分配给接收者_MB._strID

2. 使用 viewParam 在 Receiver 中，我们希望在页面渲染之前的 sql 查询中使用此参数，以便我们使用 preRenderView 事件。 我们不会使用构造函数，因为构造函数会在收到 viewParam 之前被调用 所以我们添加

接收器.xhtml

<f:event listener="#{receiver_MB.preRenderView}" type="preRenderView" />

进入 f:metadata 标签

接收器.xhtml

<f:metadata>
<f:viewParam name="ID" value="#{receiver_MB._strID}" />
<f:event listener="#{receiver_MB.preRenderView}"
            type="preRenderView" />
</f:metadata>

现在我们想在我们的读取数据库方法中使用这个参数，它可以使用

Receiver_MB.java
public void preRenderView(ComponentSystemEvent event) throws Exception {
        if (FacesContext.getCurrentInstance().isPostback()) {
            return;
        }
        readFromDatabase();
    }
private void readFromDatabase() {
//use _strID to read and set property   
}