Velocity初探小结--Velocity在spring中的配置和使用

　　最近正在做的项目前端使用了Velocity进行View层的数据渲染,之前没有接触过,草草过了一遍,就上手开始写,现在又回头细致的看了一遍,做个笔记.

　　velocity是一种基于java的模板引擎技术,有点类似与JSP,它允许页面设计者引用Java中定义的方法。前端页面设计者和后端Java开发者能够同时使用MVC的模式开发网站，这样前端能够把精力放在页面的设计上，后端也可以把精力放在代码开发上。Velocity把Java代码从Web页面中分离， 使网站可维护性更强.

　　注:项目使用的是Spring+Springmvc+mybatsi+maven.

项目中使用velocity

　　1.添加velocity依赖的jar包,这里使用maven管理依赖,所以只需要在pom.xml中添加:

<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>

　　2.因为项目使用到springmvc,所以项目中的web.xml需要配置一下DispatcherServlet,如下:

<!--配置springmvc的前端控制器 -->
  <servlet>
    <servlet-name>Spring web</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring/web-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>Spring web</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>

　　3.注意这里的contextConfigLocation参数,它指向了classpath路径下的spring目录下的web-context.xml文件,这里就是我们的spring的配置文件,我们将在这里配置Velocity的bean.

 <!-- 配置VelocityConfigurer，负责在spring中设置Velocity引擎。通过属性resourceLoaderPath告诉Velocity到哪里寻找它的模板。
   通常将模板放到WEB-INF下的某个子目录下，可以保证这些模板不能被直接访问。-->
    <bean id="velocityConfig"
          class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">
        <property name="resourceLoaderPath" value="/WEB-INF/velocity/templates"/>
        <property name="configLocation" value="classpath:velocity/velocity.properties"/>
    </bean>

    <!--配置试图解析器-->
    <bean id="viewResolver"
          class="org.springframework.web.servlet.view.velocity.VelocityViewResolver">
        <property name="cache" value="false"/>
        <property name="prefix" value=""/>
        <property name="suffix" value=".vm"/>
        <property name="contentType" value="text/html;charset=utf-8"/>
        <property name="toolboxConfigLocation" value="/WEB-INF/toolbox.xml"/>
        <property name="exposeSpringMacroHelpers" value="true"/>
        <property name="exposeRequestAttributes" value="true"/>
        <property name="exposeSessionAttributes" value="true"/>
        <property name="allowSessionOverride" value="true"/>
        <property name="allowRequestOverride" value="true"/>
    </bean>

　　在类路径的velocity目录中添加velocity.properties文件,在这个配置文件中可以自定义一些velocity默认配置:

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

　　这里我只是简单定义了输入输出的编码,对于不同的项目需要可以定义不同的参数,这一篇博文,对velocity.properties内容有比较详细的解释,感兴趣可以移步:Velocity配置详解

　　在web-context.xml文件中,还可以看到<property name="toolboxConfigLocation" value="/WEB-INF/toolbox.xml"/>,在web-inf路径下,建一个toolbox.xml文件,如下:

<?xml version="1.0" encoding="UTF-8" ?>
<toolbox>
    <tool>
        <key>UrlUtil</key>
        <class>com.nali.common.util.UrlUtil</class>
        <scope>application</scope>
    </tool>
    <tool>
        <key>VersionUtil</key>
        <class>com.ximalaya.shop.api.domain.util.VersionUtil</class>
        <scope>application</scope>
    </tool>
</toolbox>

　　这个配置文件可以让我们在vm中使用后台java类中定义的方法.

　　以上就完成了一个完整的ssm项目中使用velocity的流程,我们可以在"/WEB-INF/velocity/templates"下新建一些.vm的文件用于展示数据,对于velocity的语法使用,可以参考这篇网友翻译的官方文档:http://ifeve.com/apache-velocity-dev/