传统标签:
1、为什么要自定义标签 ?
规范JavaEE 企业级开发不建议在JSP中编写 Java代码 ,通过标签解析执行 ---- 调用一段java代码的执行
例如:<jsp:useBean> <jsp:setProperty> 、JSTL c:out c:if c:forEach
因为企业业务需求是多种多样的,所以常见开源框架只能提供通用java代码功能,如果实现既定业务逻辑功能,需要自定义标签
通过自定义标签 ---- 简化复杂业务开发
2、如何进行自定义标签开发
1)创建自定义 标签的处理类
2)创建TLD标签库描述文件
3)在JSP页面通过标签名称空间URI,去引用一个标签描述文件。
* 参考代码
tomcat/webapps/example/WEB-INF/jsp/*.tld 使用JSP1.2
tomcat/webapps/example/WEB-INF/jsp2/*.tld 使用JSP2.0
例子:快速入门,通过自定义标签去显示ip地址
1)首先class类,实现Tag接口
public class IpTag implements Tag{
private PageContext pc;
public ShowIpCtrl(){
System.out.println("标签对象初始化。。。。");
}
@Override
//标签结束时执行
public int doEndTag() throws JspException {
System.out.println("doEndTag");
return 0;
}
@Override
//标签开始时执行
public int doStartTag() throws JspException {
System.out.println("doStartTag");
HttpServletRequest request =(HttpServletRequest) pc.getRequest();
JspWriter out = pc.getOut();
String remoteAddr = request.getRemoteAddr();
try {
out.write(remoteAddr);
} catch (IOException e) {
e.printStackTrace();
}
return 0;
}
@Override
public Tag getParent() {
System.out.println("getParent");
return null;
}
@Override
public void release() {
System.out.println("release");
}
@Override
//自定义标签必须接收PageContext对象
public void setPageContext(PageContext pc) {
System.out.println("setPageContext");
this.pc = pc;
}
@Override
public void setParent(Tag arg0) {
System.out.println("setParent");
}
}
2)创建TLD标签库文件
a.创建
图 1
说明:Name:该创建好了之后TLD文件的文件名称
Version: 选择2.0的版本
Jspversion : 选择2.0的版本
shortname:标签的前缀 如:<myTag : xxxx aa='123'><:/myTag>
uRI : 该标签描述文件的命名空间 ,写一个互联网路径跟其他的命名空间不同即可
点击 Finish按钮之后,进入TLD文件。
注意:
要把 描述文件的 xsi:schemaLocation 属性值做一下改动,即把前一个互联网路径 http://java.sun.com/xml/ns/j2ee 复制到后面在加一个“/” ,拼接成一个互联网路径即可。
由 图 2 --> 图 3
图 2
图 3
b.描述标签
<tag>
<!-- 标签名称 -->
<name>showip</name>
<!-- 标签类 -->
<tag-class>com.rxtmedia.foot.text.ShowIpCtrl</tag-class>
<!-- 必须设置标签体,标签体内可以编写任意的JSP代码 -->
<body-content>JSP</body-content>
</tag>
c.引用标签
在JSP头文件中引用该标签库的名称空间
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
接下来就可以在JSP文件的标签体中引用该标签了
<myTag:showip></myTag:showip>
其实 按住Alt + / 就可以自动的选择。
JSP文件:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 引用标签 -->
<h2>自定义标签显示IP地址:<myTag:showip></myTag:showip></h2>
</body>
</html>
访问该JSP。
分析标签的执行过程:
标签对象初始化。。。。(构造函数,只执行一次)
setPageContext
setParent
doStartTag
doEndTag
realease-
1、public void setPageContext(PageContext pc),JSP引擎实例化标签处理器后,将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器,标签处理器
以后可以通过这个pageContext对象与JSP页面进行通信。
2、public void setParent(Tag t),setPageContext方法执行完后,WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器,如果当前标签没有父标签,
则传递给setParent方法的参数值为null。
3、public int doStartTag(),调用了setPageContext方法和setParent方法之后,WEB容器执行到自定义标签的开始标记时,就会调用标签处理器的doStartTag方法。
JSP从1.1开始支持自定义标签,并提供Tag接口,通过实现该接口完成标签自定义 (实现Tag接口标签 被称为传统标签)
JSP从2.0之后,为了简化标签的开发,提供JspTag 接口,并且让Tag接口继承 JspTag, 同时提供另一组接口 SimpleTag , 实现了SimpleTag的标签 被称为简单标签
如果编写传统标签,存在三个接口 Tag 、IterationTag 、BodyTag , 一般不去实现三个接口而去继承 TagSupport BodyTagSupport
配置tld时,每个标签必须配置 <bodyContent> 标签,用来描述标签体,有四种取值
JSP 从JSP1.1被使用,可以在标签体嵌入任何JSP代码
empty 标签体必须为空,不能含有任何内容
tagdepentend (不会常用) 标签体内容供服务器内部使用,而不是给页面显示
例如:
<sql:execute>
select * from user 这里标签体内容给服务器内部使用,而不是给用户显示
</sql:execute>
scriptless 从JSP2.0 主要使用,在标签体内不能含有 <%%>代码
====================================================================
传统标签的开发
功能一 :控制页面内部一部分代码是否执行
在doStartTag 方法中 返回
EVAL_BODY_INCLUDE 执行标签内容
SKIP_BODY 跳过标签内容
功能二 :控制标签后页面是否继续执行
在doEndTag 方法返回
EVAL_PAGE 继续执行剩余页面
SKIP_PAGE 不继续执行
功能三:控制页面部分内容重复执行
在IterationTag 中提供 EVAL_BODY_AGAIN (再次执行标签体)
在新提供doAfterBody返回
EVAL_BODY_AGAIN 重复执行标签体
SKIP_BODY 跳过标签体
功能四:标签体内容修改输出 (HTML转义、大写、小写)
在BodyTag 接口中 提供 EVAL_BODY_BUFFERED (用于将标签体内容输出到缓存中 )
功能五:自定义带有属性的标签
例如:<mytag:demo5 times="10"></mytag:demo5> 将标签体循环 times次数
额外的两个步骤
其实 按住Alt + / 就可以自动的选择。
1、在标签类 开发属性对应setter方法
<mytag:demo5 times="10" >
Hello Kitty!
</mytag:demo5>
需要在标签类中提供 setTimes 方法
2、在tld描述文件中 描述该属性
<tag>
<name>demo5</name>
<tag-class>cn.itcast.mytag.Demo5Tag</tag-class>
<body-content>JSP</body-content>
<!-- 描述属性 -->
<attribute>
<name>times</name>
<!-- 规定属性是否必须 -->
<required>true</required>
<!-- 规定属性是否支持EL表达式 -->
<rtexprvalue>true</rtexprvalue>
<!-- 属性类型 -->
<type>int</type>
</attribute>
</tag>
功能一 :控制页面内部一部分代码是否执行
标签处理类class:
/**控制页面内部一部分代码是否执行
*
* @author dell
*
*/
public class Demo1 extends TagSupport{
@Override
public int doStartTag() throws JspException {
<span style="white-space:pre"> </span>// 执行标签体 EVAL_BODY_INCLUDE
<span style="white-space:pre"> </span>// 跳过标签体 SKIP_BODY
return <span style="font-family: Arial, Helvetica, sans-serif;">EVAL_BODY_INCLUDE</span>
;
}
}
标签描述文件:
<tag>
<!-- 标签名称 -->
<name>demo1</name>
<!-- 标签类 -->
<tag-class>com.rxtmedia.foot.text.Demo1</tag-class>
<!-- 必须设置标签体,标签体内可以编写任意的JSP代码 -->
<body-content>JSP</body-content>
</tag>
JSP文件引用标签:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<myTag:demo1>
<h3>Hi , my Tag</h3>
</myTag:demo1>
</body>
</html>
功能二 :控制标签后页面是否继续执行
标签处理类class:
public class Demo2 extends TagSupport{
@Override
public int doEndTag() throws JspException {
// 返回 EVAL_PAGE继续执行页面
// 返回SKIP_PAGE 页面将不再继续执行
return SKIP_PAGE;
}
}
标签描述文件TLD;
public class Demo2 extends TagSupport{
@Override
public int doEndTag() throws JspException {
// 返回 EVAL_PAGE继续执行页面
// 返回SKIP_PAGE 页面将不再继续执行
return SKIP_PAGE;
}
}
JSP页面引用:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<h1>AAAAAAAAAAAA</h1>
<myTag:demo2></myTag:demo2>
<h1>BBBBBBBBBBBBBBBB</h1>
</body>
</html>
功能三:控制页面部分内容重复执行
标签处理类class:
/**
* 功能三:控制页面部分内容重复执行
* @author dell
*
*/
public class Demo3 extends TagSupport{
// 重复执行标签体5次
// 标签类只有一个实例,所以第一次访问 times是4.而第二次访问 times 变为0
private int times = 5;
@Override
public int doStartTag() throws JspException {
// doStartTag默认返回的是 SKIP_BODY。所以如果重复执行标签体的话,就必须设置doStartTag的返回值。
return EVAL_BODY_INCLUDE ;
}
@Override
public int doAfterBody() throws JspException {
if(times > 0 ){
times--;
return EVAL_BODY_AGAIN;
} else {
// 重置循环次数
times = 5;
return SKIP_BODY;
}
}
}
标签描述文件TLD:
<tag>
<!-- 标签名称 -->
<name>demo3</name>
<!-- 标签类 -->
<tag-class>com.rxtmedia.foot.text.Demo3</tag-class>
<!-- 必须设置标签体,标签体内可以编写任意的JSP代码 -->
<body-content>JSP</body-content>
</tag>
JSP页面引用标签:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<myTag:demo3>重复内容 </br></myTag:demo3>
</body>
</html>
功能四:标签体内容修改输出 (HTML转义、大写、小写)
标签处理类class:
/**
* 功能四:标签体内容修改输出 (HTML转义、大写、小写)
* @author dell
*
*/
public class Demo4 extends BodyTagSupport{
@Override
// 将标签体写入缓存
public int doStartTag() throws JspException {
// EVAL_BODY_INCLUDE 执行标签体
// SKIP_BODY 跳过标签体
// 新的选择 EVAL_BODY_BUFFERED 将标签体输出到缓存中
return EVAL_BODY_BUFFERED;
}
@Override
//将标签体取出,并将其改为大写
public int doEndTag() throws JspException {
String content = getBodyContent().getString();
JspWriter out = this.pageContext.getOut();
try {
out.write(content.toUpperCase());
} catch (IOException e) {
e.printStackTrace();
}
// 继续执行页面
return EVAL_PAGE;
}
}
标签描述文件:
<tag>
<!-- 标签名称 -->
<name>demo4</name>
<!-- 标签类 -->
<tag-class>com.rxtmedia.foot.text.Demo4</tag-class>
<!-- 必须设置标签体,标签体内可以编写任意的JSP代码 -->
<body-content>JSP</body-content>
</tag>
JSP页面引用标签:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://rexremedia.com/mytag" prefix="myTag" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<myTag:demo4>lkafjdiuowielknl3123p0fvaodfo</myTag:demo4>
</body>
</html>
其实 按住Alt + / 就可以自动的选择。
功能五:自定义带有属性的标签
例如:<mytag:demo5 times="10"></mytag:demo5> 将标签体循环 times次数
额外的两个步骤
1、在标签类 开发属性对应setter方法
<mytag:demo5 times="10" >
Hello Kitty!
</mytag:demo5>
需要在标签类中提供 setTimes 方法
2、在tld描述文件中 描述该属性
<tag>
<name>demo5</name>
<tag-class>cn.itcast.mytag.Demo5Tag</tag-class>
<body-content>JSP</body-content>
<!-- 描述属性 -->
<attribute>
<name>times</name>
<!-- 规定属性是否必须 -->
<required>true</required>
<!-- 规定属性是否支持EL表达式 -->
<rtexprvalue>true</rtexprvalue>
<!-- 属性类型 -->
<type>int</type>
</attribute>
</tag>