Velocity 在Spring中的配置

最新推荐文章于 2024-01-21 03:41:35 发布

隔壁赵大壮

最新推荐文章于 2024-01-21 03:41:35 发布

阅读量789

点赞数 1

CC 4.0 BY-SA版权

分类专栏：日积月累文章标签： velocity

本文链接：https://blog.youkuaiyun.com/qq_40307945/article/details/78409342

日积月累专栏收录该内容

3 篇文章

订阅专栏

本文介绍如何在Spring+SpringMVC+Mybatis+maven项目中配置Velocity模板引擎，并详细说明了pom.xml依赖、web.xml及spring-mvc.xml配置、velocity.properties设置等步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Velocity类似JSP，是一种基于Java的模板引擎。它可以在web页面中引用Java代码中定义的数据和对象，而Velocity的作用就是把Web视图和java代码进行组装在一起。和JSP相比，velocity对前后端的分离更加彻底。
本次项目使用的是项目使用的是Spring+SpringMVC+Mybatis+maven。
基本配置如下：
1、pom.xml中添加velocity依赖的jar包:

            <!-- velocity begin -->
            <dependency>
                <groupId>velocity-tools</groupId>
                <artifactId>velocity-tools</artifactId>
                <version>2.0</version>
            </dependency>
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity</artifactId>
                <version>1.7</version>
            </dependency>
            <!-- velocity end -->

2、在web.xml中配置

    <servlet>
        <servlet-name>springMvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:/spring/spring-mvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>springMvc</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>

3、在spring-mvc.xml中配置：

        <bean id="velocityConfigurer" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">
        <property name="resourceLoaderPath">
            <value>/WEB-INF/vm</value>
        </property>
        <property name="velocityProperties">
            <props>
                <prop key="input.encoding">UTF-8</prop>
                <prop key="output.encoding">UTF-8</prop>
                <prop key="directive.foreach.counter.name">loopCounter</prop>
                <prop key="directive.foreach.counter.initial.value">0</prop>
            </props>
        </property>
        <property name="configLocation" value="classpath:/velocity.properties"/>
    </bean>


    <bean id="velocityViewResolver" class="org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver">
        <property name="layoutUrl" value="/layout/default.vm"/>
        <property name="suffix">
            <value>.vm</value>
        </property>
        <property name="contentType">
            <value>text/html;charset=UTF-8</value>
        </property>
        <property name="exposeSpringMacroHelpers" value="true"/>
        <property name="toolboxConfigLocation" value="/WEB-INF/toolbox.xml"/>
        <property name="dateToolAttribute" value="dateTool"/>
        <property name="numberToolAttribute" value="numberTool"/>
        <property name="viewClass" value="com.test.common.web.velocity.VelocityToolbox20View"/>
    </bean>

4、在类路径下添加velocity.properties文件，对velocity做一些默认配置，如：

input.encoding=UTF-8
output.encoding=UTF-8

更多配置可以参考Velocity配置详解

5、在上面的配置中配置了toolbox.xml,在相应的路径下创建toolbox.xml文件，在toolbox.xml中我们可以添加我们想使用的工具类，如：

<?xml version="1.0"?>

    <tools>
    <data type="boolean" key="VIEW_TOOLS_AVAILABLE" value="true"/>
    <toolbox scope="request">
        <tool key="cookie" 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.ResourceTool"/>

    </toolbox>
    <toolbox scope="application">
        <tool key="stringEscapeUtils" class="org.apache.commons.lang.StringEscapeUtils"/>
        <tool key="stringUtils" class="org.apache.commons.lang.StringUtils"/>
    </toolbox>
</tools>

6、在第三步我们做了配置
<property name="layoutUrl" value="/layout/default.vm"/>
做完这个配置后，页面会自动套上default.vm这个模板，在default.vm中我们还可以做更多操作，比如：

<!DOCTYPE HTML>
<html xmlns="http://www.w3.org/1999/xhtml">
    #parse("/common/head.vm")
<body>
    $screen_content
    ##parse("/WEB-INF/vm/common/bottom.vm")
</body>
</html>

这样配置后头部会自动套用的是head.vm这个模板。