10. jsp custom tag

CHUYÊN ĐỀ JAVA

Nguyễn Hoàng Anh – nhanh@fit.hcmus.edu.vn

JSP CUSTOM TAG

Nội dung trình bày

Tag Library

Custom Tag

– Simple Custom Tag

– Attribute Custom Tag

– Body Custom Tag

– Nested Custom Tag

TAG LIBRARY

Các thành phần liên quan đến Tag Library

Tag Handler Class

– Cách thức Tag xử lý

Tag Library Descriptor File

– Mô tả Tag

JSP Page

– Khai báo và sử dụng Tag

Tag Handler Class

Tag Handler chịu trách nhiệm xử lý trên Tag, chuyển Tag

thành mã nguồn Java

Tag Handler phải cài đặt lại javax.servlet.jsp.tagext.Tag

Thường kế thừa từ TagSupport hoặc BodyTagSupport

Tag Handler để trong Source Packages của ứng dụng

web giống như Servlets, Java Beans

Tag Library Descriptor File

File XML mô tả

– Tag Name

– Các Attribute

– Chỉ định Tag Handler Class

Thư viện được khai báo và sử dụng các Tag trong trang JSP

JSP Page

Import Tag Library

– Tham chiếu đến URL của TLD

Khai báo Tag Prefix

Sử dụng các Tag

SIMPLE CUSTOM TAG

Simple Custom Tag

Đặc điểm

– Không có thuộc tính

– Không có thân

Định dạng

<prefix:TagName/>

Các bước xây dựng và sử dụng

Bước 1: Tạo lớp Tag Handler Class kế thừa

TagSupport trong Source Packages

Bước 2: Tao Tag Library Descriptor (TLD) mô tả

thông tin về Simple Custom Tag

– Có thể mô tả thông tin nhiều Tag

Bước 3: Khai báo và sử dụng Simple Custom Tag

trong JSP

B1:Tạo Tag Handler Class kế thừa TagSupport

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package packageName;

import java.io.IOException;

import java.util.logging.Level;

import java.util.logging.Logger;

import javax.servlet.jsp.JspWriter;

import javax.servlet.jsp.tagext.TagSupport;

