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頁面某一部分內容是否執行。
- 控制整個jsp頁面是否執行。
- 控制jsp頁面內容重複執行。
- 修改jsp頁面內容輸出。
tld文件中的四種標籤體類型
EMPTY JSP scriptless tagdepentend
public class TagDemo1 extends TagSupport {
@Override
public int doStartTag() throws JspException {
return SKIP_BODY;
// return EVAL_BODY_INCLUDE;
}
}
doEndTag();
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib prefix="seu" uri="/seu" %>
<seu:demo2/>
<html>
<head>
<title></title>
</head>
<body>
</body>
</html>
public class TagDemo2 extends TagSupport {
@Override
public int doEndTag() throws JspException {
return SKIP_BODY;
// return EVAL_PAGE;
}
}
(3)、控制整個jsp頁面重複執行
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、簡單標籤
- setJspContext方法
- setParent和getParent方法
- setJspBody方法
- doTag方法
用於把JSP頁面的pageContext對象傳遞給標籤處理器對象,其中JspContext是pageContext的父類,因此獲得JspContext可以強制轉換爲pageContext
setParent方法
用於把父標籤處理器對象傳遞給當前標籤處理器對象
getParent方法
用於獲得當前標籤的父標籤處理器對象
setJspBody方法
用於把代表標籤體的JspFragment對象傳遞給標籤處理器對象 ,JspFragment類型。
doTag方法
用於完成所有的標籤邏輯,包括輸出、迭代、修改標籤體內容等。在doTag方法中可以拋出javax.servlet.jsp.SkipPageException異常,用於通知WEB容器不再執行JSP頁面中位於結束標記後面的內容,這等效於在傳統標籤的doEndTag方法中返回Tag.SKIP_PAGE常量的情況。
- WEB容器調用標籤處理器對象的setJspContext方法,將代表JSP頁面的pageContext對象傳遞給標籤處理器對象。
- WEB容器調用標籤處理器對象的setParent方法,將父標籤處理器對象傳遞給這個標籤處理器對象。注意,只有在標籤存在父標籤的情況下,WEB容器纔會調用這個方法。
- 如果調用標籤時設置了屬性,容器將調用每個屬性對應的setter方法把屬性值傳遞給標籤處理器對象。如果標籤的屬性值是EL表達式或腳本表達式,則WEB容器首先計算表達式的值,然後把值傳遞給標籤處理器對象。
- 如果簡單標籤有標籤體,容器將調用setJspBody方法把代表標籤體的JspFragment對象傳遞進來。
- 容器調用標籤處理器的doTag()方法,開發人員在方法體內通過操作JspFragment對象,就可以實現是否執行、迭代、修改標籤體的目的。
WEB容器在處理簡單標籤的標籤體時,會把標籤體內容用一個JspFragment對象表示,並調用標籤處理器對象的setJspBody方法把JspFragment對象傳遞給標籤處理器對象。JspFragment類中只定義了兩個方法,如下所示:
getJspContext方法
用於返回代表調用頁面的JspContext對象.
public abstract void invoke(java.io.Writer out)
用於執行JspFragment對象所代表的JSP代碼片段
參數out用於指定將JspFragment對象的執行結果寫入到哪個輸出流對象中,如果傳遞給參數out的值爲null,則將執行結果寫入到JspContext.getOut()方法返回的輸出流對象中。(簡而言之,可以理解爲寫給瀏覽器)
- 在標籤處理器中如果沒有調用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
Main-Class:
(2)、使用exe4j