JavaWeb学习笔记（十九）之自定义标签

自定义标签

开发步骤

1.编写标签处理类

（1）传统方式（JSP1.1）：实现javax.servlet.jsp.tagext.Tag接口

doSatrtTag()：标签处理类的核心方法
该方法有以下2个返回值：0/1
int SKIP_BODY=0;标签体不会被执行
int EVAL_BODY_INCLUDE=1;标签体会被执行

（2）简单方式（JSP2.0）：实现javax.servlet.jsp.tagext.SimpleTag接口

doTag()：标签执行完毕之后的方法。例如可以让标签在执行完毕后，再执行一遍
int SKIP_PAGE=5;后面的JSP页面内容不被执行
int EVAL_PAGE=6;后面的JSP页面内容继续执行

如果jsp在编译阶段发现了自定义标签<xx:yyy>，就会交给doStartTag()或doTag()

传统方式的核心是有缓冲区，简单方式没有

2.编写标签描述符

编写建议：可以仿照一个其他标签语言（el，jstl）的tld文件

< body-content >的元素值共有4个
Tag属性

代码示例：<?xml version="1.0" encoding="UTF-8" ?>
<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/jsee/web-jsptagLibrary_2_0.xsd"version="2.0"><tlib-version>1.2</tlib-version><uri>标签库的url</uri><short-name>zd</short-name><!--表示标签的前缀名字类似于<jsp:forward>中的jsp-->  <tag><name>dict</name><!--表示标签的名字 类似于<jsp:forward>中的forward-->  <description>标签库描述</description><tag-class>com.zd.control.tag.DitcTag</tag-class>  <!--标签所在类 -->  <body-content>empty</body-content><!--是否存在标签体，简单标签是填scriptclass，传统标签填JSP--><!-- 标签添加参数 --><attribute><name>id</name><!-- 给select定义一个id（必须） --><required>true</required><rtexprvalue>false</rtexprvalue><!-- 说明属性不可以是一个运行时表达式（必须是一个常量String） --></attribute><attribute><name>name</name><!-- name映射（不是必须） --><required>false</required><rtexprvalue>false</rtexprvalue><!-- 说明属性不可以是一个运行时表达式（必须是一个常量String） --></attribute></tag>
</taglib>

3.导入并使用

myTag.tld(即自定义标签文件)只能导入到WEB-INF或子目录下/WEB-INF/xxx（但是不能放在WEB-INF/lib、WEB-INF/classes里）

引用具体要使用的.tld文件：

<% @taglib url=“每个tld文件的唯一标识符” prefix=""使用tld标签时的前缀 %>

具体的使用：1、空标签（没有标签体的标签）（1）<d:foreach></d:foreach>
（2）<d:foreach/>2、带标签体
<d:foreach>xxx</d:foreach>3、带属性
<d:foreach 属性名="属性值">xxx</d:foreach>4、嵌套
<d:foreach><d:foreach>xxx</d:foreach>
</d:foreach>

Tag接口中的所有方法执行顺序：

当JSP容器（Tomcat、jetty）在将.jsp翻译成.servlet(.java)的时候，如果遇到JSP中有标签，就会依次执行setPageContext()、setParent()、doStartTag()、doEndTag、realease()，用于解析标签的执行逻辑。

javax.servlet.jsp.tagext.IterationTag接口：（Tag的子接口）

如果有循环：IterationTag
没有循环：Tag
IterationTag接口中存在以下方法：
doAfterBody()：当标签体执行完毕之后的操作，通过返回值决定：
（EVAL_BODY_AGAIN = 2）：要么重复执行
（SKIP_BODY = 0）：要么不再执行

使用BodyContent修改标签显示内容

1.BoyTag接口:如果在标签体被显示之前，进行一些其他的“额外”操作

hello hello hello -> HELLO HELLO HELLO
int EVAL_ BODY_ BUFFERED = 2，是doStartTag() 的第三个返回值，代表一个缓冲区 (BodyContent)

2.BodyContent是abstract,具体使用时需要使用实现类BodyContentImpl (再引入jasper. jar)

缓冲区(BodyContent)的使用用途: hello ->HELLO
如果返回值是EVAL_ BODY _BUFFERED ，则服务器会自动将标签体需要显示的内容放入缓冲区中（BodyContent）。因此，如果要更改最终显示结果，只需要从缓冲区中获取原来的数据进行修改即可。具体就是通过getXxx()获取原来的数据(hello)，自己修改(HELLO)，输出getEnclosingWriter()。

简单方式

1.SimpleTag最大的简化：
将传统方式的doStartTag()、doEndTag()、doafterBody()等方法简化成了一个通用的doTag()方法。

2.SimpleTag接口中的方法

3.简单方式没有“缓冲区”，修改内容通过流的方式修改。

