Natlive's blog

A long way and dream.

 

Struts2 自定义标签的方法

又回锅弄Struts2……

看完uitag这部份,发现一个问题,就是如果我要一个pagebar这样的UITag怎么办?总不能每一页我都在JSP上写吧?就算是复制都很不聪明。于是开始研究怎么去写一个Tag,在网站找了N多文章,大都是用out.println(...)这样的方式,而没有使用template的方式,自己总觉得这样的方式不灵活而且麻烦,容易出错,于是查看struts2的源码,终于找出怎么去写Struts2 Tag的方法。

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>

我们先写UIBean部份:我们把它定义为MM,它继承于org.apache.struts2.components.UIBean:
package limitstudy.corestruts2.tag;

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;

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

@StrutsTag(name
="mm", tldTagClass="limitstudy.corestruts2.tag.MMTag", description="MM")
public class MM extends UIBean {
    
private String message;

    
public MM(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 (null != message) {
            addParameter(
"message", findString(message));
        }
    }
}

* 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。

然后是Tag部份:
package limitstudy.corestruts2.tag;

import org.apache.struts2.views.jsp.ui.AbstractUITag;
import org.apache.struts2.components.Component;
import com.opensymphony.xwork2.util.ValueStack;

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

public class MMTag extends AbstractUITag {
    
private String message;

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

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

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

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

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

在/WEB-INF/tlds/下建立current.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" version="2.0"
        xsi:schemaLocation
="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd">
    
<description>test</description>
    
<tlib-version>2.0</tlib-version>
    
<short-name>cur</short-name>
    
<uri>/cur</uri>

    
<tag>
        
<name>mm</name>
        
<tag-class>limitstudy.corestruts2.tag.MMTag</tag-class>
        
<body-content>JSP</body-content>
        
<attribute>
            
<name>message</name>
            
<required>true</required>
        
</attribute>
    
</tag>
</taglib>

在源代码目录中建立template/simple目录(这个目录名和你的theme有关),然后在里面建一个mm.ftl文件:
<href="http://www.yinsha.com">${parameters.message?html}</a>

建一个action测试一下,视图文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<%@ taglib prefix="cur" uri="/cur" %>
<html>
<head>
    
<title><s:property value="message" /></title>
</head>
<body>
<cur:mm message="haoahahhahaha" />
</body>
</html>

完。

PS:写得有些粗鄙,所以,如有问题的,可以留言。

posted on 2009-05-21 11:00 狂龙 阅读(5367) 评论(4)  编辑  收藏 所属分类: Struts2

评论

# re: Struts2 自定义标签的方法 2009-05-26 15:16 I'm 路过

不错,受益匪浅,谢谢啦  回复  更多评论   

# re: Struts2 自定义标签的方法 2009-06-12 22:44 lingtianlan

学习了,谢谢!  回复  更多评论   

# re: Struts2 自定义标签的方法 2009-12-13 18:47 学习

<a href="http://www.yinsha.com">${parameters.message?html}</a> 请问下 这里面的?html是做什么的  回复  更多评论   

# re: Struts2 自定义标签的方法 2012-11-15 12:04 alexliu

"看完uitag这部份,发现一个问题,就是如果我要一个pagebar这样的UITag怎么办?总不能每一页我都在JSP上写吧?就算是复制都很不聪明。于是开始研究怎么去写一个Tag,在网站找了N多文章,大都是用out.println(...)这样的方式,而没有使用template的方式,自己总觉得这样的方式不灵活而且麻烦,容易出错,于是查看struts2的源码,终于找出怎么去写Struts2 Tag的方法......"

我的经历和你一模一样啊,就感觉out.println(...)太麻烦,结果追踪到FreeMarker模板,然后就找到你这篇文章!真的太感谢了!  回复  更多评论   


只有注册用户登录后才能发表评论。


网站导航:
 

导航

统计

常用链接

留言簿(2)

随笔分类

随笔档案

搜索

最新评论

阅读排行榜

评论排行榜