组件系列,组件类型和渲染器类型之间的关系是什么?

时间:2011-11-10 08:21:32

标签: java jsf java-ee custom-component renderer

当我在JSF中学习自定义组件开发时,我对组件系列,组件类型和渲染器类型之间的关系感到困惑。例如,我注册了一个渲染器和一个自定义组件,如下所示。

faces-config.xml

<component>
    <component-type>study.faces.Div</component-type>
    <component-class>javax.faces.component.UIPanel</component-class>
</component>

<render-kit>
    <render-kit-id>HTML_BASIC</render-kit-id>
    <renderer>
        <component-family>javax.faces.Panel</component-family>
        <renderer-type>study.faces.DivRenderer</renderer-type>
        <renderer-class>com.study.ui.DivRenderer</renderer-class>
    </renderer>
</render-kit>

我还在my.taglib.xml文件中注册了一个新标记,如下所示:

<tag>
    <tag-name>div</tag-name>
    <component>
        <component-type>study.faces.Div</component-type>
        <renderer-type>study.faces.DivRenderer</renderer-type>
    </component>
</tag>

此配置非常有效。但是,我不明白为什么在渲染器注册时需要行<component-family>javax.faces.Panel</component-family>。在my.taglib.xml中,组件和渲染器已连接,恕我直言,它应该足以为组件选择合适的渲染器。附加参数<component-family>的用途是什么?

我做了谷歌研究,我得到的所有答案都说“一个渲染器可用于渲染多个组件。这些组件属于一个系列”。但这些陈述并没有明确我的困惑。有人可以解释组件类型,组件系列和渲染器选择策略之间的关系吗? (希望有一个很好的例子。)

2 个答案:

答案 0 :(得分:35)

渲染器由组件系列选择,而不是您所期望的组件类型。

让我们引用JSF 2.0 specification

  

3.1.2组件类型

     

虽然不是UIComponent的属性,但component-type是与每个UIComponent子类相关的重要数据,允许Application实例创建UIComponent子类的新实例。那种类型。有关组件类型的更多信息,请参见第7.1.11节“对象工厂”。

     

3.1.3组件系列

     

每个标准用户界面组件类都具有组件系列的标准值,用于查找与此组件关联的渲染器。通用UIComponent类的子类通常会从其超类继承此属性,因此只需要超类的渲染器仍然可以处理专门的子类。

基本上,组件类型对于JSF是必需的,以便通过Application#createComponent()方法创建组件。

UIComponent component = context.getApplication().createComponent("study.faces.Div");

这样做的好处是组件study.faces.Div不是编译时依赖项,因此提供了运行时多态性和可插入性的可能性(如果您熟悉JDBC's Class#forName() mechanism and its factories,那么您将更好地理解该部分)。

每个组件类型属于一个可包含一个或多个组件的系列。根据组件系列和渲染器类型RenderKit#getRenderer()

选择渲染器
Renderer renderer = context.getRenderKit().getRenderer(component.getFamily(), component.getRendererType());

根据组件类型和渲染器类型选择渲染器。这允许为属于组件系列的多个组件类型重用渲染器。否则,您需要为每个组件注册一个渲染器,即使这些组件可以共享同一个渲染器。

以下faces-config.xml条目

<component>
    <component-type>study.faces.Div</component-type>
    <component-class>javax.faces.component.UIPanel</component-class>
</component>

告诉JSF,只要创建给定组件类型的组件,Application就应该创建给定组件类的实例。在那里没有指定组件系列,因为component.getFamily()已经隐含地知道它。

以下faces-config.xml条目

<render-kit>
    <renderer>
        <component-family>javax.faces.Panel</component-family>
        <renderer-type>study.faces.DivRenderer</renderer-type>
        <renderer-class>com.study.ui.DivRenderer</renderer-class>
    </renderer>
</render-kit>

告诉JSF,只要请求了给定组件系列和渲染器类型的渲染器,RenderKit就应该返回给定渲染器类的实例。

以下.taglib.xml条目

<tag>
    <tag-name>div</tag-name>
    <component>
        <component-type>study.faces.Div</component-type>
        <renderer-type>study.faces.DivRenderer</renderer-type>
    </component>
</tag>

告诉JSF(好吧,Facelets),给定标记应该在视图根中创建给定组件类型的组件(其类已在faces-config.xml中定义),并且其渲染器类型应设置为给定渲染器类型。请注意,组件类型用于选择渲染器,而是用于在视图根中创建组件。另请注意,渲染器类型条目是可选的。否则将使用组件自己的预定义渲染器类型。这允许使用不同的渲染器类型重用现有的组件类型。

答案 1 :(得分:3)

javadocgetFamily()

  

返回此组件所在的组件系列的标识符   所属。这个标识符,连同的值   rendererType属性,可用于select相应的属性   此组件实例的Renderer

维护者的基本原理包含在the JSF specification

  

组件系列

     

每个标准用户界面组件类都有一个标准值   组件系列,用于查找关联的渲染器   有了这个组件。通用UIComponent类的子类   通常会从其超类继承此属性,以便   只期望超类的渲染器仍然可以处理   专门的子类。

我将此解释为提供了一些超出Java类类型的额外类型检查的能力(因为子类将始终是子类。)我不确定这是多么有用。