Apache Shiro學習筆記（八）自定義標籤

時間  2020-06-08
標籤 apache shiro 學習 筆記 自定義 標籤 欄目 Apache 简体版
原文   原文鏈接

魯春利的工做筆記，好記性不如爛筆頭javascript


tld文件
html

在JSP規範的1.1版中增長了自定義標籤庫規範，開發自定義標籤所涉及到的接口與類的層次結構(其中SimpleTag接口與SimpleTagSupport類是JSP2.0中新引入的)。java


通常狀況下開發jsp自定義標籤須要引用如下兩個包
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;jquery


wKiom1eq74qDvLLpAAGalc1F2Gg473.jpg


一、實現Tag接口web

package com.highabove.crm.demo;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

import org.apache.log4j.Logger;

/**
 * 
 * @author lucl
 *
 */
public class HelloTag implements Tag {

    private static final Logger logger = Logger.getLogger(HelloTag.class);
    
    PageContext pageContext;
    
    @Override
    public int doEndTag() throws JspException {
        logger.info("the method doEndTag() was invoke...");
        return 0;
    }

    @Override
    public int doStartTag() throws JspException {
        logger.info("the method doStartTag() was invoke...");
        System.out.println("調用doStartTag()方法");
        JspWriter out = pageContext.getOut();
        try {
            //這裏輸出的時候會拋出IOException異常
            out.write("<font color='red'>hello</font>");
        } catch (IOException e) {
            //捕獲IOException異常後繼續拋出
            throw new RuntimeException(e);
        }
        return 0;
    }

    @Override
    public Tag getParent() {
        logger.info("the method getParent() was invoke...");
        return null;
    }

    @Override
    public void release() {
        logger.info("the method release() was invoke...");
    }

    @Override
    public void setPageContext(PageContext pageContext) {
        logger.info("the method setPageContext(PageContext pageContext) was invoke...");
        this.pageContext = pageContext;
    }

    @Override
    public void setParent(Tag tag) {
        logger.info("the method setParent(Tag tag) was invoke...");
    }

}

自定義標籤的執行流程
　　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方法。apache


二、繼承SimpleTagSupport類服務器

package com.highabove.crm.demo;

import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;

/**
 * 
 * @author lucl
 *
 */
public class CRMTag extends SimpleTagSupport {
    
    private String user;
    
    @Override
    public void doTag() throws JspException, IOException {
        super.doTag();
        
        getJspContext().getOut().write("hello, " + this.getUser());
    }

    public String getUser() {
        return user;
    }

    public void setUser(String user) {
        this.user = user;
    }
}

JSP自定義標籤類還有以下要求：
    若是標籤類包含屬性，每一個屬性都有對應的getter和setter方法。
    重寫doTag()方法，這個方法負責生成頁面內容。session


三、tld文件app

<?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/javaee 
            http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_0.xsd"     
    version="2.0">
    <!-- description用來添加對taglib(標籤庫)的描述 -->
    <description>自定義標籤</description>
    <!-- tlib-version：指定該標籤庫實現的版本，這是一個做爲標識的內部版本號，對程序沒有太大的做用。 -->
    <tlib-version>1.1.2</tlib-version>
    <!-- short-name：該標籤庫的默認短名，該名稱一般也沒有太大的用處。 -->
    <short-name>hello</short-name>
    <!-- 
        uri：這個屬性很是重要，它指定該標籤庫的URI，至關於指定該標籤庫的惟一標識。
        在Jsp頁面中引用標籤庫時，須要經過uri找到標籤庫, <%@taglib uri="http://www.invicme.org/mytaglib" prefix="hello"%> 
    -->
    <uri>http://www.invicme.org/mytaglib</uri>
    <!-- taglib元素下能夠包含多個tag元素，每一個tag元素定義一個標籤 -->
    <tag>
        <description>這個標籤的做用是用來輸出客戶端的IP地址</description>
        <!-- name：該標籤庫的名稱，這個子元素很重要，JSP頁面中就是根據該名稱來使用此標籤的。 -->
        <name>header</name>
        <!-- 標籤對應的處理器類-->
        <tag-class>com.highabove.crm.demo.HelloTag</tag-class>
        <body-content>empty</body-content>
    </tag>
    <!-- taglib元素下能夠包含多個tag元素，每一個tag元素定義一個標籤 -->
    <tag>
        <description>這個標籤的做用是用來輸出客戶端的IP地址</description>
        <!-- name：該標籤庫的名稱，這個子元素很重要，JSP頁面中就是根據該名稱來使用此標籤的。 -->
        <name>curUser</name>
        <!-- 標籤對應的處理器類 -->
        <tag-class>com.highabove.crm.demo.CRMTag</tag-class>
        <body-content>empty</body-content>
        <attribute>
            <name>user</name>
            <required>true</required>
            <!-- true:表示可使用運行時表達式；fasle表示只能使用字符串 -->
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
</taglib>

taglib下有以下三個子元素。less

tlib-version：指定該標籤庫實現的版本，這是一個做爲標識的內部版本號，對程序沒有太大的做用。

short-name：該標籤庫的默認短名，該名稱一般也沒有太大的用處。

