自定义标记属性泄漏到子标记中

我们的应用程序使用的是Mojarra 2.1.29-03，我们的自定义标签中的属性出现了问题，因为它们也被复制到嵌套标签中。

例如，给定以下标签定义:

cc.taglib.xml

<?xml version="1.0" encoding="UTF-8" ?>
<facelet-taglib version="2.0" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facelettaglibrary_2_0.xsd">
    <namespace>http://temp.com/jsf/customcomponents</namespace>
    <tag>
        <tag-name>wrapper</tag-name>
        <source>wrapper.xhtml</source>
        <attribute>
            <description>The style class for the component</description>
            <name>styleClass</name>
        </attribute>
    </tag>
</facelet-taglib>

wrapper.xhtml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <ui:component xmlns:ui="http://java.sun.com/jsf/facelets">
        <div style="border: 1px solid black; margin: 5px;">
            <p>styleClass: #{styleClass}</p>
            <ui:insert />
        </div>
    </ui:component>
</html>

和客户端页面:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:cc="http://temp.com/jsf/customcomponents">
     <h:body>
        <cc:wrapper styleClass="cc-style">
            <cc:wrapper />
        </cc:wrapper>
    </h:body>
</html>

结果如下:

styleClass: cc-style
styleClass: cc-style

…所以styleClass属性也被应用到内部标签，即使客户端页面没有设置它。

我们已经注意到，如果没有显式设置，我们可以通过处理所有客户端页面来设置styleClass="来解决这个问题，但这是我们想要避免的方法(这是一个非常丑陋的解决方案，并且不能强制执行)。

这是一个bug吗?除了上面提到的方法之外，还有其他方法可以解决这个问题吗?最好是在标记中而不是在客户端页面中解决这个问题。

谢谢艾弗

严格来说这不是一个bug，但这确实是不直观和不希望的行为，应该在JSF/Facelets规范中解决。

解决方案不是简单的，需要一个自定义标记处理程序来清除Facelet范围。JSF实用程序库OmniFaces从2.1版开始就有了这样一个:<o:tagAttribute>(源代码在这里)。

用法(请注意prolog, doctype和html标签是不必要的，这是整个文件):

<ui:composition 
    xmlns="http://www.w3.org/1999/xhtml"
    xmlns:ui="http://java.sun.com/jsf/facelets"
    xmlns:o="http://omnifaces.org/ui"
>
    <o:tagAttribute name="styleClass" />
    <div style="border: 1px solid black; margin: 5px;">
        <p>styleClass: #{styleClass}</p>
        <ui:insert />
    </div>
</ui:composition>

与具体问题无关，这不是一个自定义组件，而是一个标记文件。在JSF 2中。在X中，术语"cc"通常与复合组件相关联，这是一个完全不同的主题。为了获得正确的知识和术语(以便在阅读自己或他人的代码时不会混淆自己或他人)，请参阅何时使用、标记文件、组合组件和/或自定义组件?

对于信息，我们确定了一种可能对其他人有用的替代方法，因为它更容易实现和理解。

首先，我需要为我们所处的情况添加一些背景……我们最近从2.1.12迁移到2.1.29-03，作为该过程的一部分，我们将一个构建块从复合组件(其属性具有隔离作用域)更改为自定义标记(具有上述行为)。关于自定义标签属性的相同行为存在于2.1.12中，但我们没有意识到这一点，所以我们考虑了以下方法，因为它将恢复我们在迁移之前的行为，因为我们只需要将其应用于我们更改的组件。

wrapper.xhtml(我已将名称空间更改为'ct'而不是'cc')

<ui:component xmlns:ct="http://temp.com/jsf/customtags" xmlns:ui="http://java.sun.com/jsf/facelets">
    <ct:tagAttribute name="styleClass" />
    <div style="border: 1px solid black; margin: 5px;">
        <p>styleClass: #{styleClass}</p>
        <ct:eraseAttribute name="styleClass" />
        <ui:insert />
    </div>
</ui:component>

其中tagAttribute是BalusC建议的解决方案，以防止标记从其父属性继承属性，此外，我们在调用ui:insert之前调用eraseAttribute标记以从范围中删除属性(这显然要求自定义标记完成属性)。这意味着这个标签既不继承也不泄漏属性，而其他标签可以保持不变，并保持迁移之前的相同行为。

ct.taglib.xhtml(片段)

<tag>
    <tag-name>eraseAttribute</tag-name>
    <handler-class>com.temp.jsf.customtags.EraseTagAttribute</handler-class>
    <attribute>
        <name>name</name>
        <required>true</required>
        <type>java.lang.String</type>
    </attribute>
</tag>

EraseTagAttribute.java

package com.temp.jsf.customtags;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.view.facelets.FaceletContext;
import javax.faces.view.facelets.TagConfig;
import javax.faces.view.facelets.TagHandler;
public class EraseTagAttribute extends TagHandler {
    private final String name;
    public EraseTagAttribute(TagConfig config) {
        super(config);
        name = getRequiredAttribute("name").getValue();
    }
    public void apply(FaceletContext context, UIComponent parent) throws IOException {
        context.getVariableMapper().setVariable(name, null);
    }
}

最终我们没有使用它，因为我们觉得BalusC提供的答案(我们将其应用于所有自定义标签中的每个属性)是正确和更清晰的方法，尽管它可能在我们非常特殊的情况下产生额外的后果。

相关内容

最新更新

热门标签：