spring boot 使用velocity模板

原创

mob64ca12eb7baf 2024-10-12 04:53:36 ©著作权

文章标签 ci spring Web 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12eb7baf的原创作品，请联系作者获取转载授权，否则将追究法律责任

用Spring Boot实现Velocity模板

在现代Java开发中，很多人都希望快速开发出用户友好的Web应用程序。Spring Boot作为流行的框架之一，能够简化这一过程。而Velocity则是一个非常强大的模板引擎，可以帮助你动态生成HTML页面。接下来，我们将详细介绍如何在Spring Boot中使用Velocity模板。

流程概述

在实现Spring Boot使用Velocity模板的过程中，我们可以遵循以下几个步骤：

步骤	描述
1. 创建Spring Boot项目	使用Spring Initializr创建一个新的Spring Boot项目
2. 添加依赖	在`pom.xml`中添加Velocity模板和Spring Boot Starter依赖
3. 配置Velocity	创建Velocity配置文件和设置参数
4. 创建控制器	编写一个简单的控制器以处理请求并返回模板
5. 创建模板	在资源目录中创建一个Velocity模板文件
6. 运行项目	启动Spring Boot应用并访问模板页面

详细步骤

1. 创建Spring Boot项目

首先，你可以使用 [Spring Initializr]( 来生成一个新的Spring Boot项目。选择依赖项为Spring Web，并下载项目 ZIP 文件。解压并导入IDE中。

2. 添加依赖

在pom.xml中添加Velocity依赖。你的<dependencies>标签应该如下所示：

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>1.7</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

说明：Velocity引擎核心依赖以及Spring Boot Starter Web依赖让你能够构建一个Web应用。

3. 配置Velocity

在src/main/resources目录下创建application.properties文件，并添加以下配置：

spring.velocity.enabled=true
spring.velocity.resource-loader=class
spring.velocity.prefix=templates/
spring.velocity.suffix=.vm

说明：这些配置定义了Velocity模板的位置和文件后缀。

4. 创建控制器

在src/main/java/{your_package}/controller目录下创建一个控制器类，比如HomeController：

package {your_package}.controller;

import org.apache.velocity.app.VelocityEngine;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.ui.Model;

import java.util.HashMap;
import java.util.Map;

@Controller
public class HomeController {

    @Autowired
    private VelocityEngine velocityEngine;

    @GetMapping("/")
    public String index(Model model) {
        Map<String, Object> context = new HashMap<>();
        context.put("name", "World"); // 添加数据到上下文
        model.addAttribute("context", context);
        return "index"; // 返回视图名称
    }
}

说明：这个HomeController使用@GetMapping来处理根路径请求，生成一个建有“name”属性的上下文，并返回模板名称。

5. 创建模板

在src/main/resources/templates/目录下创建一个名为index.vm的文件。内容如下：

<!DOCTYPE html>
<html>
<head>
    <title>Hello Velocity</title>
</head>
<body>
    Hello $context.name! <!-- 使用Velocity引用上下文变量 -->
</body>
</html>

说明：index.vm是用来显示数据的模板，通过$context.name来引用在控制器中设置的值。

6. 运行项目

在项目根目录下打开终端，执行以下命令启动项目：

./mvnw spring-boot:run

说明：启动Spring Boot项目后，你可以在浏览器中访问http://localhost:8080，看到“Hello World!”的页面。

系列图

下面是整个过程的序列图：

sequenceDiagram
    participant User
    participant Controller
    participant Velocity
    participant Template

    User->>Controller: GET /
    Controller->>Velocity: Create context
    Velocity->>Template: Render index.vm
    Template-->>Controller: Return rendered HTML
    Controller-->>User: Return HTML page