velocity(3)——在web项目中使用velocity

1、maven依赖

<dependencies>
  <dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity</artifactId>
    <version>1.7</version>
  </dependency>
  <dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-tools</artifactId>
    <version>2.0</version>
  </dependency>
</dependencies>

2、web.xml
velocity-tools 提供了很多实用的 Java 类，使用这些小工具前，需要在 web.xml 中配置 toolbox.xml 文件，在 VelocityViewServlet 后加入另一个参数：org.apache.velocity.toolbox。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    version="2.5">
    <!-- 每个action都需要配置一个servlet，继承自org.apache.velocity.tools.view.VelocityViewServlet -->
    <servlet>
        <servlet-name>my</servlet-name>
        <servlet-class>com.mipo.velocity.MyVelocityViewServlet</servlet-class>
        <init-param>
            <param-name>org.apache.velocity.properties</param-name>
            <param-value>/WEB-INF/velocity.properties</param-value>
        </init-param>
        <init-param>
            <param-name>org.apache.velocity.toolbox</param-name>
            <param-value>/WEB-INF/toolbox.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>my</servlet-name>
        <url-pattern>/my/my.vm</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>my</servlet-name>
        <url-pattern>/my/my.jsp</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>my</servlet-name>
        <url-pattern>/my/my.htm</url-pattern>
    </servlet-mapping>
</web-app>

3、/WEB-INF/velocity.properties
通过配置velocity.properties文件，可以自定义vm文件加载方式，指定编码等。当然，也可以不配置velocity.properties，使用缺省的值即可。缺省的velocity.properties文件在velocity-1.7.jar 的 org.apache.velocity.runtime.defaults 下，同目录下的 directive.properties 定义的是 velocity 的常用指令（#set 等），我们可以打开观看其具体实现，这里不多做解释。

## 设置模板文件加载器，webapp从应用根目录加载
resource.loader = webapp
webapp.resource.loader.class = org.apache.velocity.tools.view.WebappResourceLoader
## 模板路径，根目录下的vm文件夹，比如访问http://localhost:8080/velocity/t.htm，则选中的模板路径是webapp/vm/t.htm，如果没配置，默认的模板路径是webapp/t.htm
webapp.resource.loader.path = /vm
## 设置编码，不设置会中文乱码
input.encoding = UTF-8
output.encoding = UTF-8

4、/WEB-INF/toolbox.xml
toolbox可以灵活配置一些 apache 预先提供的工具类和自定义一些工具类。

<?xml version="1.0" encoding="UTF-8"?>
<tools>
    <data type="string" key="version" value="2.0" />
    <!--在这里配置类，在项目启动的时候就自动把类实例化好了，在页面就可以用了，例子：下面${test.Method()}-->
    <toolbox scope="request">
        <!-- currentProject util start -->
        <tool key="test" class="com.mipo.service.Test"></tool>
        <tool class="org.apache.velocity.tools.generic.DateTool" key="date">
            <parameter name="format" value="yyyy-MM-dd HH:mm:ss"/>
        </tool>
        <!-- currentProject util end -->
        <!-- 下面的这些配置都是velocity的配置，可以不用管，也不能更改 -->
        <!-- velocity util start -->
        <tool class="org.apache.velocity.tools.view.CookieTool" />
        <tool class="org.apache.velocity.tools.view.ImportTool" />
        <tool class="org.apache.velocity.tools.view.IncludeTool" />
        <tool class="org.apache.velocity.tools.view.LinkTool" />
        <tool class="org.apache.velocity.tools.view.PagerTool" />
        <tool class="org.apache.velocity.tools.view.ParameterTool" />
        <tool class="org.apache.velocity.tools.view.ViewContextTool" />
        <tool class="org.apache.velocity.tools.generic.ContextTool" />
        <tool class="org.apache.velocity.tools.generic.LoopTool" />
        <tool class="org.apache.velocity.tools.generic.RenderTool" />
        <!-- velocity util end -->
    </toolbox>
    <toolbox scope="session" createSession="false">
        <tool class="org.apache.velocity.tools.view.BrowserTool" />
    </toolbox>
    <toolbox scope="application">
        <tool class="org.apache.velocity.tools.generic.AlternatorTool" />
        <tool class="org.apache.velocity.tools.generic.ClassTool" />
        <tool class="org.apache.velocity.tools.generic.ComparisonDateTool" />
        <tool class="org.apache.velocity.tools.generic.ConversionTool" />
        <tool class="org.apache.velocity.tools.generic.DisplayTool" />
        <tool class="org.apache.velocity.tools.generic.EscapeTool" />
        <tool class="org.apache.velocity.tools.generic.FieldTool" />
        <tool class="org.apache.velocity.tools.generic.MathTool" />
        <tool class="org.apache.velocity.tools.generic.NumberTool" />
        <tool class="org.apache.velocity.tools.generic.ResourceTool" />
        <tool class="org.apache.velocity.tools.generic.SortTool" />
        <tool class="org.apache.velocity.tools.generic.XmlTool" />
        <tool class="org.apache.velocity.tools.generic.ListTool" />
    </toolbox>
</tools>

5、java类

package com.mipo.velocity;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.velocity.Template;
import org.apache.velocity.context.Context;
import org.apache.velocity.tools.view.VelocityViewServlet;
public class MyVelocityViewServlet extends VelocityViewServlet {
    @Override
    protected Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context context) {
        // 往Context容器存放变量
        context.put("fullName", "lixiaolin");
        // 也可以往request域中存值
        request.setAttribute("anotherName", "xlli");
        User user1 = new User();
        user1.setId("1001");
        user1.setName("jack");
        User user2 = new User();
        user2.setId("1002");
        user2.setName("xlli");
        List listTree = new ArrayList();
        listTree.add(user1);
        listTree.add(user2);
        request.setAttribute("listTree", listTree);
        // forward到指定模板
        return getTemplate("t.htm");
    }
}

package com.mipo.velocity;
public class User {
    public String id;
    public String name;
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

6、webapp/vm/t.htm
vm文件是作为jsp的替代来展示给用户，在vm文件中可以获得在Context域或request等域中存放的值。默认情况下，会在资源根路径下搜索vm文件，所以直接将vm放在根路径下即可（也可以通过配置velocity.properties指定加载路径） 。
在管理的vm文件中获得request、session与application对象，也可以直接获取在这几个域对象中保存的值，获取的顺序与EL表达式获取的顺序类似：${request} –>${session} –>${application} 。比如${testArr}，获取testArr属性，velocity会在velocity的context中寻找。没找到在request域中找，没找到在session中找。

#set($greet = "hello")
<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
</head>
<body>
    <p>$!{greet} $!{fullName}</p>
    <p>my another name is $!{anotherName}</p>
    <p>my another name is $!{request.anotherName}</p>
    <p>${test.getUser()}</p>
    <p>$date</p>
    <select>
        <option value="0">请选择</option> 
        #foreach($list in $!request.listTree)
            #if($!list.name==$request.anotherName)
                <option value="$!list.id" selected="selected">$!list.name</option>
            #else
                <option value="$!list.id">$!list.name</option> 
            #end 
        #end
    </select>
</body>
</html>

7、输出

image.png
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容