参考链接:https://blog.csdn.net/goldentec/article/details/105349954
1、定义
自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet,标签转化为对被 称为tag handler的对象的操作,即当servlet执行时Web container调用那些操作。
JSP标签扩展可以让你创建新的标签并且可以直接插入到一个JSP页面。
标记库(Tag Library)通过定义一种专门化子语言来抽象JSP页面中使用的功能,并支持在JSP页面中更自然地反复使用它。
- 标记库通过标记库描述符(Tag Library Descriptor,TLD)来定义功能的抽象语义,它其实是一个XML文档。
- 标记库通过标记处理类来定义功能的操作语义,并在运行时根据抽象语义由JSP页面将其实例化。
2、标记的组成
自定义标记由两部分组成:
- *.tld文件:是一个XML文件,用来定义标记名称、属性、标记处理类、标记体等。
- *.class文件:每一个标记,都对应一个标记处理器类,这个类遵守一定规范,即需要继承或实现API中的特定类或接口,覆盖其中方法。也是自定义标记的主要工作。
可见,自定义标记的功能依然还是用Java类实现的,不过是Java代码不再写在JSP中,而是用独立的Java类实现,并使用标记调用它,以便达到复用性。
3、 创建自定义标签
3.1 创建tld文件
在WEB-INF目录下创建taglib.tld文件,该文件的格式可以查找相关模板进行修改。
代码案例:创建user标签,将用户名和手机号写入会话当中。
taglib.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/j2ee/dtds/web-jsptaglibrary_1_2.dtd"> <taglib> <tlib-version>1.0</tlib-version> <jsp-version>2.1</jsp-version> <short-name>t</short-name> <uri>http://www.company.com/tablib</uri> <description>这是我的第一个标记库</description> <tag> <name>user</name> <tag-class>com.company.taglib.UserHandler</tag-class> <body-content>empty</body-content> <attribute> <name>userName</name> <required>true</required> <rtexprvalue>true</rtexprvalue> </attribute> <attribute> <name>phoneNum</name> <required>true</required> <rtexprvalue>true</rtexprvalue> </attribute> </tag> <tag> <name>printUser</name> <tag-class>com.company.taglib.PrintUser</tag-class> <body-content>empty</body-content> </tag> </taglib>
tld文件解析:
uri:是这个tld文件的唯一标记,可以自定义,不一定是真实存在的URL。使用自定义标记时将根据该值寻找tld文件。 tag:tld文件中将定义多个tag元素,描述多个标签。
- name:标签的名字
- tag-class:实现该标签功能的类,是之后主要的工作
- attribute:标签的属性,可以定义多个
- name:属性名字
- required:属性是否必须,true为必须
- rtexprvalue:属性是否能使用运行期表达式传值,true表示必须
3.2 创建标记处理类
本章的标签处理器类使用继承TagSupport类实现,覆盖其中的doStartTag方法。
标签处理器类首先必须声明与tld文件中对tag定义的属性对应的属性变量,例如,本例中的处理器类必须声明 attr,并提供setXXX方法,容器在运行时将自动调用setXXX方法赋值。
UserHandler.java代码:
package com.company.taglib; import javax.servlet.http.HttpSession; import javax.servlet.jsp.JspException; import javax.servlet.jsp.tagext.TagSupport; public class UserHandler extends TagSupport { private String userName; private long phoneNum; @Override public int doStartTag() throws JspException { HttpSession session = pageContext.getSession(); session.setAttribute("userName", userName); session.setAttribute("phoneNum", phoneNum); return super.doStartTag(); } public String getUserName() { return userName; } public long getPhoneNum() { return phoneNum; } public void setUserName(String userName) { this.userName = userName; } public void setPhoneNum(long phoneNum) { this.phoneNum = phoneNum; } }
PrintUser.java代码:
package com.company.taglib; import java.io.IOException; import javax.servlet.http.HttpSession; import javax.servlet.jsp.JspException; import javax.servlet.jsp.JspWriter; import javax.servlet.jsp.tagext.TagSupport; public class PrintUser extends TagSupport{ private String userName; private long phoneNum; @Override public int doStartTag() throws JspException { HttpSession session = pageContext.getSession(); this.userName = (String) session.getAttribute("userName"); this.phoneNum = (long) session.getAttribute("phoneNum"); JspWriter out = pageContext.getOut(); try { out.println("userName:"+userName); out.println("phoneNum:"+phoneNum); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } return super.doStartTag(); } public String getUserName() { return userName; } public long getPhoneNum() { return phoneNum; } public void setUserName(String userName) { this.userName = userName; } public void setPhoneNum(long phoneNum) { this.phoneNum = phoneNum; } }
3.3 Jsp中使用自定义标签
测试类:test1.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@taglib uri="http://www.company.com/tablib" prefix="t" %> <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Insert title here</title> </head> <body> <t:user phoneNum="86_god" userName="15592233822"/> <t:printUser/> </body> </html>
每日心语:
有毒的草,开迷人的花
害你的人,说你爱听的话
在这个无比现实残酷的世界里
人与人之间,什么人说什么话