在JAVA项目开发中,JSP自定义标签,可以使前端的展现简洁与方便。JSP的自定义标签从广义上来说,有2种形式,一种是需要进行DOM内容展示的,需要进行继承SimpleTagSupport类并重写的doTag()方法,另一种是自定义的函数,处理页面的显示元素,不需要实现doTag()方法。
1.继承SimpleTagSupport类并重写的doTag()方法来开发一个最简单的自定义标签
创建"Mess"标签
接下来,我们想创建一个自定义标签叫作<ex:Mess>,带有标签体,标签格式为:
<ex:Mess>
This is message body
</ex:Mess>
要创建自定义的JSP标签,你首先必须创建处理标签的Java类。所以,让我们创建一个MessageTag类,如下所示:
import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;
public class MessageTag extends SimpleTagSupport {
private String message;
public void setMessage(String msg) {
this.message = msg;
}
StringWriter sw = new StringWriter();
public void doTag()
throws JspException, IOException
{
if (message != null) {
/* 从属性中使用消息 */
JspWriter out = getJspContext().getOut();
out.println( message );
}
else {
/* 从内容体中使用消息 */
getJspBody().invoke(sw);
getJspContext().getOut().println(sw.toString());
}
}
}
属性的名称是"message",所以setter方法是的setMessage()。现在让我们在项目的\WEB-INF\tld\messageTag .tld的TLD文件中使用的<attribute>元素添加此属性:
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>2.0</jsp-version>
<short-name>Example TLD with Body</short-name>
<tag>
<name>Mess</name>
<tag-class>com.**.MessageTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>message</name>
</attribute>
</tag>
</taglib>
attribute标签,你还可以包含以下属性:
属性 | 描述 |
---|---|
name | 定义属性的名称。每个标签的是属性名称必须是唯一的。 |
required | 指定属性是否是必须的或者可选的,如果设置为false为可选。 |
rtexprvalue | 声明在运行表达式时,标签属性是否有效。 |
type | 定义该属性的Java类类型 。默认指定为 String |
description | 描述信息 |
fragment | 如果声明了该属性,属性值将被视为一个 JspFragment。 |
如果你使用了两个属性,修改TLD文件,如下所示:
.....
<attribute>
<name>attribute_name1</name>
<required>false</required>
<type>java.util.Boolean</type>
<fragment>false</fragment>
</attribute>
<attribute>
<name>attribute_name2</name>
<required>true</required>
<type>java.util.Date</type>
</attribute>
.....
现在我们就可以在JSP文件中使用message属性了,如下所示:
<%@ taglib prefix="ex" uri="WEB-INF/tld/messageTag.tld"%>
<html>
<head>
<title>A sample custom tag</title>
</head>
<body>
<ex:Mess message="This is custom tag" />
</body>
</html>
以上实例数据输出结果为:
This is custom tag
2. 自定义的函数,不需要重写doTag()方法。
首先建立一个普通的java类,如ShiroFunctions:
public class ShiroFunctions {
/**
* 功能:集合里,元素的包含判定,包含返回true,不包含返回false
*
* @param iterable
* @param element
* @return
*/
public static boolean in(Iterable iterable, Object element) {
if (iterable == null) {
return false;
}
return CollectionUtils.contains(iterable.iterator(), element);
}
}
注意,里面的方法一定要为static静态方法。
在WEB-INFO\tld\shiro-functions.tld标签描述文件中写:
<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.1" xmlns="http://java.sun.com/xml/ns/javaee" 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_1.xsd">
<tlib-version>1.0</tlib-version>
<short-name>shiro-functions</short-name>
<uri>/WEB-INF/tld/shiro-functions</uri>
<function>
<name>in</name>
<function-class>com.imdream.core.tablib.ShiroFunctions</function-class>
<function-signature>boolean in(java.lang.Iterable,java.lang.Object)</function-signature>
<description>集合中,对象的包含判断</description>
</function>
</taglib>
在要使用的jsp页面引入标签
<%@taglib prefix="shirofn" uri="/WEB-INF/tld/shiro-functions" %>
在页面中就可以使用这个标签了,
<li data-id="${r.id}" data-pid="${r.parentId}" data-tabid="form-button" data-faicon="bell" data-checked="${shirofn:in(existIds, fn:trim(r.id))}">${r.resourceName}</li>