Struts2自定义标签（template）——示例

来源：http://www.blogjava.net/natlive/archive/2009/05/21/271890.html

Struts2 的UITag原理：
Struts2 UITag分三部份组成，一部份用于定义Tag的内容与逻辑的UIBean，一部份用于定义JSP Tag，也就是平时我们定义的那种，最后就是Template，它存放在你的theme目录之下，是一个FreeMarker模板文件。

我现在辑写一份MMTag，它主要是用于输出带链接的文字，比如像这样：
<cur:mm message="'I am a boy.'" />
就会输出：
<a href="http://www.blogjava.net/natlive">I am boy.</a>

文件配置：

tangs.tld

<?xml version="1.0" encoding="UTF-8"?>
<!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>2.2.3</tlib-version>
    <jsp-version>1.2</jsp-version>
    <short-name>tangs</short-name>
    <uri>/tangs</uri>
    <display-name>"Tangs Tags"</display-name>
    <tag>
        <name>button</name>
        <tag-class>com.gq.tag.button.ButtonTag</tag-class>
        <body-content>empty</body-content>
        <attribute>
            <name>items</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
    
    <tag>
        <name>mm</name>
        <tag-class>com.gq.tag.mm.MmTag</tag-class>
        <body-content>JSP</body-content>
        <attribute>
            <name>message</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>

</taglib>

MmTag.java

* getBean（）返回该Tag中的UIBean。
* populateParams()初始化参数，一般用来初始化UIBean(Component)。
* setXXXX设置属性，和jsp tag是一样的

/**
*创建日期	:2011-11-16
*创建用户	:GongQiang
*变更情况	:
*文档位置 	$Archive:test_struct2/com.gq.tag.mm/MmTag.java$
*最后变更	$Author:  $
*变更日期	$Date: $
*当前版本 	$Revision: $
*
*Copyright (c) 2004 Sino-Japanese Engineering Corp, Inc. All Rights Reserved.
*/
package com.gq.tag.mm;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.components.Component;
import org.apache.struts2.views.jsp.ui.AbstractUITag;

import com.opensymphony.xwork2.util.ValueStack;

public class MmTag extends AbstractUITag {
	private static final long serialVersionUID = 1L;
	
	private String message;

    @Override
    public Component getBean(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
        return new MmBean(stack, request, response);
    }

    @Override
    protected void populateParams() {
        super.populateParams();

        MmBean mm = (MmBean)component;
        mm.setMessage(message);
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

MmBean.java

* strutsTag注解指明了该UIBean的名字和Tag类的类名。
* getDefaultTemplate()方法用于返回模板的名字，Struts2会自动在后面加入.ftl扩展名以找到特定的模板文件。
* setXXX，设置UIBean的属性，一般Tag中有几个这样的属性，这里就有几个。@StrutsTagAttribute(description="set message", type="String")注解，说明该属性是字符串（也可以是其它），这一步很重要。
* 覆写evaluateExtraParams（）方法，在UIBean初始化后会调用这个方法来初始化设定参数，如addParameter方法，会在freemarker里的parameters里加入一个key value。这里要注意findString，还有相关的findxxxx方法，它们是已经封装好了的解释ognl语法的工具，具体是怎么样的，大家可以查看一下UIBean的api doc。

/**
*创建日期	:2011-11-16
*创建用户	:GongQiang
*变更情况	:
*文档位置 	$Archive:test_struct2/com.gq.tag.mm/MmBean.java$
*最后变更	$Author:  $
*变更日期	$Date: $
*当前版本 	$Revision: $
*
*Copyright (c) 2004 Sino-Japanese Engineering Corp, Inc. All Rights Reserved.
*/
package com.gq.tag.mm;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.components.UIBean;
import org.apache.struts2.views.annotations.StrutsTag;
import org.apache.struts2.views.annotations.StrutsTagAttribute;

import com.opensymphony.xwork2.util.ValueStack;

@StrutsTag(name="mm", tldTagClass="com.gq.tag.mm.MmTag", description="MM")
public class MmBean extends UIBean {
    private String message;

    public MmBean(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
        super(stack, request, response);
    }

    @Override
    protected String getDefaultTemplate() {
        return "mm";
    }

    @StrutsTagAttribute(description="set message", type="String")
    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    protected void evaluateExtraParams() {
        super.evaluateExtraParams();

        if (  message != null ) {
            addParameter("message", findString(message));
            
            System.out.println( "auto_rule_match--->" + findString(message) );
            System.out.println( "ongl--->" + getStack().findValue( message ) );
        }
    }
}

findString( ) 方法并没有想象中的智能，如下说明：

mmTag.jsp 有如下两个标签：

    页面直接给定属性<br/>
    <tangs:mm message="hahahaha..."/>
    
    <br/>
    <br/>
    运行时获取值<br/>
    <tangs:mm message="name"/>

但是，通过findString( ) 方法，name 并 没能转换成其对应的值（“Foo”），而是 直接输出了。

auto_rule_match--->hahahaha...
ongl--->null
auto_rule_match--->name
ongl--->Foo

findString( ) 会去解析 其值而 非本身的两种格式：${ xxx } 或 %{ xxx }

在源代码目录中建立template/simple目录（这个目录名和你的theme有关），然后在里面建一个mm.ftl文件：

<a href="http://www.yinsha.com">${parameters.message?html}</a>

以上，tangs.tld、MmTag.java、MmBean.java 和 mm.ftl 就完成了<tangs:mm />的定义。

演示：

struts.xml 中添加 action ： MmTag

	<!-- 演示标签 -->
	<package name="tag" extends="struts-default" namespace="/tag">
		<action name="Tag" class="com.gq.action.TagTestAction">
			<result name="success">/tagTest/tags.jsp</result>
			<interceptor-ref name="defaultStack"/>
		</action>
		
		<action name="ButtonTag" class="com.gq.tag.button.ButtonActionTest">
			<result name="success">/tagTest/buttonTag.jsp</result>
			<interceptor-ref name="defaultStack"/>
		</action>
		
		<action name="MmTag" class="com.gq.tag.mm.MmActionTest">
			<result name="success">/tagTest/mmTag.jsp</result>
			<interceptor-ref name="defaultStack"/>
		</action>
	</package>

MmActionTest.java

/**
*创建日期	:2011-11-16
*创建用户	:GongQiang
*变更情况	:
*文档位置 	$Archive:test_struct2/com.gq.tag.mm/MmActionTest.java$
*最后变更	$Author:  $
*变更日期	$Date: $
*当前版本 	$Revision: $
*
*Copyright (c) 2004 Sino-Japanese Engineering Corp, Inc. All Rights Reserved.
*/
package com.gq.tag.mm;

import com.opensymphony.xwork2.ActionSupport;

public class MmActionTest extends ActionSupport {
	private static final long serialVersionUID = 1L;
	
	public String getName(){
		return "Foo";
	}

	@Override
	public String execute() throws Exception {
		return SUCCESS;
	}
}

mmTag.jsp

<%@ page language="java" pageEncoding="UTF-8"%>
<%@taglib prefix="s" uri="/struts-tags" %>
<%@taglib prefix="tangs" uri="/tangs" %>
<%
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 'buttonTag.jsp' starting page</title>

  </head>
  
  <body>
    页面直接给定属性<br/>
    <tangs:mm message="hahahaha..."/>
    
    <br/>
    <br/>
    运行时获取值<br/>
    <tangs:mm message="%{name}"/>
  </body>
</html>

图示页面：