1. 引言
Apache软件基金会的Velocity是一款模板引擎，它可以与普通文本文件、SQL、XML、Java代码等多种类型配合使用。
在这篇文章中，我们将专注于在典型Spring MVC web应用中使用Velocity。
2. Maven依赖项
首先，让我们启用Velocity支持，通过以下依赖：
<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>
最新版本可以在velocity和velocity-tools找到。
3. 配置
3.1. web配置
如果我们不想使用web.xml，我们可以使用Java和初始化器进行Web项目配置：
public class MainWebAppInitializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext sc) throws ServletException {
AnnotationConfigWebApplicationContext root = new AnnotationConfigWebApplicationContext();
root.register(WebConfig.class);
sc.addListener(new ContextLoaderListener(root));
ServletRegistration.Dynamic appServlet =
sc.addServlet("mvc", new DispatcherServlet(new GenericWebApplicationContext()));
appServlet.setLoadOnStartup(1);
}
}
当然，我们也可以选择传统的web.xml方式：
<web-app ...>
<display-name>Spring MVC Velocity</display-name>
<servlet>
<servlet-name>mvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/mvc-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>mvc</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-context.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</web-app>
请注意，我们已将servlet映射到“/*”路径。
3.2. Spring配置
现在让我们来看看一个简单的Spring配置，同样从Java开始：
@Configuration
@EnableWebMvc
@ComponentScan(basePackages= {
"com.baeldung.mvc.velocity.controller",
"com.baeldung.mvc.velocity.service" })
public class WebConfig extends WebMvcConfigurerAdapter {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
.addResourceHandler("/resources/**")
.addResourceLocations("/resources/");
}
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
@Bean
public ViewResolver viewResolver() {
VelocityLayoutViewResolver bean = new VelocityLayoutViewResolver();
bean.setCache(true);
bean.setPrefix("/WEB-INF/views/");
bean.setLayoutUrl("/WEB-INF/layouts/layout.vm");
bean.setSuffix(".vm");
return bean;
}
@Bean
public VelocityConfigurer velocityConfig() {
VelocityConfigurer velocityConfigurer = new VelocityConfigurer();
velocityConfigurer.setResourceLoaderPath("/");
return velocityConfigurer;
}
}
再来看看XML配置版本：
<beans ...>
<context:component-scan base-package="com.baeldung.mvc.velocity.*" />
<context:annotation-config />
<bean id="velocityConfig"
class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">
<property name="resourceLoaderPath">
<value>/</value>
</property>
</bean>
<bean id="viewResolver"
class="org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver">
<property name="cache" value="true" />
<property name="prefix" value="/WEB-INF/views/" />
<property name="layoutUrl" value="/WEB-INF/layouts/layout.vm" />
<property name="suffix" value=".vm" />
</bean>
</beans>
在这里，我们告诉Spring在哪里查找注解定义的bean：
<context:component-scan base-package="com.baeldung.mvc.velocity.*" />
通过以下行，我们表示我们的项目将使用注解驱动的配置：
<context:annotation-config />
通过创建velocityConfig和viewResolver bean，我们告诉VelocityConfigurer在哪里查找模板，以及VelocityLayoutViewResolver在哪里查找视图和布局。
4. Velocity模板
最后，让我们创建我们的模板，从一个通用的头部开始：
<div style="...">
<div style="float: left">
<h1>Our tutorials</h1>
</div>
</div>
和底部：
<div style="...">
@Copyright baeldung.com
</div>
然后定义一个我们将在其中使用上述片段的站点通用布局，如下所示：
<html>
<head>
<title>Spring & Velocity</title>
</head>
<body>
<div>
#parse("/WEB-INF/fragments/header.vm")
</div>
<div>
<!-- View index.vm is inserted here -->
$screen_content
</div>
<div>
#parse("/WEB-INF/fragments/footer.vm")
</div>
</body>
</html>
你可以检查$screen_content变量包含了页面的内容。
最后，我们将创建一个用于主要内容的模板：
<h1>Index</h1>
<h2>Tutorials list</h2>
<table border="1">
<tr>
<th>Tutorial Id</th>
<th>Tutorial Title</th>
<th>Tutorial Description</th>
<th>Tutorial Author</th>
</tr>
#foreach($tut in $tutorials)
<tr>
<td>$tut.tutId</td>
<td>$tut.title</td>
<td>$tut.description</td>
<td>$tut.author</td>
</tr>
#end
</table>
5. 控制器方面
我们已经创建了一个简单的控制器，它返回一系列教程作为内容填充布局：
@Controller
@RequestMapping("/")
public class MainController {
@Autowired
private ITutorialsService tutService;
@RequestMapping(value ="/", method = RequestMethod.GET)
public String defaultPage() {
return "index";
}
@RequestMapping(value ="/list", method = RequestMethod.GET)
public String listTutorialsPage(Model model) {
List<Tutorial> list = tutService.listTutorials();
model.addAttribute("tutorials", list);
return "index";
}
}
最后，我们可以在本地访问这个简单示例，例如：localhost:8080/spring-mvc-velocity/
6. 总结
在这篇简短教程中，我们配置了带有Velocity模板引擎的Spring MVC web应用。
此教程的完整示例代码可以在我们的GitHub仓库中找到。