JSP自定义标签的入门

什么是自定义标签？

---

自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet，标签转化为对被 称为tag handler的对象的操作，即当servlet执行时Web container调用那些操作。
JSP标签扩展可以让你创建新的标签并且可以直接插入到一个JSP页面。 JSP 2.0规范中引入Simple Tag Handlers来编写这些自定义标记。
你可以继承SimpleTagSupport类并重写的doTag()方法来开发一个最简单的自定义标签。

    在标准的开发流程中，在jsp页面里面是不可以出现一行的Java代码，当有一些Java代码在jstl包里面没有的，而这些java代码必须要写在该页面的时候，自定义标签的作用就体现出来了。

创建第一个属于自己的自定义标签

---

（这个是我整个项目的资源位置）

1.创建一个Java类（以查看IP地址功能的自定义标签为例）

创建一个ViewIPTag.java 的Java类，该类的代码如下：

package top.cheungchingyin.web.tag;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.TagSupport;

public class ViewIPTag extends TagSupport {



    @Override
    public int doStartTag() throws JspException {

        HttpServletRequest request = (HttpServletRequest) this.pageContext.getRequest();//获得request
        JspWriter out = this.pageContext.getOut();
        String ip = request.getRemoteAddr();
        try {
            out.print(ip);//输出IP地址
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return super.doStartTag();
    }

    public ViewIPTag() {
        // TODO Auto-generated constructor stub
    }

}

解释：

    创建好一个Java类后，需要继承TagSupport 类，然后按照需要重写方法。

(TagSupport内部的方法）
各个方法的作用：

       doStartTag()方法是：在遇到标签开始时会呼叫的方法，其合法的返回值是EVAL_BODY_INCLUDE与SKIP_BODY,前者表示将显示标签间的文字，后者表示不显示标签间的文字；
　 doEndTag()方法是：在遇到标签结束时呼叫的方法，其合法的返回值是EVAL_PAGE与 SKIP_PAGE，前者表示处理完标签后继续执行以下的JSP网页，后者是表示不处理接下来的JSP网页
　 doAfterBody()方法是：在显示完标签间文字之后呼叫的，其返回值有EVAL_BODY_AGAIN与SKIP_BODY，前者会再显示一次标签间的文字，后者则继续执行标签处理的下一步。
　　EVAL_BODY_INCLUDE：把Body读入存在的输出流中，doStartTag()函数可用
　　EVAL_PAGE：继续处理页面，doEndTag()函数可用
　　SKIP_BODY：忽略对Body的处理，doStartTag()和doAfterBody()函数可用
　　SKIP_PAGE：忽略对余下页面的处理，doEndTag()函数可用
　　EVAL_BODY_TAG：已经废止，由EVAL_BODY_BUFFERED取代
　　EVAL_BODY_BUFFERED：申请缓冲区，由setBodyContent()函数得到的BodyContent对象来处理tag的body，如果类实现了BodyTag，那么doStartTag()可用，否则非法。
　　EVAL_BODY_BUFFERED 要将BodyContent的内容输出

由于我们需要在标签开始之前就要显示IP地地址，所以我们在viewIPTag 只要重写 doStartTag() 方法就行了。

2.创建一个声明标签的tld文件

我们需要在项目的 WebRoot/WEB-INF/lib 文件夹下创建一个.tld的文件。tld配置文件的源码可以在$TomCat_HOME/webapps/examples/WEB-INF/jsp2/jsp2-example-taglib.tld 中可以找到模板，以下为模板代码

<?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/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
    version="2.0">
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>Tag</short-name>
    <uri>http://cheungchingyin.top</uri>
    <tag>
        <name></name>
        <tag-class></tag-class>
        <body-content></body-content>
    </tag>
</taglib>

以下为我的Tag.tld代码：

<?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/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
    version="2.0">
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>Tag</short-name>
    <uri>http://cheungchingyin.top</uri>
    <tag>
        <name>viewIP</name>
        <tag-class>top.cheungchingyin.web.tag.ViewIPTag</tag-class>
        <body-content>empty</body-content>
    </tag>
</taglib>

解释：

<uri></uri>标签：用于在jsp页面需要使用到自定义标签时的定位标识，这里一般会填写自己公司的网站地址，填其他地址也可以。
<tag></tag>标签：这是一个声明自定义标签的标签。
<name></name>标签：自定义标签的名字。
<tag-class></tag-class>标签：自定义标签所相对应需要执行（映射）的类
<body-content></body-content>标签：自定义标签需不需要标签体，不需要就填empty。

3.自定义标签中在jsp页面中的应用

首先新建一个jsp页面（我的页面为1.jsp），然后在jsp页面的开头声明需要调用那个taglib,由于我在Tag.tld的uri写了http://cheungchingyin.top，所以这uri就填了这个地址

<%@ taglib uri="http://cheungchingyin.top" prefix="Tags"  %>

最后直接使用标签即可

您的ip是：<Tags:viewIP/> 

以下为我的1.jsp代码

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ taglib uri="http://cheungchingyin.top" prefix="Tags"  %>
<%
    String path = request.getContextPath();
    String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
            + path + "/";
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="<%=basePath%>">

<title>My JSP '1.jsp' starting page</title>

</head>

<body>
    您的ip是：
    <Tags:viewIP/> 
</body>
</html>

解释:

taglib属性是用于提醒tomcat需要调用自定义标签库。
prefix="Tags"用于声明自定义标签库的对象，Tag可以为任何值。

结果

---

(由于获取的ip是IPV6的地址，所以结果是这样的)