ajax - 动态 ajax 导航 <ui :include>

Question

假设我想在我的应用程序中导航，并动态包含不同的 Facelet 页面。我有一个像这样的命令链接:

<h:commandLink value="Link" action="#{navigation.goTo('someTest')}">
    <f:ajax render=":content" />
</h:commandLink>

这就是我包含 Facelet 的地方:

<h:form id="content">
    <ui:include src="#{navigation.includePath}" />
</h:form>

导航类:

public class Navigation {
    private String viewName;

    public void goTo(String viewName) {
        this.viewName = viewName;
    }

    public String getIncludePath() {
        return resolvePath(viewName);
    }
}

我见过类似的例子，但这当然行不通。由于 ui:include 是一个标记处理程序，因此包含发生在调用我的导航监听器之前很久。包含旧的 Facelet，而不是新的 Facelet。到目前为止我明白了。

现在到令人头痛的部分:如何基于actionListener 动态包含facelet？我尝试将facelet 包含在preRender 事件中，并在RENDER_RESPONSE 之前包含phaseListener。两者都有效，但在事件监听器中，我无法包含包含其他 preRender 事件的 Facelet，并且在 PhaseListener 中，在包含的 Facelet 中单击一些后，我会得到重复的 Id。然而，检查组件树告诉我，根本没有重复的组件。也许这两个想法根本就不太好..

我需要一个解决方案，其中带有 ui:include 的页面或包含 Facelet 的 Java 类不必知道将包含哪些页面，也不必知道确切的信息小路。以前有人解决过这个问题吗？我该怎么做？

---

我正在使用 JSF 2.1 和 Mojarra 2.1.15

---

重现问题所需的只是这个 bean:

@Named
public class Some implements Serializable {
    private static final long serialVersionUID = 1L;
    private final List<String> values = new ArrayList<String>();

    public Some() {
        values.add("test");
    }

    public void setInclude(String include) {
    }
    public List<String> getValues() {
        return values;
    }
}

这在你的索引文件中:

<h:head>
    <h:outputScript library="javax.faces" name="jsf.js" />
</h:head>

<h:body>
    <h:form id="topform">
        <h:panelGroup id="container">
            <my:include src="/test.xhtml" />
        </h:panelGroup>
    </h:form>
</h:body>

这在text.xhtml中

<ui:repeat value="#{some.values}" var="val">
    <h:commandLink value="#{val}" action="#{some.setInclude(val)}">
        <f:ajax render=":topform:container" />
    </h:commandLink>
</ui:repeat>

这足以产生如下错误:

javax.faces.FacesException: Cannot add the same component twice: topform:j_id-549384541_7e08d92c

Answer 1

对于OmniFaces ，我也曾经通过创建 <o:include> 来尝试过这一点如 UIComponent 而不是 TagHandler 它执行 FaceletContext#includeFacelet() 在 encodeChildren() 方法。这样，在恢复 View 阶段会记住正确包含的面，并且包含的​​组件树仅在渲染响应阶段发生变化，这正是我们想要实现的构造。

这是一个基本的启动示例:

@FacesComponent("com.example.Include")
public class Include extends UIComponentBase {

    @Override
    public String getFamily() {
        return "com.example.Include";
    }

    @Override
    public boolean getRendersChildren() {
        return true;
    }

    @Override
    public void encodeChildren(FacesContext context) throws IOException {
        getChildren().clear();
        ((FaceletContext) context.getAttributes().get(FaceletContext.FACELET_CONTEXT_KEY)).includeFacelet(this, getSrc());
        super.encodeChildren(context);
    }

    public String getSrc() {
        return (String) getStateHelper().eval("src");
    }

    public void setSrc(String src) {
        getStateHelper().put("src", src);
    }

}

注册于.taglib.xml如下:

<tag>
    <tag-name>include</tag-name>
    <component>
        <component-type>com.example.Include</component-type>
    </component>
    <attribute>
        <name>src</name>
        <required>true</required>
        <type>java.lang.String</type>
    </attribute>
</tag>

这适用于以下 View :

<h:outputScript name="fixViewState.js" />

<h:form>
    <ui:repeat value="#{includeBean.includes}" var="include">
        <h:commandButton value="Include #{include}" action="#{includeBean.setInclude(include)}">
            <f:ajax render=":include" />
        </h:commandButton>
    </ui:repeat>
</h:form>

<h:panelGroup id="include">
    <my:include src="#{includeBean.include}.xhtml" />
</h:panelGroup>

以及以下支持 bean:

@ManagedBean
@ViewScoped
public class IncludeBean implements Serializable {

    private List<String> includes = Arrays.asList("include1", "include2", "include3");
    private String include = includes.get(0);

    private List<String> getIncludes() {
        return includes;
    }

    public void setInclude(String include) {
        return this.include = include;
    }

    public String getInclude() { 
        return include;
    }

}

(此示例期望包含文件 include1.xhtml 、 include2.xhtml 和 include3.xhtml 与主文件位于同一基本文件夹中)

fixViewState.js可以在这个答案中找到:h:commandButton/h:commandLink does not work on first click, works only on second click 。为了修复JSF issue 790，此脚本是必需的。当有多个 ajax 表单更新彼此的父表单时， View 状态会丢失。

另请注意，这样每个包含文件都可以有自己的 <h:form>必要时，因此您不一定需要将其放在包含中。

这种方法在 Mojarra 中工作得很好，即使回发请求来自包含内的表单，但它在 MyFaces 中很难失败，在初始请求期间已经出现以下异常:

java.lang.NullPointerException
    at org.apache.myfaces.view.facelets.impl.FaceletCompositionContextImpl.generateUniqueId(FaceletCompositionContextImpl.java:910)
    at org.apache.myfaces.view.facelets.impl.DefaultFaceletContext.generateUniqueId(DefaultFaceletContext.java:321)
    at org.apache.myfaces.view.facelets.compiler.UIInstructionHandler.apply(UIInstructionHandler.java:87)
    at javax.faces.view.facelets.CompositeFaceletHandler.apply(CompositeFaceletHandler.java:49)
    at org.apache.myfaces.view.facelets.tag.ui.CompositionHandler.apply(CompositionHandler.java:158)
    at org.apache.myfaces.view.facelets.compiler.NamespaceHandler.apply(NamespaceHandler.java:57)
    at org.apache.myfaces.view.facelets.compiler.EncodingHandler.apply(EncodingHandler.java:48)
    at org.apache.myfaces.view.facelets.impl.DefaultFacelet.include(DefaultFacelet.java:394)
    at org.apache.myfaces.view.facelets.impl.DefaultFacelet.include(DefaultFacelet.java:448)
    at org.apache.myfaces.view.facelets.impl.DefaultFacelet.include(DefaultFacelet.java:426)
    at org.apache.myfaces.view.facelets.impl.DefaultFaceletContext.includeFacelet(DefaultFaceletContext.java:244)
    at com.example.Include.encodeChildren(Include.java:54)

MyFaces 基本上在 View 构建时间结束时释放 Facelet 上下文，使其在 View 渲染时间期间不可用，从而导致 NPE，因为内部状态具有多个无效属性。但是，可以在渲染期间添加单独的组件而不是 Facelet 文件。我真的没有时间去调查这是我的错还是 MyFaces 的错。这也是它尚未出现在 OmniFaces 中的原因。

如果您正在使用 Mojarra，请随意使用它。然而，我强烈建议在同一页面上使用所有可能的用例对其进行彻底测试。 Mojarra 有一些与状态保存相关的怪癖，在使用此构造时可能会失败。