jsp定义一个标签的步骤（基础）

最新推荐文章于 2023-06-26 21:47:28 发布

Bugxiu_fu

最新推荐文章于 2023-06-26 21:47:28 发布

阅读量469

点赞数

文章标签： servlet java 前端

本文链接：https://blog.csdn.net/Bugxiu_fu/article/details/125642960

版权

1. 什么是标签

标记语言，是一种注释文本的语言，以便于计算机可以操作。很多与“ML”结尾的语言都是标记语言，比如：HTML，XML，XHTML，VML等等。
标记语言与其他语言一样，也需要运行它们的环境，比如HTML的运行环境时浏览器，XML也要自己的解析和运行的环境。

基本结构：
<开始标签>标签体</结束标签>

空标签：
<开始标签属性名="属性值"/></结束标签>
<br/><br/>
<开始标签属性名="属性值"/>

2. JSP自定义标签库

2.1 JSP标签库是什么

是一个JSP标签集合，它封装了JSP应用的通用核心功能，基于JSP标签我们可以理解为，是JSP应该通用功能的一种封装方式。

2.2 处理流程

自定义jsp标签生命周期图如下

2.3 如何自定义标签

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

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

2.4 标签类型

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

if标签助手类代码如下

package com.zhw.tag;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
* if标签：
* 分析
	* 如果满足条件，就打印标签体--->doStartTag的返回值：EVAL_BODY_INCLUDE
	* 如果不满足条件，就不输出标签体--->doStartTag的返回值：SKIP_BODY
* 需要获取到是否满足条件的结果值，那么该标签就有一个属性，属性值是boolean
*/
public class IfTag extends BodyTagSupport{
	private boolean test;
	
	public boolean isTest() {
		return test;
	}
 
	public void setTest(boolean test) {
		this.test = test;
	}
 
 
	@Override
	public int doStartTag() throws JspException {
//		如果不满足条件，就不输出标签体->dostarttag的返回值skip_body
//		需要获取到是否满足条件的结果集，那么该标签就有一个属性，属性值是boolean
		return test?EVAL_BODY_INCLUDE:SKIP_BODY;
	}
 
}

创建out标签步骤

1）创建助手类

package com.zking.mvc.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 * 自定义标签out
 * 助手类
 * @author Administrator
 *
 */
public class OutTag extends BodyTagSupport{

	private String val;
	private String defaultVal;
	
	public void setVal(String val) {
		this.val = val;
	}
	public void setDefaultVal(String defaultVal) {
		this.defaultVal = defaultVal;
	}
	
	@Override
	public int doStartTag() throws JspException{
		//pageContext为页面上下文对象，用于和jsp共享数据
		JspWriter out = this.pageContext.getOut();
		
		try {
		if(this.val==null || "".equals(this.val)){//判空
		//利用JspWrite对象将val输出到页面
			out.println(this.defaultVal);
		}else {
		//利用JspWrite对象将val输出到页面
			out.println(this.val);
		}
		}catch (Exception e) {
			throw new JspException("out标签异常", e);
		}
		
		return SKIP_BODY;//处理标签体，返回该标签
	} 
}

out标签对应的tld文件格式如下

2）编写tld文件，（必须放在WEB-INF目录或其目录下）

如何自定义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>/zking</uri>

<tag>
<name>out</name>
<tag-class>com.zking.mvc.tag.OutTag</tag-class>
<body-content>empty</body-content><!-- 标签体： 存在jsp	不存在empty -->
<attribute>
<name>val</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<description>out标签val属性</description>
</attribute>
<attribute>
<name>defaultVal</name>
<required>false</required><!-- 默认是否有属性 -->
<rtexprvalue>false</rtexprvalue><!-- EL表达式是否作用 -->
<description>out标签的defaultVal属性</description><!-- 描述 -->
</attribute>
</tag>


</taglib>

测试页面

如果自定义的标签，没有成功是不会出现以上运行结果的。一般会出现空的页面或者报错。

结果如下

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<%@taglib prefix="k" uri="/zking" %>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>

<k:out val="sb" defaultVal="kk"/>
</body>
</html>

创建forEach标签

结果如下

【jsp】运行页面

<%@page import="java.util.Arrays"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
   <%@taglib prefix="k" uri="/zking" %>
<!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>
<%
pageContext.setAttribute("la", new String[]{
	"jack","mary","rose","peter"
});

pageContext.setAttribute("lb", new Object[]{
		"jack","mary","rose","peter"
	});
pageContext.setAttribute("lc", Arrays.asList(new String[]{
		"jack","mary","rose","peter"
	})
	);
%>
<k:forEach items="${la }" var="g">
</k:forEach>

</body>
</html>

forEach标签对应的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>/zking</uri>


<tag>
<name>forEach</name>
<tag-class>com.zking.mvc.tag.ForEachTag</tag-class>
<body-content>jsp</body-content>
<attribute>
<name>items</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<description>forEach标签的items属性</description>
</attribute>

<attribute>
<name>var</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>forEach标签的var属性</description>
</attribute>
</tag>
	
	
	
</taglib>

forEach标签的助手类

package com.zking.mvc.tag;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

public class ForEachTag extends BodyTagSupport{

	//items集合、数组
	private Object items;
	private String var;
	
	private List<Object> list;
	private Iterator<Object> iterator;//doStartTag()方法与 doAfterBody()方法都需要使用这个集合
	private Object obj;
	
	public Object getItems() {
		return items;
	}

	public void setItems(Object items) {
		this.items = items;
	}

	public String getVar() {
		return var;
	}

	public void setVar(String var) {
		this.var = var;
	}
	
	/**
	 * doStartTag的返回值：
	 * SKIP_BODY 跳过标签内容
	 * EVAL_BODY_INCLUDE 执行标签内容
	 */
	@Override
	public int doStartTag() throws JspException{
		if(items==null) {//如果前端给我一个空的值，就不用遍历直接跳过
		return SKIP_BODY;
		}
		//判断这个items一个集合还是数组?
		if(items instanceof Collection){//用instanceof判断为集合
			list=(List<Object>)items;
		}else if(items instanceof Object[]) {//用instanceof判断为数组
			/**
			 *Arrays.asList();数组--》集合 放入上面的List<Object>集合里
			 */
			list=Arrays.asList((Object[])items);
		}else {//即不是集合也不是数组
		return SKIP_BODY;
		}
		
		//遍历（当前已是集合，可以直接遍历）
		iterator = list.iterator();
		obj = iterator.next();//获取标签内容
		pageContext.setAttribute(var, obj);//设置到页面
		System.out.println(list);
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		if(!iterator.hasNext()) {
			/**hasNext()迭代器的下一个是否有内容
			 * 当前迭代器没有内容，直接跳过。
			*/
			return SKIP_BODY;
		}else {//迭代器有内容，然后继续进行遍历
		obj=iterator.next();//获取标签内容
		pageContext.setAttribute(var, obj);
		/**
		 * <k:forEach items="${la }" var="g">
		 * var表示保存的g
		 * 
		 * EVAL_BODY_AGAIN	表示会重复执行标签体中间的内容
		 */
		return EVAL_BODY_AGAIN;
		}
	}

	@Override
	public String toString() {
		return "ForEachTag [items=" + items + ", var=" + var + ", list=" + list + "]";
	}
	
}