javaee学习之自定义tag

什么是定制的标签(Custom Tag)?

自定义标签（tag）是一种用户自定义的JSP语言元素，当容器将JSP转化成servlet时，Tag被转化成对Tag处理器的操作，在项目运行时，容器调用这些tag处理器操作。

自定义标签的特点

  • 可以通过调用它的页面传递来的属性进行定制化
  • 可以向调用它的页面传回变量
  • 可以访问JSP页面可用的所有对象
  • 可以互相通信
  • 可以嵌套，并通过私有变量通信

创建tag处理器的方法

1）Tag Files

Tag Files用于开发展现为中心的自定义Tag，他的功能十分强大，使得快速开发和维护动态网页比以前更加容易，甚至可供不懂Java的页面编辑人员使用 ，就能开发出全新的动态网页。

2）Simple Tags

只能用于在属性值或tag体中不使用脚本的tag中

3）Classic Tags

只能用于在属性值或tag体中需要使用脚本的tag中

第一种方法通过使用tag文件实现jsp标签，后两者通过使用tld文件实现jsp标签，后面会详细介绍这两种文件。

一、 Tag Files

如何向JSP中动态添加可复用的内容？

可以使用<jsp:include> 和 <c:import>嵌入文件，还可以通过<jsp:param> 和 <c:param>在嵌入文件中使用请求参数。

如果只是为了给嵌入的文件一些客户化信息，就创建新的请求参数，会使资源浪费，而且嵌入的内容不易理解，必须要知道嵌入的参数是什么。

接下来介绍一种更利于我们去理解嵌入页面的方式 —— Tag Files。

1.1 使用Tag File

下面通过一个例子来介绍Tag File的使用。

需求：将一个带有logo的头文件嵌入到jsp页面中。

1.将需嵌入的文件扩展名改为.tag。

Header.tag

1
<img src="img/ogo.png"> <br>

2.将以上的tag文件放到一个目录下，如WEB-INF/tags

3.在jsp中使用taglib指令，首先需要先导入标签库，再使用标签。

1
2
3
4
5
<%@ taglib prefix="myTag" tagdir="/WEB-INF/tags" %> //导入标签库
<html><body>
	<myTags：Header/>
	Welcom to our site.
</body></html>

  • prefix：指定使用时标签前缀。

  • tagdir：用于指定tag文件存放的位置。

    该页面使用 <myTags：Header>，也就是说此处用到了tag处理器，使用的ta

    g处理器是放在tagdir目录下的 Header.tag 文件，容器会找到tag文件的位置。

1) 给tag flie传递数据

使用tag的属性可以给tag flie传递数据。例如对上面的需求进行完善。

需求：在jsp页面插入一个头部，这个头部包含一个logo和自定义标题，标题的内容可以在jsp页面指定。

1. header.tag中使用属性指令。

1
2
3
<%@ attribute name="subTilte" required="true" rtextprvalue="true" %>
<img src="img/ogo.png">
<strong> ${subTilte} </strong>
  • <%@ attribute>代表着一个tag的属性指令。
  • name：属性名
  • required：属性是否必需
  • rtextprvalue=”true”：属性可以是字符串文本或表达式

2.在JSP页面使用tag。

1
2
3
4
5
<%@ taglib prefix="myTag" tagdir="/WEB-INF/tags" %>
<html><body>
	<myTags：Header subTitle="we take the string out of SOAP" />//自定义subTitle
	Welcom to our site.
</body></html>

二、 使用TLD

使用tag文件的时候，每一个tag处理器就需要编写一个tag文件，现在我们可以使用TLD统一声明tag。

Tag Library Descriptor (TLD)，描述了EL函数(EL functions) 和 自定义Tag ，他通过使用EL函数扩展EL的功能 ，并且可以描述了自定义Tag。

2.1 使用 EL函数扩展EL的功能

通过EL表达式调用一个POJO上的静态方法来实现拓展EL函数的功能。通过下面4个步骤完成。

1.写一个具有公共静态方法的Java 类 

1
2
3
4
5
6
package foo;
public class DiceRoller{
	Public static int rollDice(){
	return (int ) ((Math.random()*6)+1);
}
}

2.写TLD文件，它实现了定义函数功能的Java类到调用函数 的JSP页面间的映射

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?xml version=”1.0” encoding=”ISO-8859-1” ?>
<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/webjsptaglibrary_2_0.xsd” version=”2.0”>
<tlib-version>1.2</tlib-version>
<uri>DiceFunctions</uri>
    <function>
        <name>rollIt</name>
        <function-class>foo.DiceRoller</function-class>  //java类的位置
        <function-signature>
        	int rollDice() //功能函数
        </function-signature>
    </function>
</taglib>

3.在JSP中使用taglib指令,使用EL调用该函数.

uri属性将TLD的名字告诉容器， 以便容器知道JSP调用EL函数 时应调用哪个Java方法

1
2
3
4
 <%@ taglib uri="DiceFunctions" prefix="mine"%>  //uri对应于TLD中的uri
<body>
	${mine:rollit()}  //函数名rollIt()来自于TLD中的name，而不是实际Java类中的方法名
</body>

2.2 用TLD描述自定义Tag

