欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

jsp-自定义标签

程序员文章站 2022-05-30 21:19:41
...

自定义标签简介

  • 自定义标签主要用于移除jsp页面中的java代码。提高代码的复用性
  • 使用自定义标签移除jsp页面中的java代码,只需要完成以下两个步骤:
    • 编写一个实现Tag接口的java类(标签处理器类)
    • 编写标签库描述符(tld)文件,在tld文件中对标签处理器类描述成一个标签
    • 参考Tomcat中的examples项目中jsp部分

简单标签

  • 由于传统标签使用三个标签接口来完成不同的功能,显得过于繁琐,不利于标签技术的推广,Sun公司为降低标签技术的学习难度,在jsp2.0中定义了一个更为简单、便于编写和调用的SimpleTag接口来实现标签的功能。实现SimpleTag接口的标签通常称为简单标签。简单标签共定义了5个方法:
    • void setJspContext(JSPContext pc)
    • void setParent(JspTag parent)
    • void setJspBody(JspFragment jspBody)
    • void doTag()
    • JspTag getParent()

SimpleTag接口方法的执行顺序

  • 当web容器开始执行标签时,会调用如下方法完成标签的初始化
    • web容器调用标签处理器对象的setJspContext方法,将代表JSP页面的pageContext对象传递给标签处理器对象
    • web容器调用标签处理器对象的setParent方法,将父标签处理器对象传递给这个标签处理器对象。注意,只有在标签存在父标签的情况下,web容器才会调用这个方法。
    • 如果调用标签时设置了属性,容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或者脚本表达式,则web容器首先计算表达式的值,然后把值传递给标签处理器对象
    • 如果简单标签有标签体,容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来
  • 执行标签时
    • 容器调用标签处理器的doTage()方法,开发人员在方法体内通过操作JSPFragment对象,就可以实现是否执行,迭代,修改标签体的目的。

自定义标签入门

  • 需求:自定义标签<mys:print>在页面中输出hello world
    • 编写标签类
      • 编写一个类,继承SimpleTagSupport类
      • 重写两个方法,doTag()和setJspContext(JspContext pc)
      • 通过JspContext对象可以获取out对象向外输出内容
    • 提供tld文件进行配置
      • 通过<tag>标签配置自定义标签
      • 配置标签名称<name>print</name>
      • 配置标签的类<tag-class>xxx.xxx.xxx</tag-class>
      • 配置标签体的内容<body-content>empth</body-content>
    • 在JSP的页面中引入该标签库

jsp-自定义标签

package cn.zst.tag;

import javax.servlet.jsp.JspContext;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.SimpleTagSupport;
import java.io.IOException;

/**
 * Created by zst on 2018/5/25.
 */
public class TagDemo1 extends SimpleTagSupport {
    private PageContext pac;
    @Override
    public void doTag() throws JspException, IOException {
        pac.getOut().write("hello world");
    }

    @Override
    //服务器默认执行该方法
    public void setJspContext(JspContext pc) {
        //实际上是传递的JSPContext的实现类对象PageContext
        this.pac=(PageContext)pc;
    }
}

配置文件

<?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  http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd">
    <tlib-version>1.0</tlib-version>
    <short-name>mc</short-name>
    <uri>http://www.zst.tag/1101/myc</uri>

    <!--配置自定义标签-->
    <tag>
        <!--配置标签名称-->
        <name>print</name>
        <!--配置标签的全路径-->
        <tag-class>cn.zst.tag.TagDemo1</tag-class>
        <!--配置标签主体,么有标签主体就配置成空-->
        <body-content>empty</body-content>

    </tag>

</taglib>

页面显示

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<%@ taglib prefix="mc" uri="http://www.zst.tag/1101/myc" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<mc:print/>
<!--页面输出:hello world:-->
</body>
</html>

Body-content的配置

  • <body-content>元素的可选值有
    • empty:不能有标签体内容
    • JSP:标签体内容可以是任何东西:EL,JSTL,<%=%>,<%%>以及HTML;但是不建议使用java代码,simpleTag 已经不再支持使用<body-content>JSP</body-content>;
    • scriptless(常用):标签体内容不能是java代码段,但可以是EL,JSTL等
    • tagdependent :标签体内容不做运算,由标签处理类自行处理,无论标签体内容是EL,JSP,JSTL都不会做运算。

带有标签主体的标签

public class TagDemo2 extends SimpleTagSupport {
    private PageContext pac;
    @Override
    public void doTag() throws JspException, IOException {
        JspFragment jf = getJspBody();
        jf.invoke(pac.getOut());
        //jf.invoke(null);底层默认调用out对象输出。
    }

    @Override
    public void setJspContext(JspContext pc) {
        this.pac=(PageContext)pc;
    }
}
<!--配置-->
    <tag>
        <name>out</name>
        <tag-class>cn.zst.tag.TagDemo2</tag-class>
        <body-content>scriptless</body-content>
    </tag>
相关标签: jsp-自定义标签