FreeMarker SiteMesh Struts2 整合后如何在JSP页面中使用FreeMarker标签和Struts2标签

最新推荐文章于 2023-09-08 15:50:20 发布

tohmin

最新推荐文章于 2023-09-08 15:50:20 发布

阅读量5.1k

点赞数

分类专栏： Java Frameworks 文章标签： freemarker struts jsp exception decorator filter

本文链接：https://blog.csdn.net/tohmin/article/details/4102893

版权

Java Frameworks 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

关于如何整合FreeMarker SiteMesh Struts2 请参考其他文章，本文是建立在你知道如何去整合FreeMarker SiteMesh Struts2，并且如何在FreeMarker模版中使用Struts2标签，本文的重点在于如何在JSP中使用FreeMarker标签，及其在Jsp中使用Struts2标签问题的解决。

先给出配置文件，关于为什么这么配，本文不再详述.

代码清单 1 ：Web.xml

<filter> <filter-name>struts-cleanup</filter-name> <filter-class>org.apache.struts2.dispatcher.ActionContextCleanUp</filter-class> </filter> <filter> <filter-name>sitemesh-freemarker</filter-name> <filter-class>org.apache.struts2.sitemesh.FreeMarkerPageFilter</filter-class> <init-param> <param-name>default_encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter> <filter-name>struts2</filter-name> <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class> </filter> <filter-mapping> <filter-name>struts-cleanup</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>sitemesh-freemarker</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>struts2</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <servlet-name>JspSupportServlet</servlet-name> <servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet>

本文的重点是如何在JSP中使用FreeMarker标签，有人可能会问：为什么不直接在FreeMarker模版文件中使用JSP标签呢？这是个很好的问题，因为大部分人在使用FreeMarker多半是会用FreeMarker文件格式（.ftl）. 但是，试想想如果我们只是想在现有的系统中集成FreeMarker，如果我们要把所有JSP文件改成FTL文件，那么是需要很多时间的，在这种情况下，最好的办法就是在JSP中直接使用FreeMarker标签（一般情况下，我们很有可能在JSP中使用FreeMarker的宏）。那么如何在JSP中使用FreeMarker呢，很简单，我们必须使用JSP的<%@ taglib ... />命令，把FreeMarker的标签库文件（fmtag.tld）导入，本文把 fmtag.tld 放到WEB-INF目录下，下面是 fmtag.tld 的源码：

代码清单 2 ： fmtag.tld

<?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.1//EN" "http://java.sun.com/j2ee/dtds/web-jsptaglib_1_1.dtd"> <taglib> <tlibversion>2.0</tlibversion> <jspversion>1.1</jspversion> <shortname>FreeMarker JSP Support</shortname> <tag> <name>template</name> <tagclass>freemarker.ext.jsp.FreemarkerTag</tagclass> <bodycontent>tagdependent</bodycontent> <info>Allows evaluation of FreeMarker templates inside JSP</info> <attribute> <name>caching</name> <required>false</required> </attribute> </tag> </taglib>

下一步，我们新建一个JSP文件叫hello.jsp, 代码清单如下： hello.jsp

代码清单 3 ： hello.jsp

<%@ taglib uri="/WEB-INF/fmtag.tld" prefix="fm" %> <html> <head> <title>Login</title> </head> <body> <h1>Hello World.</h1> <fm:template> <#assign y="Hello World"> ${y} <#assign seq = ["winter", "spring", "summer", "autumn"]> <#list seq as x> ${x_index + 1}. ${x}<#if x_has_next>,</#if> </#list> </fm:template> </body> </html>

本文使用的是 tomcat6，打开浏览器，进入页面 http://localhost：8080/test/hello.jsp . 得到结果如下：

Hello World 1. winter, 2. spring, 3. summer, 4. autumn

大家已经看到我们可以正确的显示FreeMarker的结果了，大家注意了FreeMarker的部分必须放在标签<fm:template>与</fm:template>之间，否则JSP不会解析FreeMarker的内容，会把源码输出在页面之中。

截止目前我们可以在JSP中正确的显示FreeMarker的内容了，但是如果我们使用的是Struts2，我们还必须得显示Struts2标签的内容。新建一个JSP文件 hello2.jsp, 以下是代码清单：

代码清单 4 ：hello2.jsp

<%@ taglib uri="/struts-tags" prefix="s" %> <html> <head> <title>Login</title> </head> <body> <s:form action="login"> <s:textfield name="username" label="Username"></s:textfield> <s:password name="password" label="Password"></s:password> </s:form> </body> </html>

启动服务器，进入页面http://localhost：8080/test/hello2.jsp 。

Wow，发生了以个异常：

代码清单 5 : exceptions

java.lang.NullPointerException at org.apache.struts2.sitemesh.FreeMarkerPageFilter.getLocale(FreeMarkerPageFilter.java:176) at org.apache.struts2.sitemesh.FreeMarkerPageFilter.applyDecorator(FreeMarkerPageFilter.java:143) at org.apache.struts2.sitemesh.TemplatePageFilter.applyDecorator(TemplatePageFilter.java:113) at com.opensymphony.module.sitemesh.filter.PageFilter.doFilter(PageFilter.java:62) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206) at org.apache.struts2.dispatcher.ActionContextCleanUp.doFilter(ActionContextCleanUp.java:99) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206) at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233) at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191) at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:128) at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102) at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109) at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:286) at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:845) at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:583) at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:447) at java.lang.Thread.run(Thread.java:619) Apr 23, 2009 10:34:04 AM org.apache.catalina.core.ApplicationContext log

