JSP自己定义标签

Posted zhchoutai

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了JSP自己定义标签相关的知识,希望对你有一定的参考价值。

JSP自己定义标签


API文档:

http://docs.oracle.com/javaee/7/api/


技术分享图片

技术分享图片


//将所在jsp页面的pageContext注入进来,目的是为了在后面的方法中能够訪问到jsp页面对象的pageContext属性
setPageContext()

//设置此标签的父标签
setParent()       

//将标签中的属性注入到此class的属性,不须要自己实现但要提供属性的get与set方法
setAttribute()   

//在開始标签属性设置后调用。假设返回SKIP_BODY则忽略标签之中的内容,假设返回EVAL_BODY_INCLUDE则将标签体的内容进行输出
doStartTag()  

//在结束标签之前调用,返回SKIP_PAGE跳过整个jsp页面后面的输出,返回EVAL_PAGE运行页面余下部分
doEndTag() 

//生命周期结束时调用
release()          

无body。无属性的标签



1、创建一个类,实现Tag接口

技术分享图片




PrintTextTag.java

package com.lingdu.tag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

public class PrintTextTag implements Tag {
    Tag parent;
    PageContext pageContext;
    @Override
    public int doEndTag() throws JspException {
        try {
            //输出一句话
            this.pageContext.getOut().append("Hello, I am a tag");
        } catch (IOException e) {
            e.printStackTrace();
        }
        return PrintTextTag.SKIP_BODY;
    }

    @Override
    public int doStartTag() throws JspException {
        // TODO Auto-generated method stub
        return 0;
    }

    @Override
    public Tag getParent() {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public void release() {
        // TODO Auto-generated method stub

    }

    @Override
    public void setPageContext(PageContext arg0) {
        this.pageContext = arg0;

    }

    @Override
    public void setParent(Tag arg0) {
        this.parent = arg0;

    }

}

2、创建.tld配置文件



在WEB-INF中新建一个pt.tld文件

技术分享图片




写入配置文件

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.0" 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">
    <tlib-version>1.0</tlib-version>
    <jsp-version>2.0</jsp-version>
    <short-name>Example TLD</short-name>
    <tag>
        <!-- 定义标签的名字 -->
        <name>hi</name>
        <!-- 引用的类 -->
        <tag-class>com.lingdu.tag.PrintTextTag</tag-class>
        <body-content>empty</body-content>
    </tag>
</taglib>

3、在jsp中使用自己定义标签



引用pt.tld配置文件:

<%@ taglib prefix="pt" uri="/WEB-INF/pt.tld"%>



pt.jsp源代码:

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib prefix="pt" uri="/WEB-INF/pt.tld"%>

<!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>Insert title here</title>
</head>
<body>

<pt:hi/>

</body>
</html>

技术分享图片




有body,有属性的标签

技术分享图片


1、创建一个类。实现Tag接口



PrintTextAttr.java

package com.lingdu.tag;
import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

public class PrintTextAttr implements Tag {
    Tag parent;
    PageContext pageContext;
    String username;
    @Override
    public int doEndTag() throws JspException {
        try {
            this.pageContext.getOut().append("带body的标签");
            if(this.getUsername().equals("lingdu")){
                this.pageContext.getOut().append("lingdu");
            }else{
                this.pageContext.getOut().append("You don‘t enter lingdu !");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return this.SKIP_BODY;
    }

    public String getUsername(){
        return username;
    }
    public void setUsername(String username){
        this.username = username;
    }
    @Override
    public int doStartTag() throws JspException {
        // TODO Auto-generated method stub
        return 0;
    }

    @Override
    public Tag getParent() {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public void release() {
        // TODO Auto-generated method stub

    }

    @Override
    public void setPageContext(PageContext arg0) {
        this.pageContext = arg0;

    }

    @Override
    public void setParent(Tag arg0) {
        this.parent = arg0;

    }

}

2、创建.tld配置文件



在WEB-INF中新建一个pt.tld文件

技术分享图片




写入配置文件

<?xml version="1.0" encoding="UTF-8"?

> <taglib version="2.0" 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"> <tlib-version>1.0</tlib-version> <jsp-version>2.0</jsp-version> <short-name>Example TLD2</short-name> <tag> <!-- 定义标签名字 --> <name>pt2</name> <!-- 指定类的路径 --> <tag-class>com.lingdu.tag.PrintTextAttr</tag-class> <body-content>empty</body-content> <attribute> <!-- 自己定义定义属性 --> <name>username</name> <!-- 是否是必须属性 --> <required>false</required> <!-- 使用标签时能否够使用表达式来动态指定数据 --> <rtexprvalue>true</rtexprvalue> </attribute> </tag> </taglib>


3、在jsp中使用自己定义标签



引用pt.tld配置文件:

<%@ taglib prefix="pt" uri="/WEB-INF/pt.tld"%>



pt2.jsp源代码:

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib prefix="pt2" uri="/WEB-INF/pt2.tld"%>
<!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>Insert title here</title>
</head>
<body>
<%
    //測试属性
    request.setAttribute("username", "lingdu");
%>
<pt2:pt2 username="${username }"/>
</body>
</html>

技术分享图片



将測试属性去掉

技术分享图片




tld文件具体解释


<taglib>的子元素


Element:        //Description
tlib-version//Tag库的版本号
jsp-version//Tag库所须要的jsp的版本号
short-name//助记符,tag的一个别名(可选)
uri:            //用于确定一个唯一的tag库
display-name//被可视化工具用来显示的名称(可选)
small-icon//被可视化工具用来显示的小图标(可选)
large-icon//被可视化工具用来显示的大图标(可选)
description:    //对tag库的描写叙述(可选)
listener:       //參见以下listener元素
tag//參见以下tag 元素
Listener元素: //一个tag库可能定义一些类做为它的事件侦听类,这些类在TLD中被称为listener 元素。jspserver将会实例化这些侦听类。而且注冊它们。

Listener元素中有一个叫listener-class的子元素,这个元素的值必须是该侦听类的完整类名。


Tag元素


       每一个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。当中脚本变量的值能够直接在TLD中定义或通过tag附加信息的类来取得。每一个属性描写叙述了这个属性能否够省略,它的值能否够通过<%=…%>这种JSP语法来获得,以及属性的类型。每一个tag在TLD中相应一个tag元素。下表是tag元素的子元素:



name:           //独一无二的元素名
tag-class//Tag标签相应的tag处理类
tei-class//javax.servlet.jsp.tagext.TagExtraInfo的子类,用于表达脚本变量(可选)
body-content//Tag标签body的类型
display-name//被可视化工具用来显示的名称(可选)
small-icon//被可视化工具用来显示的小图标(可选)
large-icon//被可视化工具用来显示的大图标(可选)
description:    //此tag标签的描写叙述
variable//提供脚本变量的信息 (可选)
attribute:      //Tag标签的属性名


































以上是关于JSP自己定义标签的主要内容,如果未能解决你的问题,请参考以下文章

jstl标签库基础教程及其使用代码

jsp自定义标签

JSP回顾

JSP自己定义标签继承哪个类

自定义标签

JSP自定义标签的使用简化版