第 6 步:声明 scriptlet 变量 | 第 8 页(共9 页) |
要理解 scriptlet 变量,必须理解 TLD 文件的作用。这个文件基本上是元数据的一个储存库,当 JSP 页转换为 servlet 时,标签会使用这些元数据。 在生成的 servlet 中,scriptlet 变量成了本地变量。 要让 JSP 转换引擎知道这些变量应当声明的类型,需要像下面这样在 TLD 文件中增加项:
<variable> <name-from-attribute>id</name-from-attribute> <variable-class>java.util.Map</variable-class> <scope>AT_BEGIN</scope> </variable>
将上面的代码片断放在 TLD 文件中 body-content
元素之后、attribute
元素之前。 在 variable
元素下面,我们声明了三个子元素:name-from-attribute
、variable-class
和 scope
。 name-from-attribute
指定 id
属性的值是转换引擎将要定义的 scriptlet 变量的名字。variable-class
是转换将要定义的变量的类类型。scope
指定变量什么时候可用:它可以嵌套到标签的正文中 (NESTED
)、在标签结束后 (AT_END
)、或者在标签的开始时 (AT_BEGIN
)。我们使用 AT_BEGIN
这一范围,它意味着变量的范围将是从标签的开始到当前 JSP 页的结束。
现在了解了如何构建简单自定义标签。在下一小节中,我们将分析标签的生存周期方法,以了解 JSP 页实际运行时所发生的情况。
简单标签的生存周期概述 | 第 9 页(共9 页) |
如果像我第一次使用标签时那样,您可能发现不容易将转换引擎生存周期与运行时实际发生的事情对应起来。 像我一样,您可能看到很多试图说明这些概念的图表,这些图表看起来可能像下面这样。
这里是已最小化的图像
这个图表对我没什么意义,但是生成的代码有意义,所以我们将在这一小节中分析这些代码。(现在我觉得这些图表有意义了,但是我认为这些代码更能说明问题,在我们完成这一小节时,您可能想再次分析这个图表。)
您可能还记得,JSP 页实际上是伪装的 servlet。JSP 文件在使用之前转换为 servlet。 下面是一个名为 testMapDefine.jsp 的小型 JSP 页,我们将用它来展示并测试在前面一节中开发的 MapDefineTag
标签:
<%@taglib uri="map" prefix="map"%> <html> <head><title>Test Map Define</title></head> <body> <map:mapDefine id="employee"> <br /> The employee is <%=employee%> <br /> <% employee.put("firstName", "Kiley"); employee.put("lastName", "Hightower"); employee.put("age", new Integer(33)); employee.put("salary", new Float(22.22)); %> The employee is <%=employee%> <br /> </map:mapDefine> </body> </html>
注意这一页用 map
的 URI 导入了一个自定义标签。之所以能这样是因为我们在 web.xml 文件中声明了这个 TLD,如下所示:
<web-app> ... <taglib> <taglib-uri>map</taglib-uri> <taglib-location>/WEB-INF/tlds/map.tld</taglib-location> </taglib> ...
有另一种导入标签的方法。我认为这个方法更有用,因为它允许为 URI 指定一个短名,而短名容易记忆。 注意 taglib 是在其 TLD 文件上下文中描述的。在 WEB-INF
目录中的 map.tld
文件看起来像下面这样:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd"> <taglib> <tlib-version>1.0</tlib-version> <jsp-version>1.2</jsp-version> <short-name>map</short-name> <tag> <name>mapDefine</name> <tag-class>trivera.tags.map.MapDefineTag</tag-class> <body-content>JSP</body-content> ...
当 JSP 转换器遇到自定义标签 mapDefine
时,它将根据 taglib
指令和在 web.xml 文件中指定的 TLD 文件查询 TLD 文件。然后在生成的 servlet 中加入下面的代码:
public class _testmapdefine__jsp extends ...JavaPage{ public void _jspService(HttpServletRequest request, HttpServletResponse response) throws...{ trivera.tags.map.MapDefineTag tag0 = null; java.util.Map employee = null; try { ... if (tag0 == null) { tag0 = new trivera.tags.map.MapDefineTag(); tag0.setPageContext(pageContext); tag0.setParent((javax.servlet.jsp.tagext.Tag) null); tag0.setId("employee"); } int includeBody = tag0.doStartTag(); if (includeBody != javax.servlet.jsp.tagext.Tag.SKIP_BODY) { employee = (java.util.Map)pageContext.findAttribute("employee"); out.print("<br /> /n The employee is "+ (employee) +"<br /> /n"); employee.put("firstName", "Kiley"); employee.put("lastName", "Hightower"); employee.put("age", new Integer(33)); employee.put("salary", new Float(22.22)); out.print("<br /> /n The employee is "+ (employee) +"<br /> /n"); } employee = (java.util.Map)pageContext.findAttribute("employee"); ... } catch (java.lang.Throwable _jsp_e) { pageContext.handlePageException(_jsp_e); ... } ... }
生成的 JSP servlet 声明了名为 tag0
、类型为 trivera.tags.map.MapDefineTag
的一个本地变量。 然后它创建标签的一个实例、设置页上下文、设置父标签为 null,并设置 ID 为 employee
。然后,生成的 servlet 调用 doStartTag()
方法,它检查返回类型是否设置为 Tag.SKIP_BODY
。如果是,那么容器就不对标签的正文(在这里就是 if
块)进行判断。如果它返回 EVAL_BODY_INCLUDE
,就像我们的标签那样,容器就将处理正文。 可以用这种技术有条件地加入标签的正文 —— 即控制流程。
注意生成的 servlet 有一个名为 employee
的本地变量, 根据标签的 id
属性将它设置为 employee
。因此,转换引擎在 转换 时而不是运行时定义了一个名为 employee
的本地变量。这个概念使很多新人感到迷惑。
理解嵌套标签 | 第 1 页(共3 页) |
前面的 JSP 页示例使用 JSP scriptlet 向 employee map 添加项。如果可以用另一个标签来完成就好了。 让我们定义一个名为 MapEntryTag
的嵌套标签,它通过调用 getParent()
并将它转换为 MapDefineTag
而得到其父标签。
MapDefineTag
定义了 getMap()
方法,它返回新创建的 map。 doEndTag()
中的嵌套 MapEntryTag
使用 MapDefineTag
的 getMap()
方法向 map 中增加值,如下所示:
public class MapEntryTag extends TagSupport { String type = "java.lang.String"; String id; String value; String name; String property; String scope; public int doEndTag() throws JspException { /* Grab the MapDefineTag using the getParent method and cast it to a MapDefineTag.*/ MapDefineTag mapDef = (MapDefineTag) this.getParent(); Object objectValue = null; ... /* Instantiate a new String, Integer or Float based on the type. */ if (type.equals("java.lang.String")) { objectValue = value; } else if (type.equals("java.lang.Integer")) { Integer intValue = Integer.valueOf(value); objectValue = intValue; } else if (type.equals("java.lang.Float")) { Float floatValue = Float.valueOf(value); objectValue = floatValue; } /* Put the new entry into the map. */ mapDef.getMap().put(id,objectValue); return EVAL_PAGE;
在上述代码的基础上,并假定在 TLD 文件中加入了必要的项,则可以像这样使用我们的标签:
<%@taglib uri="map" prefix="map"%> <html> <head><title>Test Map Define Entry</title></head> <body> <map:mapDefine id="employee"> <map:mapEntry id="firstName" value="Jennifer"/> <map:mapEntry id="lastName" value="Wirth"/> <map:mapEntry id="age" value="33" type="java.lang.Integer"/> <map:mapEntry id="salary" value="22.22" type="java.lang.Float"/> </map:mapDefine> The employee is set as <%=employee%> <br />
上述清单定义一个 employee map,其中带有针对 firstName
、lastName
、age
和 salary
各三项,它们的类型分别为 String
、String
、Integer
和 Float
。
未完待续