异常发生在 at org.apache.struts2.sitemesh.FreeMarkerPageFilter.getLocale(FreeMarkerPageFilter.java:176)， FreeMarkerPageFilter是SiteMesh的Strust2 plugin 里边，找到这个文件，用Jad 反编译了一下，得到下边的代码：

代码清单 6 : FreeMarkerPageFilter.java

ackage org.apache.struts2.sitemesh; import com.opensymphony.module.sitemesh.*; import com.opensymphony.xwork2.*; import com.opensymphony.xwork2.util.logging.Logger; import com.opensymphony.xwork2.util.logging.LoggerFactory; import com.opensymphony.xwork2.util.profiling.UtilTimerStack; import freemarker.template.*; import java.io.IOException; import java.util.Locale; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.struts2.views.freemarker.FreemarkerManager; // Referenced classes of package org.apache.struts2.sitemesh: // TemplatePageFilter public class FreeMarkerPageFilter extends TemplatePageFilter { public FreeMarkerPageFilter() { } public static void setFreemarkerManager(FreemarkerManager mgr) { freemarkerManager = mgr; } protected void applyDecorator(Page page, Decorator decorator, HttpServletRequest req, HttpServletResponse res, ServletContext servletContext, ActionContext ctx) throws ServletException, IOException { String timerKey; timerKey = "FreemarkerPageFilter_applyDecorator: "; if(freemarkerManager == null) throw new ServletException("Missing freemarker dependency"); try { UtilTimerStack.push(timerKey); Configuration config = freemarkerManager.getConfiguration(servletContext); Template template = config.getTemplate(decorator.getPage(), getLocale(ctx.getActionInvocation(), config)); SimpleHash model = freemarkerManager.buildTemplateModel(ctx.getValueStack(), null, servletContext, req, res, config.getObjectWrapper()); model.put("page", page); if(page instanceof HTMLPage) { HTMLPage htmlPage = (HTMLPage)page; model.put("head", htmlPage.getHead()); } model.put("title", page.getTitle()); model.put("body", page.getBody()); model.put("page.properties", new SimpleHash(page.getProperties())); template.process(model, res.getWriter()); } catch(Exception e) { String msg = (new StringBuilder()).append("Error applying decorator: ").append(e.getMessage()).toString(); LOG.error(msg, e, new String[0]); throw new ServletException(msg, e); } UtilTimerStack.pop(timerKey); break MISSING_BLOCK_LABEL_251; Exception exception; exception; UtilTimerStack.pop(timerKey); throw exception; } protected Locale getLocale(ActionInvocation invocation, Configuration configuration) { if(invocation.getAction() instanceof LocaleProvider) return ((LocaleProvider)invocation.getAction()).getLocale(); else return configuration.getLocale(); } private static final Logger LOG = LoggerFactory.getLogger(org/apache/struts2/sitemesh/FreeMarkerPageFilter); private static FreemarkerManager freemarkerManager; }

我们知道问题是出现方法getLocale(...)中的，观察这个方法，我们发现这个方法没有对invocation 做空判断，应该为：

if (invocation != null && invocation.getAction() instanceof LocaleProvider){ ... }

现在知道问题之所在了，如何去解决呢，去改FreeMarkerPageFilter源码，然后重新编译打包，然后再替换原有官方提供的jar包吗？显然这样做是不妥了，幸亏Java提供了多态的功能，我们可以自己写一个类来继承FreeMarkerPageFilter, 叫MyFreeMarkerPageFilter, 然后重新实现getLocale()方法，再把MyFreeMarkerPageFilter配到xml文件里就行了。

让我们先看看MyFreeMarkerPageFilter 和新的web.xml.

代码清单 7 : MyFreeMarkerPageFilter.java

package tmf.filter; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.LocaleProvider; import freemarker.template.Configuration; import java.util.Locale; import org.apache.struts2.sitemesh.FreeMarkerPageFilter; public class MyFreeMarkerPageFilter extends FreeMarkerPageFilter { protected Locale getLocale(ActionInvocation invocation, Configuration configuration) { if (invocation != null && invocation.getAction() instanceof LocaleProvider) { return ((LocaleProvider) invocation.getAction()).getLocale(); } else { return configuration.getLocale(); } } }

代码清单 8 ：新 web.xml

<filter> <filter-name>struts-cleanup</filter-name> <filter-class>org.apache.struts2.dispatcher.ActionContextCleanUp</filter-class> </filter> <filter> <filter-name>sitemesh-freemarker</filter-name>  <filter-class>tmf.filter.MyFreeMarkerPageFilter</filter-class> <init-param> <param-name>default_encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter> <filter-name>struts2</filter-name> <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class> </filter> <filter-mapping> <filter-name>struts-cleanup</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>sitemesh-freemarker</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>struts2</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <servlet-name>JspSupportServlet</servlet-name> <servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet>

重新启动服务器，进入页面： http://localhost：8080/test/hello2.jsp