给webwork或者struts2添加freemarker宏（taglibrary）

http://huaco.3322.org/blog/?p=19

 

给webwork或者struts2添加freemarker宏（taglibrary）

大家是否发现做webwork开发，使用freemarker模板的时候，freemarker的宏很好用呢，类似这样<@ww.text name=”${message}”/>的代码在freemarker文件中随处可见，这样的宏都是由webwork带来的，那我们自己做的一些公用的宏如何添加到我们的类库上，方便自己的使用呢。经过对freemarker宏的了解和webwork给action提供的model，我们发现这个做起来非常简单。

首先是个宏的集合，在webwork中是WebWorkModels，FreemarkerResult把这个类放到了freemarker的数据模型中，代码在FreemarkerManager中如下

model.put(”ww”, new WebWorkModels(stack, request, response));

然后我们把一些自己写的宏根据webwork的写法做好，比如我们要建立一个message的宏，代码如下

package ××××××;

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

import com.opensymphony.webwork.components.Component;
import com.opensymphony.webwork.views.freemarker.tags.TagModel;
import com.opensymphony.xwork.util.OgnlValueStack;

public class MessageModel extends TagModel {

public MessageModel(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res) {
super(stack, req, res);
}

@Override
protected Component getBean() {
return new Message(stack,req,res);
}

}

在同一个包下，写一个message的类 代码如下
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.infowarelab.pso.common.web.models.AbstractPsoUiBean;
import com.opensymphony.xwork.util.OgnlValueStack;

public class Message extends AbstractPsoUiBean {

public Message(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response) {
super(stack, request, response);
}

@Override
protected String getDefaultTemplate() {
return “message”;
}

}

创建我们自己的宏集合类
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.opensymphony.xwork.util.OgnlValueStack;

public class PsoModels {
private OgnlValueStack stack;
private HttpServletRequest request;
private HttpServletResponse response;
private MessageModel message;

public PsoModels(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response) {
this.stack = stack;
this.request = request;
this.response = response;
}

public MessageModel getMessage() {
if (message == null) {
message = new MessageModel(stack, request, response);
}
return message;
}
}

再创建这个宏所用到的模板文件，在classpath下的template.xhtml目录下，名称见getDefaultTemplate方法返回值代码如下

you message and any freemarker syntax

最后要在一个base的action中把这个models放到数据模型中，一般会在prepare方法中实现

public void prepare() throws Exception {
HttpServletRequest req = ServletActionContext.getRequest();
OgnlValueStack stack = ServletActionContext.getValueStack(req);
HttpServletResponse res = ServletActionContext.getResponse();
stack.getContext().put(”pso”,
new PsoModels(stack, req, res));
}

在struts2中，创建models的方法是一致的，加载也可以这样做，但是有更好的方法，得益于struts2的修改过的plugin模型，只要做一个struts-plugin.xml以及一个实现TagLibrary接口的类

实现如下

public class PsoTagLibrary implements TagLibrary {

public Object getFreemarkerModels(ValueStack stack, HttpServletRequest req,
HttpServletResponse res) {
return new PsoModels(stack,req,res);
}

public List<Class> getVelocityDirectiveClasses() {
return null; //因为我不用velocity
}

}

在struts-plugin.xml 添加如下代码

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<!DOCTYPE struts PUBLIC
“-//Apache Software Foundation//DTD Struts Configuration 2.0//EN”
“http://struts.apache.org/dtds/struts-2.0.dtd”>

<struts>
<bean type=”org.apache.struts2.views.TagLibrary” name=”pso” class=”package.PsoTagLibrary” />
<package name=”your-default”>
</package>
</struts>
最后你就可以在你的页面上做

<@pso.message/>

这样的写法。