自定义标签-阿里云开发者社区

一、简介

1.前言

在JSP中，可以通过使用自定义标签来创建自己的标签库，并将这些标签用于页面中。自定义标签库是一组自定义标签的集合，可以在JSP页面中引用并使用。通过自定义标签，可以将一些重复的业务逻辑封装在标签中，使得页面更具简洁性、可读性和可维护性。

要创建自定义标签库，首先需要定义标签，包括标签名称、标签属性和标签处理程序。之后，需要将标签打包成标签库文件，并将其声明在TLD（tag library descriptor）文件中。最后，在页面中引用标签库，并使用标签库中的标签。

自定义标签是JSP技术的重要组成部分，可以极大地提高JSP页面的可维护性和灵活性，使得JSP技术更加强大和智能化。

2.什么是自定义标签

自定义标签是指用户可以自定义添加的标签，用于方便对浏览器中收藏夹、历史记录等内容进行分类和管理。用户可以根据自己的需要，创建不同的自定义标签，并将相关网页链接、笔记等内容归类到对应标签下，以便于后续查找和使用。自定义标签能够帮助用户更加高效地管理自己的浏览器内容，提高工作效率和阅读体验。

3.作用

自定义标签在JSP中的作用是提高代码的重用性和可读性，使得页面更加模块化和灵活。通过自定义标签，可以将一些重复的页面代码封装为标签，然后在需要使用的地方引用这些标签，从而避免了重复编写相同的代码和增加代码的复杂性。

具体来说，自定义标签的作用包括以下几个方面：

1.简化页面代码：通过封装重复的页面结构和业务逻辑，自定义标签可以使得页面代码更简洁，可读性更高。

2.提高代码的重用性：一旦封装了重复的业务逻辑，就可以在多个页面上重复使用这些标签，从而提高代码的重用性。

3.增加页面的灵活性：使用自定义标签可以使得页面的布局更加灵活，可以在页面上更方便地添加、删除和移动元素。

4.增加代码的可维护性：通过将代码封装为标签，使得代码的修改更加集中和规范化，从而增加了代码的可维护性和可扩展性。

综上所述，自定义标签是JSP技术中的重要组成部分，它可以提高代码的重用性、可读性和可维护性，使得JSP技术更加智能化和高效化。

二、标签

1.什么是标签

JSP标签是一种封装视图逻辑的技术，用于将Java代码嵌入到JSP页面中的 HTML 标记中。JSP标签一般有两种类型：动态标签和静态标签。

动态标签是由Java类定义、并通过JSP页面在运行时动态创建的标签，它们可以包含Java代码和JSP标准标签语言。动态标签是JSP技术的一大优势，因为它可以使Java开发人员在HTML标记中嵌入Java代码，这意味着我们可以使用Java构建自定义标签，提供新的功能，或者与现有标记库实现更紧密的集成。

与之相反，静态标签是不包含Java代码、仅通过XML或TLD文件定义的标签，它们只能在编译时解析。静态标签是JSP技术的另一个优势，因为它可以使非Java开发者构建自定义标签（如前端工程师），以提供HTML或CSS功能，而无需了解Java语法。

无论是动态标签还是静态标签，它们都可以通过标记库在JSP页面中使用，提高代码的重用性和组织性。JSP标签使得JSP页面更加强大和灵活，简化了Java EE应用的构建和开发。

2.标签的特点

标签具有以下几个特点：

1. 标签是语法结构：标签是可扩展标记语言（如HTML、XML）的语法结构，它们需要遵循一定的语法规则才能被正确地解析。

2. 标签是元素：标签通常用于描述Web页面中的元素，如文本、图片、链接等。

3. 标签具有属性：标签可以包含属性，属性用于补充描述标签的元素类型、属性值等信息。

4. 标签可嵌套：标签可以相互嵌套，形成嵌套结构，用于表示不同层次的元素和内容。

5. 标签可以自闭合：有些标签不需要结束标签，可以直接作为自闭合标签使用，如<img>标签。

6. 标签可以被CSS或JavaScript操作：通过定义类名和ID等属性，或者使用JavaScript来寻找标签，对标签进行样式或行为操作。

7. 标签可以被扩展：通过扩展标签库，可以定义自定义标签以完成更特化的功能。

综上所述，标签是Web页面中很重要的概念，具有上述特点。掌握标签的特点有利于我们更好地使用和理解Web开发技术。

三、自定义标签实例

