`

2.3、struts freemarker

 
阅读更多
FreeMarker是一个非常优秀的模板引擎,这个模板引擎可用于任何场景,FreeMarker负责将数据模型中的数据合并到模板中,从而生成标准输出.界面开发人员只需要关于界面(也就是模板文件)的开发,而业务逻辑开发者只需要负责将需要显示的数据填入数据模型-----FreeMarker负责合并数据模型和模板,从而生成标准输出.

FreeMarker特别适应于MVC模式的Web应用,虽然FreeMarker具有一些编程能力,但这种编程能力非常有限,无法实现业务逻辑,只能提供一些数据格式的转换功能.因此,通常由Java程序准备要显示的数据,由FreeMarker模板引擎来生成页面,而FreeMarker模板则提供页面布局支持.

此外,FreeMarker也是与Web容器无关的,也就是FreeMarker并不一定需要运行在Web容器中:FreeMarker同样可以应用于非Web应用程序环境.而且,FreeMarker并不是只能生成HTML页面,它也可以生成各种文本,如XML,RTF,Java源代码等.

Struts2默认采用FreeMarker作为其模板文件,而Struts2所有的主题模板文件都是采用FreeMarker编写的,eclipse中的JSP,Java等模板文件也是采用FreeMarker技术.

1,在java程序中使用FreeMarker

FreeMarker的模板就是一个.ftl文本文件,在该文件中使用了一些FreeMarker的特别标记,这些标记会动态显示,或者控制程序输出,如下面的模板文件代码:
${name},你好!${msg}
这里类似于${}的就是动态的内容,称作"插值".

为了使用FreeMarker来将数据模型中的值合并到模板文件中,可按如下步骤进行:
1,创建Configuration实例,该实例负责管理FreeMarker的模板加载路径,负责生成模板实例
2,使用Configuration实例来生成Template实例,同进需要指定使用的模板文件
3,填充数据模型,数据模型就是一个Map对象
4,调用Template实例的process方法完成合并.

下面是一个使用FreeMarker创建输出的Java程序,程序源代码如下:
package lee;
import java.util.*;
import java.io.*;
import freemarker.template.*;

public class HelloFreeMarker
{
    private Configuration cfg;
    public void init() throws Exception
    {
        //初始化FreeMarker配置
        //创建一个Configuration实例
        cfg = new Configuration();
        //设置FreeMarker的模版文件位置
        cfg.setDirectoryForTemplateLoading(new File("templates"));
    }
   
    public void process()throws Exception
    {
        Map root = new HashMap();
        root.put("name", "FreeMarker!");
        root.put("msg" , "您已经完成了第一个FreeMarker的示例");
        Template t = cfg.getTemplate("test.ftl");
        t.process(root, new OutputStreamWriter(System.out));

    }

    public static void main(String[] args)throws Exception
    {
       HelloFreeMarker hf = new HelloFreeMarker();
       hf.init();
       hf.process();
    }
}
上面的代码创建了一个Map实例,这个Map将作为模板文件的数据模型,我们要使用FreeMarker必须导入freemarker.jar文件,FreeMarker的官网是http://freemarker.sourceforge.net/,虽然FreeMarker可以在Java程序中使用,但大部分时候还是用来生成HTML页面.

2,在Web应用中使用FreeMarker

在Web应用中使用FreeMarker跟在Java程序中使用并没有太大的区别.下面是是一个在Web中使用的例子,用来生成HTML页面的模板文件内容如下:
<html>
<head>
<title>FreeMarker的HelloWorld</title>
</head>
<body>
${message}
</body>
</html>
我们在Web应用中使用FreeMarker时,应该让Servlet来合并模板和数据,因此,Servlet负责创建Configuration实例,并负责合并模板和数据,下面是Servlet源代码:
package lee;
import java.util.*;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import freemarker.template.*;

public class HelloServlet extends HttpServlet
{
    private Configuration cfg;
    public void init()
    {
        //初始化FreeMarker配置
        //创建一个Configuration实例
        cfg = new Configuration();
        //设置FreeMarker的模版文件位置
        cfg.setServletContextForTemplateLoading(getServletContext(), "WEB-INF/templates");
    }
   
    public void service(HttpServletRequest request, HttpServletResponse response)
        throws ServletException, IOException
    {       
        //建立数据模型
        Map root = new HashMap();
        root.put("message", "Hello FreeMarker!");    
        //取得模版文件
        Template t = cfg.getTemplate("test.ftl");       
        // 开始准备生成输出
        // - 使用模版文件的charset作为本页面的charset
        // - 使用text/html MIME-type
        response.setContentType("text/html; charset=" + t.getEncoding());
        Writer out = response.getWriter();
       
        //合并数据模型和模版,并将结果输出到out中
        try
        {
            t.process(root, out);
        }
        catch (TemplateException e)
        {
            throw new ServletException("处理Template模版中出现错误", e);
        }
    }
}
可以看到这个Servlet类的代码与普通的Java程序中使用FreeMarker大致一样,区别有两个:1,设置FreeMarker加载模板的方法不一样,在Servlet中设置加载的方法是setServletContextForTemplateLoading,第一个参数是本web应用的ServletContext,第二个参数是模板文件的路径.;2,结果必须输出到HttpServletResponse中,才能被浏览器加载.
配置Servlet的web.xml文件中的代码如下:
<web-app>
<servlet>
   <servlet-name>hello</servlet-name>
   <servlet-class>lee.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
   <servlet-name>hello</servlet-name>
   <url-pattern>/hello</url-pattern>
</servlet-mapping>
</web-app>

3,FreeMarker的模板文件

从上面的例子可以看到FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成:
1,文本:直接输出的部分
2,注释:<#-- ... -->格式部分,不会输出
3,插值:即${...}或#{...}格式的部分,将使用数据模型中的部分替代输出
4,FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出

下面是一个FreeMarker模板的例子,包含了以上所说的4个部分
<html><br>
<head><br>
<title>Welcome!</title><br>
</head><br>
<body><br>
<#-- 注释部分 --><br>
<#-- 下面使用插值 -->
<h1>Welcome ${user} !</h1><br>
<p>We have these animals:<br>
<u1><br>
<#-- 使用FTL指令 -->
<#list animals as being><br>
   <li>${being.name} for ${being.price} Euros<br>
<#list><br>
<u1><br>
</body><br>
</html>

FreeMarker的语法知识将在下一篇文章中介绍

4,使用FreeMarker作为Struts2的视图技术

Struts2使用FreeMarker作为其默认的模板技术,因此Struts2对FreeMarker的支持非常良好,为了在Struts2中使用FreeMarker模板技术,只需要在struts.xml文件中进行简单配置即可.

4.1在FreeMarker模板中使用Struts2标签

在FreeMarker模板中使用标签毕竟不同于在JSP页面中使用标签,因为FreeMarker不支持使用taglib指令来导入标签库.但Struts2为了在FreeMarker模板中使用标签库提供了额外的支持.可以按照下面的步骤进行:
1,将系统所需要的标签库定义文件(.tld文件)复制到WEB-INF目录下,对于Struts2,则是复制struts2-core-2.0.11.2.jar中的META-INF\struts-tags.tld文件
2,在web.xml文件中启动JspSupportServlet.为了启动它,则应该在web.xml文件中增加如下配置片段:
<!-- 定义一个JspSupportServlet -->
<servlet>
   <servlet-name>JspSupportServlet</servlet-name>
   <servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
   <!-- 配置JspSupportServlet优先启动 -->
   <load-on-startup>1</load-on-startup>
</servlet>
3,在FreeMarker模板中使用assign指令导入标签库,导入标签库的代码如下:
<#-- 定义/WEB-INF/struts-tags.tld文件对应的标签库前缀为s -->
<#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />
4,在FreeMarker模板中增加了标签库的定义之后就可以使用了,下面是在FreeMarker模板中使用标签的代码:
<#-- 在FreeMarker中使用Struts2标签 -->
<@s.form action="Login.action">
<@s.textfield name="username" label="用户名"/>
<@s.textfield name="password" label="密码"/>
<@s.submit value="提交"/>
</@s.form>
如果是在JSP中使用Struts2标签,则格式如下:
<s:form action="Login.action">
<s:textfield name="username" label="用户名"/>
<s:textfield name="password" label="密码"/>
<s:submit value="提交"/>
</s:form>
值得注意的是,我们不能通过浏览器直接访问.ftl文件,否则将看到该模板页面的源代码,而不是我们想要的生成的HTML页面.这是因为Web容器默认不会处理FreeMarker模板页面.

在Struts2框架下,Struts2框架充当了之前的Servlet角色,只要浏览器的请求经过Struts2处理后,Struts2都会自动加载FreeMarker模板,并使用数据模型来填充该模板,再将最后的HTML页面输出给客户端.为了让所有的用户请求都经过Struts2的处理,这里将所有的FreeMarker模板放在WEB-INF\ftl目录下.(WEB-INF目录下的所有文件客户端都是不能直接访问的),因为浏览器无法访问.ftl文件了,因此我们在struts.xml配置文件中增加如下配置:
   <!-- 配置匹配所有请求的Action -->
        <action name="*">
            <result type="freemarker">/WEB-INF/ftl/{1}.ftl</result>
        </action>
国为增加了上面的配置,在浏览器中请求login.action的时候,该action会被转向login.ftl模板.此时就可以看到返回的HTML页面.

4.2 使用FreeMarker的Result

从前面我们可以看到,使用FreeMarker与使用JSP作为输出文件并没有太大区别,下面来看看刚才的应用中Action中的代码:
package lee;
import com.opensymphony.xwork2.Action;
import com.opensymphony.xwork2.ActionContext;
public class LoginAction implements Action
{
    private String username;
    private String password;

    public String getUsername()
    {
        return username;
    }
    public void setUsername(String username)
    {
        this.username = username;
    }

    public String getPassword()
    {
        return password;
    }
    public void setPassword(String password)
    {
        this.password = password;
    }

    public String execute() throws Exception
    {
        if (getUsername().equals("scott")
                && getPassword().equals("tiger") )
        {
            ActionContext.getContext().getSession().put("user" ,          getUsername());
            return SUCCESS;
        }
        else
        {
            return ERROR;
        }
    }
}
此Action在struts.xml文件中的配置如下:
<action name="Login" class="lee.LoginAction">
<result name="error" type="freemarker">/WEB-INF/ftl/error.ftl</result>
<result name="success" type="freemarker">/WEB-INF/ftl/welcome.ftl</result>       
</action>
返回的成功页面代码如下:
<html>
    <head>
        <title>成功页面</title>
    </head>
    <body>
        欢迎,${user},您已经登录!<br>
<a href="GetBooks.action">查看作者李刚已出版的图书</a>
    </body>
</html>
可以看到这个成功页面会将user变量中的内容读出并显示,实际上,该变量值将可以从多个地方取得,Struts2解析FreeMarker模板中变量的顺序如下:
1,FreeMarker模板内建的变量;
2,ValueStack中的变量;
3,ActionContext中的变量;
4,HttpServletRequest中的属性;
5,HttpSession中的属性;
6,ServletContext范围的属性.

FreeMarker模板的内建变量有如下几个:
1,stack:代表ValueStack本身,可通过如下方式来访问其中的变量"${stack.findString('ognl expr')}"
2,action:代表刚刚执行过的Action实例
3,response:代表HpptServletResponse实例
4,res:代表HpptServletResponse实例
5,request:代表HpptServletRequest实例
6,req:代表HpptServletRequest实例
7,session:代表HpptSession实例
8,application:代表ServletContext实例
9,base:代表用户请求的上下文路径.

4.3 FreeMarker中访问Servlet/JSP范围对象

Struts2还为在FreeMarker模板中访问Servlet/JSP范围对象提供了支持,通过这种支持可以直接访问这些变量.
访问application范围内的属性代码如下:
<#if Application.attributeName?exists>
${Application.attributeName}
</#if>
也可以通过使用Struts2标签来输出,代码如下:
<@s.property value="${#application.attributeName}" />

访问session范围内的属性如下:
<#if Session.attributeName?exists>
${Session.attributeName}
</#if>

<@s.property value="${#session.attributeName}" />

访问request范围内的属性如下:
<#if Request.attributeName?exists>
${Request.attributeName}
</#if>

<@s.property value="${#request.attributeName}" />

对于request,还可以访问request的请求参数,如下:
<#if Parameter.parameterName?exists>
${Parameter.parameterName}
</#if>

<@s.property value="${#parameter.parameterName}" />

访问ValueStack上下文参数,代码如下:
${stack.findValue('#myContextParam')}

<@s.property value="${#myContextParam}" />
分享到:
评论

相关推荐

    struts-2.3.16.3

    Struts 2以其灵活性和可扩展性著称,它允许开发者通过拦截器(Interceptor)机制来定制请求处理流程,同时支持多种视图技术,如JSP、FreeMarker、 Velocity等。此外,Struts 2还集成了其他流行的技术,如Spring、...

    Struts2.2 升级到Struts2.3

    确保所有相关依赖库(如ognl、freemarker、xwork等)都更新到与Struts2.3.32兼容的版本,避免因版本不匹配导致的运行问题。 2. **配置文件的修改**: - `struts.xml`:这是Struts的核心配置文件,可能会有一些新的...

    struts2.3最少依赖的包

    Struts2.3是最受欢迎的Java Web开发框架Struts2的一个特定版本,它提供了一种模型-视图-控制器(MVC)架构来构建可维护、可扩展的Web应用程序。Struts2.3最少依赖的包指的是运行Struts2应用的基础组件集合,允许...

    Struts2.3.15.1版本升级到2.3.32详细流程

    ### Struts2.3.15.1版本升级到2.3.32详细流程 #### 背景概述 Apache Struts是一个流行的用于构建企业级Java Web应用程序的开源框架。Struts2作为Struts框架的第二代产品,提供了一个灵活的架构来支持MVC设计模式,...

    struts2.3 jar包

    Struts2.3是Apache软件基金会的开源框架Struts2的一个特定版本,它主要用于构建Java Web应用程序。这个框架基于Model-View-Controller (MVC)架构模式,为开发者提供了强大的控制层解决方案。在"struts2.3 jar包"中,...

    struts2.3.4.1

    Struts2.3.4.1 是一个重要的Java Web开发框架的特定版本,它基于Model-View-Controller(MVC)设计模式,旨在简化企业级应用程序的开发过程。这个版本在Struts2系列中占据了一个关键的位置,因为它包含了对之前版本...

    Struts-2.3.15.3

    版本2.3.15.3是该框架的一个稳定发行版,它包含了一系列优化和安全更新。在这个版本中,Struts2的核心功能得以强化,以支持更高效、安全的开发实践。 Struts2框架的主要优点包括其灵活性、可扩展性和丰富的插件库。...

    struts2.3.1.2

    Struts2.3.1.2是Apache软件基金会开发的一款基于MVC(Model-View-Controller)设计模式的Java Web应用程序框架的版本。这个版本在2012年1月22日发布,是对Struts2框架的一次重要更新,旨在提供更好的性能、稳定性...

    struts-2.3.15.3源码

    关于删除的lib库,Struts 2依赖于一系列的第三方库,包括Apache Commons、XWork、Freemarker、Java Servlet API等。这些库提供了诸如依赖注入、AOP(面向切面编程)、I18N(国际化)、数据校验等功能。在开发环境中...

    Struts2的DTD配置文件struts-2.3.dtd

    `struts-2.3.dtd`为`struts.xml`文件提供了语法指导,确保开发者遵循Struts2框架的正确配置格式。通过引用这个DTD,IDE可以验证配置文件的语法,从而提供有用的错误检查和代码补全功能,提高开发效率。 在`struts....

    Struts2.3.1.2源码

    5. **插件体系**: Struts2拥有丰富的插件库,如Freemarker和Velocity视图技术插件、JSON插件、Spring集成插件等,这些插件增强了Struts2的功能,使其能适应各种应用场景。 6. **异常处理**: Struts2提供了一套完整...

    struts-2.3.16.1-all

    此“struts-2.3.16.1-all”压缩包包含了Struts 2框架的完整开发包,适用于开发者进行项目开发和学习。 **Struts 2框架的核心组件及功能:** 1. **Action类**:在Struts 2中,业务逻辑主要在Action类中实现。Action...

    struts2.3.20.1 全部jar包

    标题中的"struts2.3.20.1 全部jar包"指的是Struts2框架的3.20.1版本的所有依赖JAR文件集合。这个版本的Struts2包含了该框架运行所需的核心组件和其他相关库,使得开发者能够有效地开发基于Struts2的应用程序。 描述...

    struts 2.3.4.1 jar

    Struts 2.3.4.1 是一个流行的开源Java框架,主要用于构建MVC(Model-View-Controller)架构的Web应用程序。这个版本包含了多个关键组件的更新和改进,为开发者提供了更强大、更安全的功能。以下是这个版本中涉及的...

    struts-2.3.1.2.zip

    5. **Freemarker或JSP作为视图**:Struts 2支持多种视图技术,如Freemarker模板引擎和JSP。视图层负责展示数据,与模型和控制器分离,符合MVC设计模式。 6. **OGNL(Object-Graph Navigation Language)**:OGNL是...

    struts2.3核心jar包

    Struts2拥有强大的插件体系,可以方便地扩展其功能,如Tiles插件用于布局管理,Freemarker或Velocity插件用于视图渲染。 9. ** strut2-convention-plugin**: 自Struts2.3版本开始,引入了约定优于配置的插件,...

    struts-2.3.15.3 lib库

    这个“struts-2.3.15.3 lib库”包含了Struts 2框架的多个依赖库文件,这些文件对于理解和使用Struts 2框架至关重要。下面我们将深入探讨Struts 2.3.15.3版本中的关键知识点。 首先,Struts 2框架基于Action和拦截器...

    struts-2.3.15.3所以jar包

    7. **freemarker.jar**:FreeMarker是一个模板引擎,用于生成动态HTML、XML等文本,它是Struts 2默认的视图技术,允许开发者使用模板语言来设计页面布局。 8. **xwork-core.jar**:XWork是Struts 2的前身,它的核心...

    struts 2.3.15.2 源码

    Struts 2.3.15.2是该框架的一个版本,包含了自2.3.15.1以来的最新更新和修复。 在Struts 2.3.15.2的源码中,我们可以深入研究以下几个核心知识点: 1. **Action与Result**:Struts 2的核心是Action类,它是业务...

Global site tag (gtag.js) - Google Analytics