uri：這個屬性很是重要，它指定該標籤庫的URI，至關於指定該標籤庫的惟一標識。

taglib元素下能夠包含多個tag元素，每一個tag元素定義一個標籤。

tag元素下容許出現以下經常使用子元素：

name：該標籤庫的名稱，JSP頁面中就是根據該名稱來使用此標籤的。

tag-class：指定標籤的處理類，它指定了標籤由哪一個標籤處理類來處理。

body-content：這個子元素也很重要，它指定標籤體內容。該子元素的值能夠是以下幾個：

tagdependent：指定標籤處理類本身負責處理標籤體。

empty：指定該標籤只能做爲空標籤使用。

scriptless：指定該標籤的標籤體能夠是靜態HTML元素、表達式語言，但不容許出現JSP腳本。

JSP：指定該標籤的標籤體可使用JSP腳本。

dynamic-attributes：指定該標籤是否支持動態屬性。只有當定義動態屬性標籤時才須要該子元素。


由於JSP 2規範再也不推薦使用JSP腳本(可使用JSTL)，因此JSP 2自定義標籤的標籤體中不能包含JSP腳本。因此，實際上body-content元素的值不能夠是JSP。


四、hello_tld.jsp

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%>
<%@taglib uri="http://www.invicme.org/mytaglib" prefix="hello"%>
<!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>Hello Tld</title>
</head>
<body>
    <hello:header />
    <br/>
    <hello:curUser user="lucl"/>
</body>
</html>


tag文件

Jsp2.0後，實現tag的方式除了taglib(TLD)的方式外，還能夠經過定義tag文件來代替taglib類。tag file通常放在/WEB-INF/tags目錄或者其子目錄,須要在jsp文件中指定uri。


可參考：

http://today.java.net/pub/a/today/2003/11/14/tagfiles.html

http://today.java.net/pub/a/today/2003/11/25/tagfiles.html


Tag File中有以下幾個內置對象：

request：與JSP腳本中的request對象對應。
response：與JSP腳本中的response對象對應。
session：與JSP腳本中的session對象對應。
application：與JSP腳本中的application對象對應。
config：與JSP腳本中的config對象對應。
out：與JSP腳本中的out對象對應。


Tag File具備如下5個編譯指令：

taglib：與JSP文件中的taglib指令效果相同，用於導入其餘標籤庫。
include：與JSP文件中的include指令效果相同，用於導入其餘JSP或靜態頁面。
tag：相似於JSP文件中的page指令，有pageEncoding、body-content等屬性，用於設置頁面編碼等。
attribute：用於設置自定義標籤的屬性，相似於自定義標籤處理類中的標籤屬性。
variable：用於設置自定義標籤的變量，這些變量將傳給JSP頁面使用。


標籤文件的使用：

在引用標籤文件的JSP頁面必須使用taglib指令<%@ taglib tagdir="/WEB-INF/tags" prefix="r" %>，其中tagdir屬性指定標籤文件的地址。


  • 將需嵌入的文件擴展名改成.tag

header.tag

<%@ tag pageEncoding="UTF-8" trimDirectiveWhitespaces="true"%>
<%@ tag import="java.util.Date" import="java.text.DateFormat"%>  
<script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery-1.11.3.min.js" ></script>
<img src="${pageContext.request.contextPath}/p_w_picpaths/default-photo.png" width="30px" height="35px" />
<%  
  DateFormat dateFormat = DateFormat.getDateInstance(DateFormat.LONG);  
  Date now = new Date(System.currentTimeMillis());  
%>  
<%=dateFormat.format(now) %>  
<script type="text/javascript">
	$(document).ready(function(){
		alert("ok");
	});
</script>


hello_tag.jsp

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%>
<%@ taglib prefix="lucl" tagdir="/WEB-INF/tags" %>
<!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>HelloTag</title>
</head>
<body>
	<lucl:header/>
</body>
</html>


  • 給tag flie傳遞數據

simple.tag

<%@ tag pageEncoding="UTF-8" trimDirectiveWhitespaces="true"%>
<%@ attribute name="userName" required="true" type="java.lang.String" description="簡單示例：用戶名" %>
<table style="border : 1px solid black;">
	<caption><%=userName %></caption>
	<%
		for (int i = 0; i < 3; i++) {
	%>
		<tr>
			<%
				for (int j = 0; j < 5; j++) {
			%>
				<td style="width:30px;"><%=i %>.<%=j %></td>
			<%
				}
			%>
		</tr>
	<%
		}
	%>
</table>


hello_tag.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="shiro" uri="http://shiro.apache.org/tags" %>
<%@ taglib prefix="lucl" tagdir="/WEB-INF/tags" %>
<!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>未受權</title>
	</head>
	<body>
		<h1><lucl:header/>無訪問權限</h1>
		<lucl:simple userName="張三"></lucl:simple>
	</body>
</html>


容器查找Tag文件的方法

WEB-INF/tags目錄
WEB-INF/tags的子目錄
WEB-INF/lib目錄的JAR文件中的META-INF/tags目錄
WEB-INF/lib目錄的JAR文件中的META-INF/tags的子目錄
若是tag文件部署在JAR文件中，則對應該tag文件必須有一個TLD
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程