javax.servlet.jsp.tagext.JspFragment类：代表一块JSP元素（该块不包含scriptlet，因此简单方式的tld文件中< body-content >不能是JSP）
JspFragment中有一个invoke(Writer var1)方法，入参是“流”，即如果要修改显示内容，只需要修改此流。每调用一次invoke()方法，会执行一次标签体。
SimpleTagSupport的setJspBody()方法可以获取JspFragment对象
SimpleTagSupport的setJspContext()方法可以获取jsp的一些内置对象：setJspContext()的返回值是JspContext对象，而该对象是JSP内置对象的入口对象PageContext的父类。
条件选择：当某一个条件满足时再执行某个标签体
- 传统标签：如果条件不满足，让doStartTag()的返回值为0
- 简单标签：如果条件不满足，不调用invoke()即可
简单标签获取JSP内置对象：
- getJspContext() —> JspContext —> 转成子类PageContext —> PageContext就是所有JSP内置对象的入口，即可以获取一切JSP内置对象

使用简单标签实现登陆显示

代码示例： jsp表单接受用户名密码<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML>
<html>
<body><form action="LoginServlet">用户名：<input name="username" type="text"><br>密  码：<input name="password" type="password"><br><input name="提交" type="submit"></form>
</body>
</html>

代码示例：
//show.jsp<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib uri ="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="https://www.xc.com" prefix="xc"%>
<%@page isELIgnored="false" %>
<html>
<head><title>Title</title>
</head>
<body><xc:login>${sessionScope.username},恭喜您登陆成功！
</xc:login>
</body>
</html>

代码示例:
//LoginServlet.javapackage com.xc.servlet;import com.xc.dao.serviceDao;import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;@WebServlet("/LoginServlet")//servlet映射
public class LoginServlet extends HttpServlet {@Overrideprotected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {String username = req.getParameter("username");String password = req.getParameter("password");System.out.println(username + password);serviceDao dao = new serviceDao();boolean t = dao.login(username, password);System.out.println(t);if (t) {//登陆成功将当前用户保存到session中req.getSession().setAttribute("username", username);req.getRequestDispatcher("show.jsp").forward(req,resp);} else {//跳转到失败页面System.out.println("登录失败！");}}@Overrideprotected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {System.out.println("=====调用doPost()方法=====");}
}

代码示例：
//serviceDao.javapackage com.xc.dao;
import com.xc.Util.DBUtils;import java.sql.*;public class serviceDao {public Connection conn = null;public PreparedStatement pt = null;public boolean login(String username, String password) {ResultSet rs = null;boolean t = false;Connection conn = DBUtils.getConnection();//解决sql注入利用PreparedStatement//PreparedStatement允许在sql语句中使用占位符?//PreparedStatement的优点//1.解决sql注入//2.提高程序的可读性和可维护性//3.执行效率高String sql = "select * from user where username=? and password=?";try {pt = conn.prepareStatement(sql);//执行sql语句之前需要给参数赋值System.out.println(username+password);pt.setString(1,username);pt.setString(2,password);//执行sql语句rs = pt.executeQuery();if(rs.next()) {t = true;}} catch (SQLException e) {// TODO Auto-generated catch blocke.printStackTrace();}if(rs!=null) {try {rs.close();} catch (SQLException e) {// TODO Auto-generated catch blocke.printStackTrace();}}if(pt!=null) {try {pt.close();} catch (SQLException e) {// TODO Auto-generated catch blocke.printStackTrace();}}if(conn!=null) {try {conn.close();} catch (SQLException e) {// TODO Auto-generated catch blocke.printStackTrace();}}return t;}}

代码示例：
//LoginTag.java
(标签处理类)package com.xc.tag;import com.xc.entity.User;import javax.servlet.http.HttpSession;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.SimpleTagSupport;
import java.io.IOException;
import java.util.List;public class LoginTag extends SimpleTagSupport {@Overridepublic void doTag() throws JspException, IOException {//判断是否已经登陆成功，如果成功执行标签体，若失败则不执行.PageContext pageContext = (PageContext) getJspContext();HttpSession session = pageContext.getSession();List<User> user = (List<User>) session.getAttribute("user");if (user != null){//执行一次标签体getJspBody().invoke(null);}}
}

代码示例：
//mySimpleTag.tld<?xml version="1.0" encoding="UTF-8" ?>
<taglib 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"version="2.1"><tlib-version>1.2</tlib-version><short-name>mySimpleTag</short-name><uri>https://www.xc.com</uri><tag><name>login</name><!--表示标签的名字 类似于<jsp:forward>中的forward--><tag-class>com.xc.tag.LoginTag</tag-class>  <!--标签所在类 --><body-content>scriptless</body-content></tag>
</taglib>

代码示例：
//show.jsp<%--Created by IntelliJ IDEA.User: asusDate: 2021/11/23Time: 17:40To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib uri ="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="https://www.xc.com" prefix="xc"%>
<%@page isELIgnored="false" %>
<html>
<head><title>Title</title>
</head>
<body><xc:login>${sessionScope.username},恭喜您登陆成功！
</xc:login>
</body>
</html>

测试截图：

记录问题
低版本的jsp不解析el表达式，使用时须小心。

Servlet2.3或者更早的JSP页面默认是不使用EL表达式的，即不解析EL表达式，所以要不就是使用更高版本的jsp servlet。这样比较麻烦，这里Java提供了一各属性来解决这个问题，使2.3或更早版本能使用El表达式，该属性为<%@page isELIgnored=“false” %>默认是true，表示暂时不解析，此时我们在jsp页面头文件中设置为false，再次运行，此时jsp页面就会解析El表达式