文章目录
JSP自定义标签
我们为什么要自定义jsp标签有什么用呢?
在进行JSP页面显示处理的时候,有时候JSTL/Struts/Spring提供的标签库并不能满足项目中显示的需求,特别是对一些要求比较高的定制化服务中,可以使用自定义的标签库去处理。
有些时候如果我们不用自定义标签处理的话那么当我们遇到查询分页、下拉列表回填、复选框回填…,重复代码过多,代码冗余代码的可读性较差,不便于阅读修改。
标签语言特点
<开始标签>。标签体。</结束标签>
空标签
< br>< /br>
< br/>< hr/>
<开始标签 属性名=“属性值”>大法师</结束标签>
<开始标签/>
有前缀的标签是jsp标签(其实就是一个servler)没有前缀的标签是普通的html标签
例如:
标签的三层
ui标签:专门用来展示内容------》select
控制:做流程控制用的---------》z:if,z:forEach
数据标签:c:set将某数据赋值给某变量
tld文件理解
- short-name: 标签前缀:类比C标签的c:if》c
- tag-class:页面渲染时处理标签的工作类
- name:标签后缀名:类比C标签的c:if》if
- body-content:主体内容:
- jsp:接收所有的jsp语法的内容
- empty:开始和结束中间没有内容
- scriptless:接收文本、el和jsp脚本
- agDependent:标签体内容直接写入bodyContext由自定义标签类进行处理
-
- attribute:标签的属性,类比input标签的name/value等属性
- name:属性名(与标签处理类的属性(set)必须保持一致)
- required:属性的必要性
- rtexprvalue:是否支持特殊表达式:EL表达式等
JSP自定义标签的生命周期
- 这个生命周期图说明了三种情况:
- (1)doStartTag->SKIP_BODY->doEndTag
- (2)dostartTag->EVAL_BODY_INCLUDE->doAfterBody->SKIP_BODY->doEndTag
- (3)dostartTag->EVAL_BODY_INCLUDE->doAfterBody->EVAL_BODY_AGAIN->KKIP_BODY->doEndTag
了解助手类里面常量的意思
- SKIP_BODY:跳过主体
- EVAL_BODY_INCLUDE:计算标签主体内容并[输出]
- EVAL_PAGE:计算页面的后续部分
- SKIP_PAGE:跳过页面的后续部分
- EVAL_BODY_AGAIN:再计算主体一次
JSP自定义标签的开发以及使用步骤
(1) 创建一个标签助手类(继承BodyTagSupport)标签属性必须助手类的属性对应、且要提供对应get/set方法
并且实现三个方法:
(1)doStartTag() 处理开始标签的方法
(2)doAfterBody()计算主体的方法
(3)doEndTag()处理结束标签的方法(其实可以不用写的它是默认的)
(2) 创建标签库描述文件(tld),添加自定义标签的配置 。 注:tld文件必须保存到WEB-INF目录或其子目录
(3) 在JSP通过taglib指令导入标签库描述文件,并通过指定前缀
访问此自定义标签
个人理解角度:当查询走的<z: 的时候它就会去找prefix的对应映射处理逻辑
这个案例我是把主体输出三遍我们来看一下结果:
输出结果:
案例自定义:(if/out/set/foreach)
基于以上案例的理解我们来开发简单的标签。
1.配置tld文件
<!DOCTYPE taglib
PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
"http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<!-- 标签库描述符 -->
<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<short-name>Simple Tags</short-name>
<uri>/liyingdong</uri>
<!-- empty标签 -->
<tag>
<!-- 标签名 -->
<name>test</name>
<!-- 标签助手类 -->
<tag-class>com.liyingdong.TestTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>jsp</body-content>
<!-- 属性名的标签 attribute -->
<attribute>
<name>name</name>
<!--required是否是必须的 -->
<required>true</required>
<!--rtexprvalue 是否接受表达式 -->
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<!-- if标签 -->
<tag>
<!-- 标签名 -->
<name>if</name>
<!-- 标签助手类 -->
<tag-class>com.liyingdong.IfTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>jsp</body-content>
<!-- 属性名的标签 attribute -->
<attribute>
<name>test</name>
<!--required是否是必须的 -->
<required>true</required>
<!--rtexprvalue 是否接受表达式 -->
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<!-- Set标签 -->
<tag>
<!-- 标签名 -->
<name>set</name>
<!-- 标签助手类 -->
<tag-class>com.liyingdong.SetTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>jsp</body-content>
<!-- 属性名的标签 attribute -->
<attribute>
<name>var</name>
<!--required是否是必须的 -->
<required>true</required>
<!--rtexprvalue 是否接受表达式 -->
<rtexprvalue>false</rtexprvalue>
</attribute>
<attribute>
<name>value</name>
<!--required是否是必须的 -->
<required>true</required>
<!--rtexprvalue 是否接受表达式 -->
<rtexprvalue>false</rtexprvalue>
</attribute>
</tag>
<!-- Out标签 -->
<tag>
<!-- 标签名 -->
<name>out</name>
<!-- 标签助手类 -->
<tag-class>com.liyingdong.OutTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>jsp</body-content>
<!-- 属性名的标签 attribute -->
<attribute>
<name>value</name>
<!--required是否是必须的 -->
<required>true</required>
<!--rtexprvalue 是否接受表达式 -->
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<!-- 自定义froeach标签 -->
<tag>
<name>foreach</name>
<tag-class>com.liyingdong.ForeachTag</tag-class>
<body-content>jsp</body-content>
<attribute>
<name>var</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<name>items</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
</taglib>
1.自定义if标签(助手类配置)
package com.liyingdong;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class IfTag extends BodyTagSupport {
private boolean test;//标签属性
public boolean isTest() {
return test;
}
public void setTest(boolean test) {
this.test = test;
}
@Override
public int doStartTag() throws JspException {
// TODO Auto-generated method stub
// 如果为true 就输出 否则就跳过
return test ? EVAL_BODY_INCLUDE : SKIP_BODY;
}
}
2.自定义set标签
核心点:把键存入作用域 这个键处觉于你定义的键
package com.liyingdong;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class SetTag extends BodyTagSupport {
/**
*
*/
private static final long serialVersionUID = 1L;
// 属性
private String var;
private Object value;
public String getVar() {
return var;
}
public void setVar(String var) {
this.var = var;
}
public Object getValue() {
return value;
}
public void setValue(Object value) {
this.value = value;
}
/**
* 处理开始标签 doStartTag:jsp容器在扫面到"<"时启用
*/
@Override
public int doStartTag() throws JspException {
// TODO Auto-generated method stub
//把键存入作用域 用于out标签拿到${键名}
pageContext.setAttribute(var, value);
return SKIP_BODY;// 跳过主体
}
}
3.自定义out标签
package com.liyingdong;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class OutTag extends BodyTagSupport {
/**
*
*/
private static final long serialVersionUID = 1L;
private Object value;
public Object getValue() {
return value;
}
public void setValue(Object value) {
this.value = value;
}
@Override
public int doStartTag() throws JspException {
// TODO Auto-generated method stub
JspWriter out = pageContext.getOut();
try {
//输出到浏览器
out.print(value);
} catch (Exception e) {
// TODO: handle exception
e.printStackTrace();
}
return SKIP_BODY;// 跳过主体
}
}
4.自定义foreach标签
package com.liyingdong;
import java.util.Iterator;
import java.util.List;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class ForeachTag extends BodyTagSupport {
private String var;// 保存当前数据到作用域的一个key(键/名字)
private List<Object> items;// 数据源
public ForeachTag() {
}
public String getVar() {
return var;
}
public void setVar(String var) {
this.var = var;
}
public List<Object> getItems() {
return items;
}
public void setItems(List<Object> items) {
this.items = items;
}
/**
* 处理开始标签 doStartTag:jsp容器在扫面到"<"时启用
*/
@Override
public int doStartTag() throws JspException {
if (null == items || 0 == items.size()) {
return SKIP_BODY;// 跳过主体
}
Iterator<Object> it = items.iterator();
Object next = it.next();
pageContext.setAttribute(var, next);
// 保存iterator的指针
pageContext.setAttribute("it", it);
return EVAL_BODY_INCLUDE;// 计算主体并且包含到输出
}
/**
* doAfterBody()计算主体的方法
*/
@Override
public int doAfterBody() throws JspException {
Iterator<Object> it = (Iterator<Object>) pageContext.getAttribute("it");
while (it.hasNext()) {
Object next = it.next();
pageContext.setAttribute(var, next);
return EVAL_BODY_AGAIN;// 再次计算主体
}
return SKIP_BODY;
}
/**
* doEndTag()处理结束标签的方法(其实可以不用写的它是默认的)
*/
@Override
public int doEndTag() throws JspException {
// TODO Auto-generated method stub
System.out.println("doEndTag");
return EVAL_PAGE;// 计算页面后续内容
}
}
输出结果
今天就总结到此!