1. Vad är ett märkesbibliotek?

Märkesbibliotek kapslar in funktionalitet som kan anropas från en JSP-sida. Märkesbibliotek anropar alla metoder via XML-märken. Att anropa metoder via XML-märken anses göra koden mer lättläst. XML är också lättare för t. ex. en gränssnittsdesigner att använda, eftersom denne känner igen syntaxen från HTML.

2. Ett första bibliotek

För att skapa och använda ett märkesbibliotek måste man göra mist 3 saker:

1. Skapa ett bibliotek, t.ex. WEB-INF/ollesTaglib.tld.
2. Skapa en klass som som utför själva arbetet, en så kallad märkeshanterare och kompilera den, t.ex. WEB-INF/nu/programmera/ollesTaglib/Now.java. En märkeshanterare kan bara hantera ett märke. Ett märkesbibliotek innehåller vanligtvis många märken, så många märkeshanterare måste därför skapas.
3. Skapar en JSP-sida som använder märket, t.ex. /jsp/testtaglib.jsp.

3. Märkesbiblioteket

Filen innehållande märkesbiblioteket slutar på .tld och placeras någonstans under WEB-INF. Filen fungerar som en tabell över de märken som biblioteket innehåller. Nedan skapar vi ett märkesbibliotek som har två märken:

• Det första märket now returnerar dagens datum. Märket tar inga argument och har ingen kropp.
• Det andra märket square tar argumentet number och returnerar kvadraten på talet. Märket har ingen kropp.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE taglib
    PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
    "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>1.2</jsp-version>
  <short-name>ollesTaglib</short-name>
  <description>A test.</description>
  <tag>
    <name>now</name>
    <tag-class>nu.programmera.ollesTaglib.Now</tag-class>
    <body-content>empty</body-content>
  </tag>
  <tag>
    <name>square</name>
    <tag-class>nu.programmera.ollesTaglib.Square</tag-class>
    <body-content>empty</body-content>
    <attribute>
	    <name>number</name>
	    <required>true</required>
    </attribute>
  </tag>
</taglib>  

4. Märkeshanterarna

För varje märke i ett märkesbibliotek finns det en märkeshanterare som utför själva arbetet. I vårt märkesbibliotek ollesTaglib.tld definierades två märken; now och square. Märket now har elementet tag-class satt till nu.programmera.ollesTaglib.Now. Detta betyder att om märket now ska kunna användas måste det finnas en klass Now.class med sökvägen CATALINA_HOME/webapps/examples/WEB-INF/classes/nu/programmera/ollesTaglib/Now.class.

• Anledningen till den relativt långa sökvägen är att det är standard att alla klasser ska ligga i ett paket som börjar med ditt företags domännamn baklänges. Domänen programmera.nu (programmera.nets gamla namn) blir alltså katalogerna nu/programmera/.

package nu.programmera.ollesTaglib;

import java.util.Date;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class Now extends TagSupport{
  public int doStartTag() throws JspException{
    try{
      JspWriter out=pageContext.getOut();
      Date d= new Date(); 
      out.print(d);
    }catch(Exception e){
      System.err.println("Exception in Date");
      System.err.println(e.toString());
      throw new JspException(e.toString());
    }
    return SKIP_BODY;
  }

  public int doEndTag() throws JspException{
    return EVAL_PAGE;
  }
}

package nu.programmera.ollesTaglib;

import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class Square extends TagSupport{
  private int number;
  public void setNumber(int i){
    number=i;
  }  
  public int doStartTag() throws JspException{
    try{
      JspWriter out=pageContext.getOut();
      int i= (int) Math.pow(number,2);
      out.print(i);
    }catch(Exception e){
      System.err.println("Exception in SquareTag");
      System.err.println(e.toString());
      throw new JspException(e.toString());
    }
    return SKIP_BODY;
  }

  public int doEndTag() throws JspException{
    return EVAL_PAGE;
  }
}

<myLib:myTag arg1="hej"> // doStartTag() anropas
Här är märkets kropp.. 
bla bla bla          // doAfterBody() aropas
</myLib:myTag> // doEndTag() anropas
// release() anropas

5. Använda ett märkesbibliotek i JSP

För att testa om märkesbiblioteket fungerar skapar vi en JSP-sida med följande innehåll:

<HTML> <HEAD> <%@ taglib uri="/WEB-INF/ollesTaglib.tld" prefix="ot" %> </HEAD> <BODY> <H1>Test av Olles Taglib</H1> NU: <ot:now /></BR> 21 upphöjt till två: <ot:square number="21" /> </BODY> </HTML>

Vi sparar filen så den får följande sökväg: CATALINA_HOME/webapps/examples/jsp/testtaglib.jsp. Vi öppnar en browser och ser följande:

6. Alternativt sätt att använda märkesbibliotek i JSP

Om man tycker att det är fult att skriva en absolut sökväg till märkesbiblioteket direkt i JSP-sidan kan man lägga den absoluta sökvägen i web.xml:

<taglib> <taglib-uri>ollesTaglib</taglib-uri> <taglib-location>/WEB-INF/ollesTaglib.tld</taglib-location> </taglib>

Vi ändrar i JSP-sidan till:

<HTML> <HEAD> <%@ taglib uri="ollesTaglib" prefix="ot" %> </HEAD> <BODY> <H1>Nytt test av Olles Taglib</H1> NU: <ot:now /></BR> 21 upphöjt till två: <ot:square number="21" /> </BODY> </HTML>

Vi sparar med namnet testtaglib2.jsp. Innan du öppnar din browser och testar måste webb-behållaren (alltså Tomcat) startas om, ty det är endast vid uppstart som web.xml tolkas.