常见自定义标签主要步骤：

编写助手类
编写标签库描述文件（tld）
在页面上引入标签使用

以上描述文件（tld）的创建流程

再之后命名(该文件的命tld结尾)

常用标签类型:

UI标签，输出页面元素
控制标签，如if标签，foreach标签等
数据标签，用于向页面输入数据

1.out

1.1标签助手类

package com.Jun.Customlabels;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 * @author Jun
 * @com.Jun.Customlabels
 * @OutTag(说明):自定义标签(Out)助手类
 */
public class OutTag extends BodyTagSupport{
  private String val;
  private String defaultVal;
  @Override
  public int doStartTag() {
    JspWriter out = this.pageContext.getOut();
    try {
      if(this.val==null || "".equals(this.val)) {
        out.println(this.defaultVal);
      }else {
        out.println(this.val);
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
    return SKIP_BODY;
  }
  public String getVal() {
    return val;
  }
  public void setVal(String val) {
    this.val = val;
  }
  public String getDefaultVal() {
    return defaultVal;
  }
  public void setDefaultVal(String defaultVal) {
    this.defaultVal = defaultVal;
  }
}

1.2描述文件（tld）

<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
   "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<!-- 标签库描述符 -->
<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
  <tlib-version>1.0</tlib-version>
  <jsp-version>1.2</jsp-version>
  <short-name>Simple Tags</short-name>
  <uri>/OutTag</uri>
  <tag>
    <!-- 标签名 -->
    <name>out</name>
    <!-- 标签助手类 -->
    <tag-class>com.Jun.Customlabels.OutTag</tag-class>
    <!-- 标签的内容类型：empty表示空标签，jsp表示可以为任何合法的JSP元素 -->
    <body-content>empty</body-content>
    <attribute>
      <!-- 属性名， OutTag类中的val属性相匹配 -->
      <name>val</name>
      <!-- 表示该属性为必要的属性 -->
      <required>true</required>
      <!-- 该属性可以接受EL表示式的值 -->
      <rtexprvalue>true</rtexprvalue>
      <!-- 标签描述，用于说明标签的作用 -->
      <description>out标签的属性val,用于输出val值</description>
    </attribute>
    <attribute>
      <!-- 属性名， OutTag类中的defaultVal属性相匹配 -->
      <name>defaultVal</name>
      <!-- 表示该属性为必要的属性 -->
      <required>false</required>
      <!-- 该属性可以接受EL表示式的值 -->
      <rtexprvalue>false</rtexprvalue>
      <!-- 标签描述，用于说明标签的作用 -->
      <description>out标签的值为null或者空,则输出默认值</description>
    </attribute>
  </tag>
</taglib>

1.3标签测试

以下是jsp页面标签及代码

<!-- 测试out标签,如果值为null或者为空时会不会输出默认值 -->
<%request.setAttribute("name",null); %>
<!-- 使用out标签 -->
<o:out val="${name }" defaultVal="ikun"/>
<!-- 如果out标签的val值不是null或空,则输出val属性中的值 -->
<o:out val="前线迷雾" />

2.if

2.1if标签助手类

package com.Jun.Customlabels;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 * @author SAME_LOVE
 * @com.Jun.Customlabels
 * @IfTag(说明):自定义标签(If)
 */
public class IfTag extends BodyTagSupport{
  private boolean text;
  @Override
  public int doStartTag() {
    if(this.text) {
      return EVAL_BODY_INCLUDE;
    }
    return SKIP_BODY;
  }
  public boolean isText() {
    return text;
  }
  public void setText(boolean text) {
    this.text = text;
  }
}

2.2if描述文件（tld）

<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
   "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<!-- 标签库描述符 -->
<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
  <tlib-version>1.0</tlib-version>
  <jsp-version>1.2</jsp-version>
  <short-name>Simple Tags</short-name>
  <uri>/OutTag</uri>
  <tag>
     <!-- 标签名 -->
    <name>if</name>
    <!-- 标签助手类 -->
    <tag-class>com.Jun.Customlabels.IfTag</tag-class>
    <!-- 标签的内容类型：empty表示空标签，jsp表示可以为任何合法的JSP元素 -->
    <body-content>jsp</body-content>
    <attribute>
      <!-- 属性名， IfTag类中的val属性相匹配 -->
      <name>text</name>
      <!-- 表示该属性为必要的属性 -->
      <required>true</required>
      <!-- 该属性可以接受EL表示式的值 -->
      <rtexprvalue>true</rtexprvalue>
      <!-- 标签描述，用于说明标签的作用 -->
      <description>text该属性的返回值决定是否包含标签体部分</description>
    </attribute>
  </tag>
</taglib>

2.3if标签测试

以下是jsp页面标签及代码

<!-- 使用if标签 -->
<o:if text="${1==1}">
<!-- 测试返回结果一致,1是等于1的,所以该文本会显示出来 -->
1是等于1的
</o:if>
<!-- 使用if标签 -->
<o:if text="${1==2}">
<!-- 测试返回结果不一致,1是不等于2的,所以该该文本是不会显示出来的 -->
1是不等于2的
</o:if>

3.foreach

3.1foreach标签助手类

package com.Jun.Customlabels;
import java.util.Iterator;
import java.util.List;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 * @author Jun
 * @com.Jun.Customlabels
 * @ForeachTag(说明):自定义标签(Foreach)
 */
public class ForeachTag extends BodyTagSupport{
  //存放数据的集合
  private List<?> items;
  //每次循环获取的对象放入pageContext中，并以var属性的值为key进行保存
  //之后可以用var属性进行显示数据
  private String var;
  public List<?> getItems() {
    return items;
  }
  public void setItems(List<?> items) {
    this.items = items;
  }
  public String getVar() {
    return var;
  }
  public void setVar(String var) {
    this.var = var;
  }
  @Override
  public int doStartTag() {
    if(this.items==null || this.items.size()==0) {
      return SKIP_BODY;
    }
    Iterator<?> iterator = this.items.iterator();
    Object obj = iterator.next();
    this.pageContext.setAttribute(var, obj);
    this.pageContext.setAttribute("items", iterator);
    return EVAL_BODY_INCLUDE;
  }
  @Override
  public int doAfterBody() {
    Iterator<?> attribute = (Iterator<?>) this.pageContext.getAttribute("items");
    if(attribute.hasNext()) {
      this.pageContext.setAttribute(var, attribute.next());
      return EVAL_BODY_AGAIN;
    }
    return SKIP_BODY;
  }
}

3.2foreach描述文件（tld）

<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
   "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<!-- 标签库描述符 -->
<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
  <tlib-version>1.0</tlib-version>
  <jsp-version>1.2</jsp-version>
  <short-name>Simple Tags</short-name>
  <uri>/OutTag</uri>  
   <tag>
     <!-- 标签名 -->
    <name>foreach</name>
    <!-- 标签助手类 -->
    <tag-class>com.Jun.Customlabels.ForeachTag</tag-class>
    <!-- 标签的内容类型：empty表示空标签，jsp表示可以为任何合法的JSP元素 -->
    <body-content>jsp</body-content>
    <attribute>
      <!-- 属性名， IfTag类中的val属性相匹配 -->
      <name>items</name>
      <!-- 表示该属性为必要的属性 -->
      <required>true</required>
      <!-- 该属性可以接受EL表示式的值 -->
      <rtexprvalue>true</rtexprvalue>
      <!-- 标签描述，用于说明标签的作用 -->
      <description>items是保存数据的集合</description>
    </attribute>
      <attribute>
      <!-- 属性名， IfTag类中的val属性相匹配 -->
      <name>var</name>
      <!-- 表示该属性为必要的属性 -->
      <required>true</required>
      <!-- 该属性可以接受EL表示式的值 -->
      <rtexprvalue>true</rtexprvalue>
      <!-- 标签描述，用于说明标签的作用 -->
      <description>将集合数据放入var，在jsp中进行显示,如:${var.pid}</description>
    </attribute>
  </tag>
</taglib>

3.3foreach数据辅助类

Person(人类)

package com.Jun.Customlabels;
/**
 * @author SAME_LOVE
 * @com.Jun.Customlabels
 * @Person(说明):Person(数据测试辅助类)
 */
public class Person {
  private String pid;
  private String name;
  public String getPid() {
    return pid;
  }
  public void setPid(String pid) {
    this.pid = pid;
  }
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public Person(String pid, String name) {
    super();
    this.pid = pid;
    this.name = name;
  }
}

package com.Jun.Customlabels;
import java.util.ArrayList;
import java.util.List;
/**
 * @author SAME_LOVE
 * @com.Jun.Customlabels
 * @Text01(说明):数据测试辅助类
 */
public class Text01 {
  public static List<Person> getPerson(){
     List<Person> pelist= new ArrayList<>();
     Person p1 =  new Person("p01","ikun");
     Person p2=   new Person("p02","红桃皇后");
     Person p3 =  new Person("p03","巨龙传说");
    pelist.add(p1);
    pelist.add(p2);
    pelist.add(p3);
    return pelist;
  }
}

3.4foreach标签测试

<!-- 调用Text01的方法获取数据 -->
<%request.setAttribute("list", Text01.getPerson());%>
<o:foreach items="${list }" var="p">
<p>${p.pid }----${p.name }</p>
</o:foreach>

四、jsp综合

代码综合

<%@page import="com.Jun.Customlabels.Text01"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@taglib prefix="o" uri="/OutTag" %>
<!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>
<!-- 测试out标签,如果值为null或者为空时会不会输出默认值 -->
<%request.setAttribute("name",null); %>
<!-- 使用out标签 -->
<o:out val="${name }" defaultVal="ikun"/>
<!-- 如果out标签的val值不是null或空,则输出val属性中的值 -->
<o:out val="前线迷雾" />
<%request.setAttribute("id",1); %>
<!-- 使用if标签 -->
<o:if text="${1==1}">
<!-- 测试返回结果一致,1是等于1的,所以该文本会显示出来 -->
1是等于1的
</o:if>
<!-- 使用if标签 -->
<o:if text="${1==2}">
<!-- 测试返回结果不一致,1是不等于2的,所以该该文本是不会显示出来的 -->
1是不等于2的
</o:if>
<!-- 调用Text01的方法获取数据 -->
<%request.setAttribute("list", Text01.getPerson());%>
<o:foreach items="${list }" var="p">
<p>${p.pid }----${p.name }</p>
</o:foreach>
</body>
</html>

综合测试结果

综合流程描述

自定义标签的创建流程可以分为以下几个步骤：

1.编写标签处理类：首先要编写标签处理类，这是自定义标签的核心，也是最复杂和最关键的一步。该类需要实现javax.servlet.jsp.tagext.Tag接口或其子接口中的一种，该接口定义了与标签处理相关的方法，包括标签的生命周期方法和执行标签处理逻辑的方法。

2.创建标签描述文件：在创建标签处理类后，需要编写标签描述文件（Tag Library Descriptor，TLD），用于声明自定义标签的属性、使用方式和函数等信息。标签描述文件一般采用XML格式，可以保存到任意位置，但需要按照一定规则进行命名和存储。

3.部署标签处理类和描述文件：将标签处理类和描述文件部署到Web应用程序的特定位置。通常，标签处理类和描述文件可以部署到Web应用程序的WEB-INF目录下的任何子目录，然后通过web.xml文件或者注解进行映射关系的配置。

4.在JSP页面中使用自定义标签：在JSP页面中使用自定义标签时，需要导入标签库（taglib）并使用 <t:标签名> 标签调用自定义标签处理类。标签库必须在使用自定义标签前声明，以定义其前缀和URI。

综上所述，创建自定义标签需要编写标签处理类和标签描述文件，并将其部署到特定位置，然后可以在JSP页面中使用导入的标签库来调用自定义标签。自定义标签的创建是一个比较复杂的过程，但可以提高代码的重用性和可维护性，使得Web开发更加高效。

自定义标签

一、简介

1.前言

2.什么是自定义标签

3.作用

二、标签

1.什么是标签

2.标签的特点

三、自定义标签实例

1.out

1.1标签助手类

1.2描述文件（tld）

1.3标签测试

2.if

2.1if标签助手类

2.2if描述文件（tld）

2.3if标签测试

3.foreach

3.1foreach标签助手类

3.2foreach描述文件（tld）

3.3foreach数据辅助类

3.4foreach标签测试

四、jsp综合

代码综合

综合测试结果

综合流程描述

热门文章

最新文章

相关电子书

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

自定义标签

一、简介

1.前言

2.什么是自定义标签

3.作用

二、标签

1.什么是标签

2.标签的特点

三、自定义标签实例

1.out

1.1标签助手类

1.2描述文件（tld）

1.3标签测试

2.if

2.1if标签助手类

2.2if描述文件（tld）

2.3if标签测试

3.foreach

3.1foreach标签助手类

3.2foreach描述文件（tld）

3.3foreach数据辅助类

3.4foreach标签测试

四、jsp综合

代码综合

综合测试结果

综合流程描述

热门文章

最新文章

相关电子书