这是一个TLD的例子。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?xml version=”1.0” encoding=”ISO-8859-1” ?>
<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/web-jsptaglibrary_2_0.xsd”
version=”2.0”>

    <tlib-version>1.2</tlib-version> //这个标签是强制性的，指明tag库的版本
    <short-name>RandomTags</short-name>//强制性的，主要为工具使用
    
    <uri>randomThings</uri>  //在taglib指令中使用的唯一名字
    <tag>
        <description>random advice</description>
        
         //必需的，在tag中使用，如<my:advice>
        <name>advice</name> 
        
		//必需的，当JSP中使用tag时，容器调用该类
        <tag-class>foo.AdvisorTagHandler</tag-class> 
        <body-content>empty</body-content>//必需的，说明tag体为空
        
        //如果tag有属性，则每个tag属性必须有一个<attribute>元素
        <attribute>
            <name>user</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
</taglib>
1) Tag体中的内容

TLD 中<body-content>元素的定义:

  • <body-content>empty</body-content>:Tag不能有tag 体
  • <body-content>scriptless</body-content>:tag不能有脚本元素 (代码片断、脚本表达式、声明 )， 但是可以是文字、EL和自定义或标准动作.
  • <body-content>tagdependent</body-content>:tag体被看作纯文本，所以EL, tags和动作将不被求值。
  • <body-content>JSP</body-content>：tag体可以是JSP中能使用任何东西。
2 ) rtexprvalue

rtexprvalue的全称是 Run-time Expression Value， 它用于表示是否能够利用JSP表白式。总结来说最简单的就是在使用标签时能不能使用表达式来动态指定数据。true是可以，false是不可以。

就上面的例子说： <rtexprvalue>true</rtexprvalue>说明 在jsp页面中，user这个属性可以使用脚本和EL表达式来获取，如果是false，说明user这个属性是字符串文本。

3）容器怎样找到TLD

Web应用部署时，容器自动在TLD文件和 名字间建立映射。

容器首先查找DD中是否有，如果有则使用它创建 map，如果没有，则在特定位置查找TLD，并为tag库建立map。

容器在四个地方寻找 TLD文件

  • 直接在WEB-INF中找
  • 在WEB-INF的子目录中找
  • 在WEB-INF/lib中的JAR 文件的META-INF目录中找
  • 在WEB-INF/lib中的JAR 文件的META-INF的子目 录中找

三、Tag处理器

Tag处理器是执行tag工作的Java类，Tag处理器类可以访问tag属性、tag 体、page context（因此可以获得因此可以获得各个作用域中的属 性及请求和响应）

自定义tag处理器分为Classic tag处理器 和 Simple tag处理器 。接下来主要介绍怎常见一个Simple tag处理器。

3.1 Simple Tag处理器

1）创建一个Simple Tag处理器

需求通过Simple Tag处理器记录用户访问网站的次数，并输出。

1.写一个扩展SimpleTagSupport的类，重载doTag()方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
public class CounterSimpleTag1 extends SimpleTagSupport {
	private static int counter = 1;
	public void doTag() throws JspException,IOException{
		getJspContext().getOut().print(counter);
	}
	public int getCounter() {
		return counter;
	}

	public void setCounter() {
		counter++;
	}
}

2.写TLD文件，为Tag创建TLD: simple.tld，并将TLD放到WEB-INF中。

1
2
3
4
5
6
7
8
9
10
11
12
<?xml version="1.0" encoding="UTF-8"?>
<taglib>
	<tlib-version>1.0</tlib-version>
	<jsp-version>1.2</jsp-version>
	<short-name>MySimpleTag1</short-name>
	<uri>SimpleTag</uri> 
	<tag>
		<name>simple1</name>
		<tag-class>lesson.j2ee.ex3.CounterSimpleTag1</tag-class>
		<body-content> empty </body-content>
	</tag>	
</taglib>

3.在JSP中使用tag

1
2
3
4
5
6
<%@ taglib uri="SimpleTag" prefix="mytag"%>  //uri对应于TLD中的uri
<body>
		This application has been visited
		<mytag:simple1/>  //mytag对应于prefix，simple1对应于TLD中的tag的name值
	</form>
</body>
2）Simple tag的寿命周期

Simple tag的寿命周期如下图所示：

javaee学习之自定义tag/image-20200424161830895
3）在tag体中使用EL

在调用tag的jsp页面

1
2
3
<myTags:simple3>
Message is: ${message}
</myTags:simple3>

其中message是simple处理器中的输出变量。

1
2
3
4
5
public class SelectSimpleTag3 extends SimpleTagSupport {
		getJspContext().setAttribute("message", "success");	
		//处理tag体，将它打印到响应。null参数意思是输出到response对象上，还可以传进其它writer对象
		getJspBody().invoke(null);
}
4) 处理有属性的tag

处理有属性的tag , 需要在TLD中设置属性（2.2节的例子相似） , 在tag处理器中为每个属性提供一个Bean类型的 set方法.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public class SimpleTagTest5 extends SimpleTagSupport {
    private List movieList;
    //set方法
    public void setMovieList(List movieList) {
    	this.movieList=movieList;
    }
    public void doTag() throws JspException, IOException {
        Iterator i = movieList.iterator();
        while(i.hasNext()) {
            Movie movie = (Movie) i.next();
            getJspContext().setAttribute(“movie”, movie);
            getJspBody().invoke(null);
    	}
    }
}
赏

谢谢你请我吃糖果

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家