public class TenTag extends TagSupport {

@Override

public int doStartTag() {

return SKIP_BODY;

@Override

public int doEndTag() {

return EVAL_PAGE;

Bước 1: Tạo lớp Tag Handler Class

Trong Tag Handler Class

– Cài đặt lại doStartTag()

• Xử lý khi bắt đầu mở Tag

• Return SKIP_BODY

– Cài đặt lại doEndTag()

• Xử lý sau khi kết thúc thân Tag

• Return EVAL_PAGE

Trong doStartTag và doEndTag có thể sử dụng

– thuộc tính pageContext kế thừa được từ TagSupport

Một số phương thức hay dùng với pageContext

Đối tượng Phương thức

out JspWriter getOut()

session HttpSession getSession()

request ServletRequest getRequest()

response ServletResponse getResponse()

exception Exception getException()

errorData ErrorData getErrorData()

page Object getPage()

config ServletConfig getServletConfig()

context ServletContext getServletContext()

Include và Forward với pageContext

Thao tác Phương thức

Include void include(String relativeURLPath)

Forward void forward(String relativeURLPath)

B2: Tạo Tag Library Descriptor (TLD)

File XML mô tả

– Tag Name

– Các Attribute

– Chỉ định Tag Handler Class

Tạo TLD trong Web Pages

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18

<?xml version="1.0" encoding="UTF-8"?> <taglib version="2.1"

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"> <tlib-version>1.0</tlib-version> <short-name>Short Name</short-name> <uri>URI</uri> <tag> <name>Tag Name</name> <tag-class>Tag Handler Class</tag-class> <body-content>empty</body-content> </tag> </taglib>

<body-content>empty</body-Content> : Không có

B3: Khai báo và sử dụng trong JSP

Khai báo

<%@taglib

prefix="prefixName"

uri="uri" %>

Sử dụng

<prefixName:TagName/>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19

public class HelloTag extends TagSupport {

@Override

JspWriter out = this.pageContext.getOut();

out.println("<b>Xin chào Nguyễn Hoàng Anh</b>");

out.println("<b>This is a Simple Custom Tag</b>");

} catch (IOException ex) {

Logger.getLogger(HelloTag.class.getName())

.log(Level.SEVERE, null, ex);

return SKIP_BODY;

@Override

return EVAL_PAGE;

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18

<?xml version="1.0" encoding="UTF-8"?> <taglib version="2.1"

xmlns="http://java.sun.com/xml/ns/javaee"

http://java.sun.com/xml/ns/javaee/web-

jsptaglibrary_2_1.xsd"> <tlib-version>1.0</tlib-version> <short-name>customtaglibrary</short-name> <uri>/WEB-INF/tlds/CustomTagLibrary</uri> <tag> <name>HelloTag</name> <tag-class>customs.HelloTag</tag-class> <body-content>empty</body-content> </tag> </taglib>

Khai báo

<%@taglib

prefix="nhanh"

uri="/WEB-INF/tlds/CustomTagLibrary" %>

Sử dụng

<nhanh:HelloTag/>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18

<%@page contentType="text/html" pageEncoding="UTF-8"%>

<%@taglib prefix="nhanh“

uri="/WEB-INF/tlds/CustomTagLibrary.tld" %>

<html>

<head>

content="text/html; charset=UTF-8">

</head>

<body>

<nhanh:HelloTag/>

</body>

</html>

Kết quả

CUSTOM TAG WITH ATTRIBUTES

Custom Tag có thuộc tính

Đặc điểm

– Có một hay nhiều thuộc tính

– Không có thân

Định dạng

<prefix:TagName attribute1=“…”

attrribute2=“…”

attributeN=“…”

thông tin về Simple Custom Tag

Bước 3: Khai báo và sử dụng Custom Tag có thuộc

tính trong JSP

Để tạo được Custom Tag có thuộc tính

<prefix:TagName attribute1=“…” attribute2=“…”

… attributeN=“…”/>

– Thêm thuộc tính attribute1, attribute2,…,atrributeN

– Thêm các phương thức:

public void setAttribute1(String value1){…}

public void setAttributeN(String valueN){…}

– Cài đặt lại phương thức doStartTag, doEndTag

• Return SKIP_BODY

Trong doStartTag và doEndTag có thể sử dụng

– thuộc tính pageContext kế thừa được từ TagSupport

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

public class TagName extends TagSupport {

private String attribute1;

private String attributeN;

public TagName(){

this.attribute1=...

this.attribute2=...

this.attributeN=...

public void setAttribute1(String value1){attribute1=value1;}

public void setAttributeN(String valueN){attributeN=valueN;}

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

@Override

//Sử dụng các thuộc tính

return SKIP_BODY;

@Override

return EVAL_PAGE;

@Override

public void release(){

this.attribute1=...

this.attribute2=...

this.attributeN=...

//Release ...

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20 21

<short-name>customtaglibrary</short-name><uri>URI TLD</uri>

<tag-class>Tag Handler Class</tag-class>

<name>attribute1</name>

<required>true/false</required>

<rtexprvalue>true/false</rtexprvalue>

</attribute>

<name>attributeN</name>

</attribute>

<body-content>empty</body-content>

</tag>

</taglib>

<required>true</required> : Thuộc tính bắt buộc sử

dụng trong Tag

<required>false</required> : Thuộc tính tùy chọn sử

dụng trong Tag

<rtexprvalue>true</rtexprvalue> : Thuộc tính có thể

gán giá trị bằng JSP Expression

<rtexprvalue>false</rtexprvalue> : Thuộc tính không

được gán giá trị bằng JSP Expression

<body-content>empty</body-Content> : Không có

Khai báo

<%@taglib prefix="prefixName"

uri="URI TLD" %>

Sử dụng

<prefixName:TagName attribute1=“...”

attribute2=“...”

attributeN=“...”/>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package customs;

public class EmployeeTag extends TagSupport {

private String employeeID;

private String employeeName;

public EmployeeTag() {

this.employeeID = "";

this.employeeName = "";

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

public String getEmployeeID() {

return employeeID;

public void setEmployeeID(String employeeID) {

this.employeeID = employeeID;

public String getEmployeeName() {

return employeeName;

public void setEmployeeName(String employeeName) {

this.employeeName = employeeName;

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

@Override

out.println("<p>" + this.employeeID + " - "

+ this.employeeName + "</p>");

Logger.getLogger(EmployeeTag.class.getName()).

log(Level.SEVERE, null, ex);

return SKIP_BODY;

@Override

public void release() {

this.employeeID = null;

this.employeeName = null;

<?xml version="1.0" encoding="UTF-8"?>

<taglib version="2.1" xmlns="http://java.sun.com/xml/ns/javaee"

http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd">

<tlib-version>1.0</tlib-version>

<short-name>customtaglibrary</short-name>

<uri>/WEB-INF/tlds/CustomTagLibrary</uri>

</tag>

</taglib>

<name>EmployeeTag</name>

<tag-class>customs.EmployeeTag</tag-class>

<name>employeeID</name>

</attribute>

<name>employeeName</name>

</attribute>

<body-content>empty</body-content>

</tag>

</taglib>

<%@taglib prefix="nhanh"

<html>

<head>

</head>

<body>

</body>

</html>

String []names={"Nguyễn Văn Tùng", "Trần Thu Thảo",

"Nguyễn Tiến Sơn", "Lê Đình Ngọc",

"Võ Đông Sơn", "Lê Thành Nhân",

"Nguyễn Hòa Bình", "Nguyễn Ngọc Trung",

"Lê Văn Hoàng"};

for(int i=0; i<names.length; i=""++){

<nhanh:EmployeeTag

employeeID="<%=String.valueOf(i+1)%>"

employeeName="<%=names[i]%>"/>

<nhanh:EmployeeTag employeeID="10"

employeeName="Nguyễn Thành Long"/>

<nhanh:EmployeeTag employeeID="11"

employeeName="Nguyễn Thành Trung"/>

BODY CUSTOM TAG

Body Custom Tag

Đặc điểm

– Có thuộc tính

– Có thân

Định dạng

<prefix:TagName >

JSP Content

</prefix>

<prefix:TagName attribute1=“…” … attributeN=“…”>

JSP Content

</prefix>

thông tin về Body Custom Tag

Bước 3: Khai báo và sử dụng Body Custom Tag trong

Để tạo được Custom Tag có thuộc tính

<prefix:TagName attribute1=“…” attribute2=“…”

attributeN=“…”>

JSP Content

</prefix:TagName>

– Thêm thuộc tính attribute1, attribute2,…,atrributeN

– Thêm các phương thức:

public void setAttribute2(String value2){…}, ...

public void setAttributeN(String valueN){…}

• Thường return EVAL_BODY_INCLUDE thay cho

SKIP_BODY

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

private String attributeN;

public TagName(){

this.attribute1=...

this.attribute2=...

this.attributeN=...

public void setAttributeN(String valueN){attributeN=valueN;}

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

@Override

//Sử dụng các thuộc tính

return EVAL_BODY_INCLUDE;

@Override

return EVAL_PAGE;

@Override

public void release(){

this.attribute1=...

this.attribute2=...

this.attributeN=...

//Release ...

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20 21

<short-name>customtaglibrary</short-name><uri>URI TLD</uri>

<tag-class>Tag Handler Class</tag-class>

<name>attribute1</name>

</attribute>

<name>attributeN</name>

</attribute>

<body-content>JSP</body-content>

</tag>

</taglib>

<required>true</required> : Thuộc tính bắt buộc sử

dụng trong Tag

<required>false</required> : Thuộc tính tùy chọn sử

dụng trong Tag

<rtexprvalue>true</rtexprvalue> : Thuộc tính có thể

gán giá trị bằng JSP Expression

<rtexprvalue>false</rtexprvalue> : Thuộc tính không

được gán giá trị bằng JSP Expression

<body-content>JSP</body-Content> : Nội dung thân

của thể là JSP

Khai báo

<%@taglib prefix="prefixName"

uri="URI TLD" %>

Sử dụng

<prefix:TagName attribute1=“…” … attributeN=“…”>

JSP Content

</prefix>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package customs;

* @author NHAnh

public class CopyrightTag extends TagSupport {

private String bgColor;

public void setBgColor(String bgColor) {

this.bgColor = bgColor;

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

@Override

out.println("<table width='600' border='1'");

out.println("align='center' bgcolor='" +

this.bgColor + "' >");

out.println("<tr>");

out.println("<td>");

out.println("<center>");

Logger.getLogger(CopyrightTag.class.getName()).

log(Level.SEVERE, null, ex);

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

@Override

out.println("</center>");

out.println("</td>");

out.println("</tr>");

out.println("</table>");

Logger.getLogger(CopyrightTag.class.getName())

.log(Level.SEVERE, null, ex);

return EVAL_PAGE;

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<?xml version="1.0" encoding="UTF-8"?>

<tlib-version>1.0</tlib-version>

<short-name>customtaglibrary</short-name>

<uri>/WEB-INF/tlds/CustomTagLibrary</uri>

<name>CopyrightTag</name>

<tag-class>customs.CopyrightTag</tag-class>

<name>bgColor</name>

</attribute>

</tag>

</taglib>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<%@taglib prefix="nhanh"

<html>

<head>

</head>

<body>

<nhanh:CopyrightTag bgColor="#0000FF">

</nhanh:CopyrightTag>

</body>

</html>

NESTED CUSTOM TAG

Bước 1: Tạo lớp Parent Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

public class ParentTag extends TagSupport{

private boolean condition;

public boolean getCondition() {

return condition;

public void setCondition(boolean condition) {

this.condition = condition;

@Override

public int doStartTag(){

@Override

public int doEndTag(){

return EVAL_PAGE;

Bước 1: Tạo lớp Child Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

public class ChildTag extends TagSupport {

@Override

ParentTag pt = (ParentTag) this.getParent();

if (pt.getCondition() == true) {

} else {

return SKIP_BODY;

@Override

return EVAL_PAGE;

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<name>ParentTag</name>

<tag-class>customs.ParentTag</tag-class>

<name>condition</name>

</attribute>

</tag>

<name>ChildTag</name>

<tag-class>customs.ChildTag</tag-class>

</tag>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<body>

<nhanh:ParentTag condition="true">

<nhanh:ChildTag>

Hi Nguyễn Hoàng Anh

</nhanh:ChildTag>

</nhanh:ParentTag>

<nhanh:ParentTag condition="false">

<nhanh:ChildTag>

Không xuất hiện

</nhanh:ChildTag>

</nhanh:ParentTag>

</body>

SIMPLE IF CUSTOM TAG

Bước 1: Tạo lớp If Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package customs;

import javax.servlet.jsp.JspException;

import javax.servlet.jsp.tagext.SimpleTagSupport;

public class IfTag extends SimpleTagSupport {

private boolean condition;

public boolean getCondition() {

return condition;

public void setCondition(boolean condition) {

this.condition = condition;

@Override

public void doTag() throws JspException, IOException{

this.getJspBody().invoke(null);

Bước 1: Tạo lớp Then Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package customs;

public class ThenTag extends SimpleTagSupport {

@Override

public void doTag() throws JspException, IOException {

IfTag it=(IfTag)this.getParent();

if(it.getCondition()==true){

Bước 1: Tạo lớp Else Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18

package customs;

public class ElseTag extends SimpleTagSupport {

@Override

public void doTag() throws JspException, IOException {

IfTag it = (IfTag) this.getParent();

if (it.getCondition() == false) {

Bước 2: Tạo Tag Library Descriptor (TLD)

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<tag-class>customs.IfTag</tag-class>

<name>condition</name>

</attribute>

<body-content>scriptless</body-content>

</tag>

<tag-class>customs.ThenTag</tag-class>

</tag>

<tag-class>customs.ElseTag</tag-class>

</tag>

Bước 3: Khai báo và sử dụng trong JSP

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<body>

<nhanh:if condition="true">

<nhanh:then>

True, Hi Nguyễn Hoàng Anh

</nhanh:then>

<nhanh:else>

False, Hi Ngô Bá Nam Phương

</nhanh:else>

</nhanh:if>

<nhanh:if condition="false">

<nhanh:then>

True, Hi Nguyễn Hoàng Anh

</nhanh:then>

<nhanh:else>

False, Hi Ngô Bá Nam Phương

</nhanh:else>

</nhanh:if>

</body>

SIMPLE FOR CUSTOM TAG

Bước 1: Tạo lớp For Tag Handler Class

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

package customs;

public class ForTag extends SimpleTagSupport{

private int size;

public void setSize(int size) {

this.size = size;

@Override

public void doTag() throws JspException, IOException{

for(int i=0; i<this.size; i++){

Bước 2: Tạo Tag Library Descriptor (TLD)

1 2 3 4 5 6 7 8 9

<tag-class>customs.ForTag</tag-class>

</attribute>

</tag>

1 2 3 4 5 6 7 8 9

10 11 12 13 14 15 16 17 18 19 20

<body>

<nhanh:for size="10">

<nhanh:if condition="true">

<nhanh:then>

Hi Nguyễn Hoàng Anh

</nhanh:then>

<nhanh:else>

Hi Ngô Bá Nam Phương

</nhanh:else>

</nhanh:if>

</nhanh:for>

</body>

TÀI LIỆU THAM KHẢO

Tham khảo

Marty Hall, Larry Brown, Core Servlets and

JavaServer Pages™: Volume 1: Core Technologies,

2nd Edition (2003)

http://courses.coreservlets.com/Course-

Materials/csajsp2.html (2010)

HỎI VÀ ĐÁP

10. jsp custom tag

Documents

creating custom jsp tag libraries: advanced...

the jsp standard tag library (jstl)

framework = framework+framework · 프로자바() sca()...

implementing jsp tag extensions

by suryanarayanajstl jsp standard tag library core, sql,...

creating custom jsp tag libraries: the...

jsp tag lib by kamalakar dandu

jstl ( jsp standard tag library )

developing jsp tag extensions for oracle weblogic server ·...

creating custom jsp tag libraries

creating custom jsp tagcreating custom jsp tag libraries...

2017 - online.cs.miu.edu · servlets java server pages jsp...

jsp standard tag library (jstl)

creating custom jsp tag libraries: the...

jsp : creating custom tag

jsp custom tag libraries

beaweblogic server and weblogic expressprogramming weblogic...

jsp 1.2 custom tags

jsp tag library

creating custom jsp tag libraries - core...