修改 PhaseListener 中的 JSF 组件树

Question

我有一个问题。

我实现了一个 PhaseListener，它的目的是向树中附加有消息的任何 UIInput 组件添加样式类，如果没有附加任何消息，则删除该样式类。

PhaseListener 在 RENDER_RESPONSE 阶段运行，并在调试时在 beforePhase 和 afterPhase 方法中工作。在调试时，我发现 beforePhase 无法访问完整的组件树，但 afterPhase 可以。不过，在 afterPhase 中所做的任何更改都不会呈现。

我该怎么办？我希望这完全是服务器端的。

谢谢，

詹姆斯

Answer 1

JSF 组件树仅在视图构建时间之后才可用。 RENDER_RESPONSE 阶段不一定是在渲染之前访问完整 JSF 组件树的好时机。在没有任何 的初始 GET 请求期间，完整的组件树仅在 afterPhase 中可用，因为它是在 RENDER_RESPONSERENDER_RESPONSE 期间构建的代码>.在回发期间，完整的组件树在 beforePhase 中可用，但是，当导航到不同的视图时，它仍然会在期间发生更改。 >RENDER_RESPONSE 阶段，因此任何修改都会丢失。

要了解视图构建时间到底是多少，请转到问题视图构建时间是多少？

您基本上想要挂钩“查看渲染时间”，而不是 RENDER_RESPONSE 阶段的 beforePhase 。 JSF 提供了几种挂接它的方法：

1. 在某些主模板中，将 preRenderView 侦听器附加到 。

   <前><代码>
   
   ...

   public void onPreRenderView(ComponentSystemEvent event) {
       UIViewRoot 视图 = (UIViewRoot) event.getSource();
       // 视图是组件树。这里只需修改一下就可以了。
       // ...
   }        
   

2. 或者，实现一个全局 SystemEventListener 为 PreRenderViewEvent。

   公共类 YourPreRenderViewListener 实现 SystemEventListener {
   
       @覆盖
       公共布尔 isListenerForSource（对象源）{
           返回 UIViewRoot 的源实例；
       }
   
       @覆盖
       公共无效processEvent（系统事件事件）抛出AbortProcessingException {
           UIViewRoot 视图 = (UIViewRoot) event.getSource();
           // 视图是组件树。这里只需修改一下就可以了。
           // ...
       }
   
   }
   

   要使其运行，请按如下方式在 faces-config.xml 中注册它：

   <前><代码><应用程序>
   <系统事件监听器>
   com.example.YourPreRenderViewListener
   <系统事件类>javax.faces.event.PreRenderViewEvent
   
   

3. 或者，提供自定义 ViewHandler 您在其中执行的工作 renderView( ）。

   public class YourViewHandler extends ViewHandlerWrapper {
   
       私有 ViewHandler 包装；
   
       公共 YourViewHandler（ViewHandler 包装）{
           this.wrapped = 包裹;
       }
   
       @覆盖
       公共无效renderView（FacesContext上下文，UIViewRoot视图）{
           // 视图是组件树。这里只需修改一下就可以了。
           // ...
   
           // 最后调用 super 以便 JSF 可以完成渲染工作。
           super.renderView(上下文，视图);
       }
   
       @覆盖
       公共 ViewHandler getWrapped() {
           包裹退回；
       }
   
   }
   

   要使其运行，请在faces-config.xml中进行如下注册：

   <前><代码><应用程序>
   com.example.YourViewHandler;
   

4. 或者，挂接 ViewDeclarationLanguage#renderView()< /a>，但这有点边缘，因为它并不是真正旨在操纵组件树，而是操纵如何渲染视图。

---

与具体问题无关，这一切都不是您问题中所述的具体功能要求的正确解决方案：

这意味着将样式类添加到树中附加了消息的任何 UIInput 组件，如果没有附加任何消息，则删除样式类

寻求客户端解决方案，而不是操作组件树（这最终会处于 JSF 组件状态！）。想象一下迭代组件中输入的情况，例如 。树中实际上只有一个输入组件，而不是多个！通过 UIInput#setStyleClass() 操作样式类将在每次迭代中呈现。

您最好使用 UIViewRoot#visitTree() 访问组件树，如下所示，并收集无效输入组件的所有客户端 ID（此 visitTree() 方法将透明地采用迭代组件考虑）：

Set<String> invalidInputClientIds = new HashSet<>();
view.visitTree(VisitContext.createVisitContext(context, null, EnumSet.of(VisitHint.SKIP_UNRENDERED)), new VisitCallback() {

    @Override
    public VisitResult visit(VisitContext context, UIComponent component) {
        if (component instanceof UIInput) {
            UIInput input = (UIInput) component;

            if (!input.isValid()) {
                invalidInputClientIds.add(input.getClientId(context.getFacesContext()));
            }
        }

        return VisitResult.ACCEPT;
    }
});

然后将 JSON 数组形式的 invalidInputClientIds 传递给 JavaScript，然后 JavaScript 将通过 document.getElementById() 获取它们并更改 className< /代码> 属性。

for (var i = 0; i < invalidInputClientIds.length; i++) {
    var invalidInput = document.getElementById(invalidInputClientIds[i]);
    invalidInput.className += ' error';
}

JSF 实用程序库 OmniFaces 有一个 组件正是这样做的。

Answer 2

使用 ViewHandler 实现，但效率不高。渲染响应阶段的 PhaseListener 无法访问组件树。