1、自定义标签简介(web层)
(1)、自定义标签主要用于移除Jsp页面中的java代码。
(2)、使用自定义标签移除jsp页面中的java代码,只需要完成以下两个步骤:
- 编写一个实现Tag接口的Java类(标签处理器类)。
- 编写标签库描述符(tld)文件,在tld文件中对标签处理器类进行描述。
A、编写一个实现tag接口的标签处理器类
public class ViewIPTag implements Tag {
private PageContext pageContext;
public int doStartTag() throws JspException {
HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
JspWriter out = pageContext.getOut();
String ip = request.getRemoteAddr();
try {
out.write(ip);
} catch (IOException e) {
throw new RuntimeException(e);
}
return 0;
}
public int doEndTag() throws JspException {
return 0;
}
public Tag getParent() {
return null;
}
public void release() {
}
public void setPageContext(PageContext arg0) {
this.pageContext = arg0;
}
public void setParent(Tag arg0) {
}
}
B、在web-inf/目录下新建tld文件,在tld文件中对标签处理器进行描述
<?xml version="1.0" encoding="UTF-8" ?>
<taglib xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
version="2.0">
<description>A tag library exercising SimpleTag handlers.</description>
<tlib-version>1.0</tlib-version>
<short-name>SimpleTagLibrary</short-name>
<uri>/itcast</uri>
<tag>
<name>viewIP</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.ViewIPTag</tag-class>
<body-content>empty</body-content>
</tag>
</taglib>
C、在jsp页面中导入并使用自定义标签
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/itcast" prefix="itcast" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>输出客户机的IP</title>
</head>
<body>
您的IP是:<itcast:viewIP/>
</body>
</html>
(3)、分析自定义标签的执行流程。
JSP引擎将遇到自定义标签时,首先创建标签处理器类的实例对象,然后按照JSP规范定义的通信规则依次调用它的方法。
- public void setPageContext(PageContext pc), JSP引擎实例化标签处理器后,将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器,标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。
- public void setParent(Tag t),setPageContext方法执行完后,WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器,如果当前标签没有父标签,则传递给setParent方法的参数值为null。
- public int doStartTag(),调用了setPageContext方法和setParent方法之后,WEB容器执行到自定义标签的开始标记时,就会调用标签处理器的doStartTag方法。
- public int doEndTag(),WEB容器执行完自定义标签的标签体后,就会接着去执行自定义标签的结束标记,此时,WEB容器会去调用标签处理器的doEndTag方法。
- public void release(),通常WEB容器执行完自定义标签后,标签处理器会驻留在内存中,为其它请求服务器,直至停止web应用时,web容器才会调用release方法。
2、自定义标签功能扩展
开发人员在编写Jsp页面时,经常还需要在页面中引入一些逻辑,例如:
tld文件中的四种标签体类型
EMPTY JSP scriptless tagdepentend
- 控制jsp页面某一部分内容是否执行。
- 控制整个jsp页面是否执行。
- 控制jsp页面内容重复执行。
- 修改jsp页面内容输出。
tld文件中的四种标签体类型
EMPTY JSP scriptless tagdepentend
(1)、控制标签体是否执行
doStartTag();
编写一个类实现tag接口,控制dostarttag方法的返回值,如果这个方法返回EVAL_BODY_INCLUDE,则执行标签体,如果返回SKIP_BODY,则不执行标签体
EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY if it does not want to process it.
public class TagDemo1 extends TagSupport {
@Override
public int doStartTag() throws JspException {
return SKIP_BODY;
// return EVAL_BODY_INCLUDE;
}
}
doEndTag();
编写一个类实现tag接口,控制doendtag方法的返回值,如果这个方法返回EVAL_PAGE,则执行标签余下的jsp页面,如果返回SKIP_PAGE,则不执行余下的jsp
EVAL_PAGE 此标签结束后,继续执行剩下的jsp; SKIP_PAGE 此标签结束后不在执行剩下的JSP
JSP:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib prefix="seu" uri="/seu" %>
<seu:demo2/>
<html>
<head>
<title></title>
</head>
<body>
</body>
</html>
TAG接口
public class TagDemo2 extends TagSupport {
@Override
public int doEndTag() throws JspException {
return SKIP_BODY;
// return EVAL_PAGE;
}
}
(3)、控制整个jsp页面重复执行
doAfterBody();
编写一个类实现Iterationtag接口,控制doAfterBody方法的返回值,如果这个方法返回EVAL_BODY_AGAIN, 则web服务器又执行一次标签体,依次类推,一直执行到doAfterBody方法返回SKIP_BODY,则标签体才不会重复执行。
控制标签体执行完成后是否重复执行标签体:EVAL_BODY_AGAIN重复执行,SKIP_BODY不重复执行。
public class TagDemo3 extends TagSupport {
int count = 5;
@Override
public int doStartTag() throws JspException {
return EVAL_BODY_INCLUDE;
}
@Override
public int doAfterBody() throws JspException {
count--;
if (count>0){
return EVAL_BODY_AGAIN;
}else {
return SKIP_BODY;
}
}
}
(4)、修改jsp页面内容输出
编写一个类实现BodyTag接口,控制 doStartTag方法,返回EVAL_BODY_BUFFERED,则web服务器会创建BodyContent对象捕获标签体,开发人员在 doEndTag方法体内,得到代表标签体的bodyContent对象,从而就可以对标签体进行修改。。。。。。操作。
public class TagDemo4 extends BodyTagSupport {
@Override
public int doStartTag() throws JspException {
return EVAL_BODY_BUFFERED;
}
@Override
public int doEndTag() throws JspException {
String body = this.getBodyContent().getString();
String result = body.toUpperCase();
try {
this.pageContext.getOut().write(result);
} catch (IOException e) {
throw new RuntimeException(e);
}
return EVAL_PAGE;
}
}
3、简单标签
由于传统标签使用三个标签接口来完成不同的功能,显得过于繁琐,不利于标签技术的推广, SUN公司为降低标签技术的学习难度,在JSP 2.0中定义了一个更为简单、便于编写和调用的
SimpleTag接口来实现标签的功能。实现SimpleTag接口的标签通常称为
简单标签。简单标签共定义了
5个方法:
- setJspContext方法
- setParent和getParent方法
- setJspBody方法
- doTag方法
(1)、5种方法简介:
setJspContext方法
用于把JSP页面的pageContext对象传递给标签处理器对象,其中JspContext是pageContext的父类,因此 获得JspContext可以强制转换为pageContext
setParent方法
用于把父标签处理器对象传递给当前标签处理器对象
getParent方法
用于获得当前标签的父标签处理器对象
setJspBody方法
用于把代表标签体的JspFragment对象传递给标签处理器对象 ,JspFragment类型。
doTag方法
用于完成所有的标签逻辑,包括输出、迭代、修改标签体内容等。在 doTag方法中可以抛出javax.servlet.jsp.SkipPageException异常,用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容,这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。
用于把JSP页面的pageContext对象传递给标签处理器对象,其中JspContext是pageContext的父类,因此 获得JspContext可以强制转换为pageContext
setParent方法
用于把父标签处理器对象传递给当前标签处理器对象
getParent方法
用于获得当前标签的父标签处理器对象
setJspBody方法
用于把代表标签体的JspFragment对象传递给标签处理器对象 ,JspFragment类型。
doTag方法
用于完成所有的标签逻辑,包括输出、迭代、修改标签体内容等。在 doTag方法中可以抛出javax.servlet.jsp.SkipPageException异常,用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容,这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。
(2)、SimpleTag接口方法的执行顺序
当web容器开始执行标签时,会调用如下方法完成标签的
初始化:
- WEB容器调用标签处理器对象的setJspContext方法,将代表JSP页面的pageContext对象传递给标签处理器对象。
- WEB容器调用标签处理器对象的setParent方法,将父标签处理器对象传递给这个标签处理器对象。注意,只有在标签存在父标签的情况下,WEB容器才会调用这个方法。
- 如果调用标签时设置了属性,容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或脚本表达式,则WEB容器首先计算表达式的值,然后把值传递给标签处理器对象。
- 如果简单标签有标签体,容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来。
- 容器调用标签处理器的doTag()方法,开发人员在方法体内通过操作JspFragment对象,就可以实现是否执行、迭代、修改标签体的目的。
(3)、JspFragment类
javax.servlet.jsp.tagext.JspFragment类是在JSP2.0中定义的,它的实例对象代表JSP页面中的一段符合JSP语法规范的JSP片段,
这段JSP片段中不能包含JSP脚本元素。
WEB容器在处理简单标签的标签体时,会把标签体内容用一个JspFragment对象表示,并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法,如下所示:
getJspContext方法
用于返回代表调用页面的JspContext对象.
public abstract void invoke(java.io.Writer out)
用于执行JspFragment对象所代表的JSP代码片段
参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中,如果传递给参数 out的值为null,则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之, 可以理解为写给浏览器)
WEB容器在处理简单标签的标签体时,会把标签体内容用一个JspFragment对象表示,并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法,如下所示:
getJspContext方法
用于返回代表调用页面的JspContext对象.
public abstract void invoke(java.io.Writer out)
用于执行JspFragment对象所代表的JSP代码片段
参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中,如果传递给参数 out的值为null,则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之, 可以理解为写给浏览器)
(4)、invoke方法详解
JspFragment.invoke方法是JspFragment
最重要的方法,利用这个方法可以控制
是否执行和输出标签体的内容、
是否迭代执行标签体的内容或对标签体的执行结果进行
修改后再输出。例如:
- 在标签处理器中如果没有调用JspFragment.invoke方法,其结果就相当于忽略标签体内容,相当于不执行标签体;
- 在标签处理器中重复调用JspFragment.invoke方法,则标签体重复执行;
- 若想在标签处理器中修改标签体内容,只需在调用invoke方法时指定一个可取出结果数据的输出流对象(例如StringWriter),让标签体的执行结果输出到该输出流对象中,然后从该输出流对象中取出数据进行修改后再输出到目标设备,即可达到修改标签体的目的。自己定义一个流,进行处理。
(5)、 4种功能的实现:
A、控制标签体是否执行
tld文件:
<?xml version="1.0" encoding="UTF-8" ?>
<taglib xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
version="2.0">
<description>A tag library exercising SimpleTag handlers.</description>
<tlib-version>1.0</tlib-version>
<short-name>SimpleTagLibrary</short-name>
<uri>/seuSimple</uri>
<tag>
<name>Demo1</name> <!--为标签处理器配置一个标签名 -->
<tag-class>seu.xinci.web.simpleTag.SimpleTagDemo1</tag-class>
<body-content>scriptless</body-content>
</tag>
</taglib>
其中的<body-content>
scriptless</body-content>与传统标签不同。因为简单标签不提倡在标签体内夹杂任何的脚本代码。其中还有一个属性是
tagdepentend,标签体内容作为参数传递,
基本不用。
接口类:
public class SimpleTagDemo1 extends SimpleTagSupport {
@Override
public void doTag() throws JspException, IOException {
JspFragment jspFragment = this.getJspBody();
// jspFragment.invoke(null);
}
}
public class SimpleTagDemo2 extends SimpleTagSupport {
@Override
public void doTag() throws JspException, IOException {
for(int i=0;i<5;i++){
this.getJspBody().invoke(null);
}
}
}
C、修改标签体内容
public class SimpleTagDemo3 extends SimpleTagSupport{
@Override
public void doTag() throws JspException, IOException {
JspFragment jspFragment = this.getJspBody();
StringWriter stringWriter = new StringWriter();
jspFragment.invoke(stringWriter);
String content = stringWriter.getBuffer().toString();
content = content.toUpperCase();
PageContext pageContext = (PageContext) jspFragment.getJspContext();
pageContext.getOut().write(content);
}
}
public class SimpleTagDemo4 extends SimpleTagSupport {
@Override
public void doTag() throws JspException, IOException {
throw new SkipPageException();
}
}
(6)、开发带属性的标签
自定义标签可以定义一个或多个属性,这样,在JSP页面中应用自定义标签时就可以设置这些属性的值,通过这些属性为标签处理器传递参数信息,从而提高标签的灵活性和复用性。
例如:标签的重复执行,重复执行多少次,就可以由属性来控制
A、简介:
要想让一个自定义标签具有属性,通常需要完成两个任务:
- 在标签处理器中编写每个属性对应的setter方法
- 在TLD文件中描术标签的属性
为自定义标签定义属性时,每个属性都必须按照JavaBean的属性命名方式,在标签处理器中定义属性名对应的setter方法,用来接收JSP页面调用自定义标签时传递进来的属性值。 例如属性url,在标签处理器类中就要定义相应的setUrl(String url)方法。
在标签处理器中定义相应的set方法后,JSP引擎在解析执行开始标签前,也就是调用doStartTag方法前,会调用set属性方法,为标签设置属性。
如果属性值是8种基本数据类型,那么在jsp页面传递的是字符串时,引擎会自动转换为相应类型。复杂类型就放到request里面,然后利用EL表达式赋值。
B、在TLD中描述标签属性
元素名 | 是否必须指定 | 描述 |
description | 否 | 用于指定属性的描述信息。 |
name | 是 | 用于指定属性的名称。属性名称是大小写敏感的,并且不能以 jsp、_jsp、java和sun开头。 |
required | 否 | 用于指定在JSP页面中调用自定义标签时是否必须设置这个属性。 其取值包括true和false,默认值为false,true表示必须设置,否则 可以设置也可以不设置该属性。 |
rtexprvalue | 否 | rtexprvalue是runtime expression value(运行时表达式)的英文 简写,用于指定属性值是一个静态值或动态值。 其取值包括true和false,默认值为false,false表示只能为该属性 指定静态文本值,例如"123";true表示可以为该属性指定一个 JSP动态元素,动态元素的结果作为属性值,例如JSP表达式 <%=value %>。 |
type | 否 | 用于指定属性值的Java类型。 |
<tag>元素的<attribute>子元素用于描述自定义标签的一个属性,自定义标签所具有的每个属性都要对应一个<attribute>元素 。
<attribute>
<description>description</description>
<name>aaaa</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<type>ObjectType</type>
</attribute>
C、示例:
tld文件:
<tag>
<name>Demo5</name> <!--为标签处理器配置一个标签名 -->
<tag-class>seu.xinci.web.simpleTag.SimpleTagDemo5</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>count</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue> <!-- 指示属性的值是否可以为一个表达式 -->
</attribute>
</tag>
tag实现类:
public class SimpleTagDemo5 extends SimpleTagSupport {
private int count;
public void setCount(int count) {
this.count = count;
}
@Override
public void doTag() throws JspException, IOException {
for (int i=0;i<count;i++){
this.getJspBody().invoke(null);
}
}
}
4、自定义标签案例
(1)、开发防盗链标签tld文件:
<tag>
<name>referer</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.RefererTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>site</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<name>page</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
package cn.itcast.web.tag;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.SkipPageException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
public class RefererTag extends SimpleTagSupport {
private String site;
private String page;
public void setSite(String site) {
this.site = site;
}
public void setPage(String page) {
this.page = page;
}
@Override
public void doTag() throws JspException, IOException {
//看来访问者是从哪个页面来的
PageContext pageContext = (PageContext)this.getJspContext();
HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
String referer = request.getHeader("referer"); //http://www.sina.com/index.html
//判断
if(referer==null || !referer.startsWith(site)){
HttpServletResponse response = (HttpServletResponse) pageContext.getResponse();
String webroot = request.getContextPath(); //day11_example
if(page.startsWith(webroot)){
response.sendRedirect(page);
}else{
response.sendRedirect(webroot + page);
}
//重定向后,控制保护的页面不要执行
throw new SkipPageException();
}
}
}
(2)、开发<c:if>标签
tld文件:
<tag>
<name>if</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.IfTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>test</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
package cn.itcast.web.tag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
public class IfTag extends SimpleTagSupport {
private boolean test;
public void setTest(boolean test) {
this.test = test;
}
@Override
public void doTag() throws JspException, IOException {
if(test){
this.getJspBody().invoke(null);
}
}
}
(3)、开发<c:if><c:else>标签
这个标签就是用到了父标签!
tld文件:需要3个tag类:ChooseTag、WhenTag、OtherwiseTag
<tag>
<name>choose</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.ChooseTag</tag-class>
<body-content>scriptless</body-content>
</tag>
<tag>
<name>when</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.WhenTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>test</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<tag>
<name>otherwise</name> <!-- 为标签处理器类配一个标签名 -->
<tag-class>cn.itcast.web.tag.OtherwiseTag</tag-class>
<body-content>scriptless</body-content>
</tag>
ChooseTag:
package cn.itcast.web.tag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
//父标签
public class ChooseTag extends SimpleTagSupport {
private boolean isOk;
public boolean isOk() {
return isOk;
}
public void setOk(boolean isOk) {
this.isOk = isOk;
}
@Override
public void doTag() throws JspException, IOException {
this.getJspBody().invoke(null);
}
}
WhenTag:
package cn.itcast.web.tag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
public class WhenTag extends SimpleTagSupport {
private boolean test;
public void setTest(boolean test) {
this.test = test;
}
@Override
public void doTag() throws JspException, IOException {
ChooseTag parent = (ChooseTag) this.getParent();
if(test==true && parent.isOk()==false){
this.getJspBody().invoke(null);
parent.setOk(true);
}
}
}
OtherwiseTag:
package cn.itcast.web.tag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
public class OtherwiseTag extends SimpleTagSupport {
@Override
public void doTag() throws JspException, IOException {
ChooseTag parent = (ChooseTag) this.getParent();
if(parent.isOk()==false){
this.getJspBody().invoke(null);
parent.setOk(true);
}
}
}
jsp文件的TAG使用:
<c:choose>
<c:when test="${user!=null}">
xxxx
</c:when>
<c:otherwise>
yyyy
</c:otherwise>
</c:choose>
(4)、开发迭代标签
Tag实现类:
package seu.xinci.web.tag;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
import java.io.IOException;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
/**
* Created by Administrator on 2016/2/15.
*/
public class ForEachTag2 extends SimpleTagSupport {
private Object items;
private String var;
private Collection collection;
public void setItems(Object items) {
this.items = items;
if (items instanceof Collection){
collection = (Collection) items;
}
if (items instanceof Map){
Map map = (Map) items;
collection = map.entrySet();
}
if (items.getClass().isArray()){
collection = new ArrayList();
int len = Array.getLength(items);
for (int i = 0;i<len;i++) {
collection.add(Array.get(items, i));
}
}
}
public void setVar(String var) {
this.var = var;
}
@Override
public void doTag() throws JspException, IOException {
Iterator iterator = collection.iterator();
while (iterator.hasNext()){
Object object = iterator.next();
this.getJspContext().setAttribute(var,object);
this.getJspBody().invoke(null);
}
}
}
(5)、开发html转义标签
tag类:
package cn.itcast.web.tag;
import java.io.IOException;
import java.io.StringWriter;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;
//转义标签
public class HtmlFilter extends SimpleTagSupport {
@Override
public void doTag() throws JspException, IOException {
StringWriter sw = new StringWriter();
this.getJspBody().invoke(sw);
//得到标签体:<a href="">点点</a>
String content = sw.getBuffer().toString();
content = filter(content);
//输出转义内容
this.getJspContext().getOut().write(content);
}
private String filter(String message) {
if (message == null)
return (null);
char content[] = new char[message.length()];
message.getChars(0, message.length(), content, 0);
StringBuffer result = new StringBuffer(content.length + 50);
for (int i = 0; i < content.length; i++) {
switch (content[i]) {
case '<':
result.append("<");
break;
case '>':
result.append(">");
break;
case '&':
result.append("&");
break;
case '"':
result.append(""");
break;
default:
result.append(content[i]);
}
}
return (result.toString());
}
}
(6)、打包标签库
A、建立java工程
B、将src文件拷贝过去
C、新建lib文件,将jsp,servlet包导入(在tomcat的lib文件中有)
D、新建META-INF文件,将配置文件tld拷贝过去
利用intellij进行打包点击打开链接
5、将java程序打包成exe
(1)、要把工程做成一个可运行的 jar
Main-Class:
(2)、使用exe4j
Main-Class:
(2)、使用exe4j