使用 Velocity 模板引擎的 Spring Boot 应用

╰+哭是因爲堅強的太久メ 2023-10-16 16:23 64阅读 0赞

## 使用 Velocity 模板引擎的 Spring Boot 应用 ##

模板引擎是构建动态内容的重要工具，特别适用于生成HTML、邮件内容、报告和其他文本文档。Velocity是一个强大的模板引擎，它具有简单易用的语法和灵活性。本文将介绍如何在Spring Boot应用中使用Velocity模板引擎，并提供示例代码。

![在这里插入图片描述][cd65311996ba4949b4cd5139ea3e8b4b.png]

### Velocity 简介 ###

Velocity是一个用于生成文本输出的模板引擎。它是一种轻量级的、开源的工具，最初由Apache开发。Velocity的主要特点包括：

*  **简单的语法：** Velocity使用简单的模板语法，易于学习和使用。
 *  **灵活性：** Velocity允许在模板中嵌套、迭代和使用条件语句，以便生成复杂的输出。
 *  **模板重用：** 模板可以被多次重用，从而减少了重复代码。
 *  **可扩展性：** Velocity可以与Java代码集成，允许在模板中调用Java方法。
 *  **广泛支持：** Velocity可以用于生成HTML、XML、JSON等多种文本格式。

### 创建 Spring Boot 项目 ###

首先，确保您已经安装了Java开发环境和Maven。接下来，您可以使用Spring Initializer创建一个新的Spring Boot项目。在[https://start.spring.io/][https_start.spring.io]上选择您的项目配置，然后生成项目并下载。

### 添加 Velocity 依赖 ###

在生成的项目中，您需要添加Velocity的依赖。在`pom.xml`文件中，确保以下依赖项已经添加：

<dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.3.1</version>
    </dependency>

这将包括Velocity所需的所有依赖。

### 创建 Velocity 模板 ###

接下来，您需要创建一个Velocity模板。在`src/main/resources/templates`目录中，创建一个名为`hello.vm`的Velocity模板文件：

<!DOCTYPE html>
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Hello Velocity</title>
    </head>
    <body>
        <h1>Hello, $name!</h1>
    </body>
    </html>

在上述模板中，我们定义了一个简单的HTML页面，使用Velocity语法插入了一个变量`$name`。

### 创建控制器 ###

现在，您可以创建一个控制器来处理Velocity模板的渲染。在`src/main/java/com/example/demo`包中创建一个名为`HelloController`的类：

import org.apache.velocity.Template;
    import org.apache.velocity.VelocityContext;
    import org.apache.velocity.app.VelocityEngine;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.GetMapping;
    
    import javax.annotation.PostConstruct;
    import java.io.StringWriter;
    
    @Controller
    public class HelloController {
        
    
        private final VelocityEngine velocityEngine;
    
        public HelloController(VelocityEngine velocityEngine) {
        
            this.velocityEngine = velocityEngine;
        }
    
        @PostConstruct
        public void init() {
        
            velocityEngine.init();
        }
    
        @GetMapping("/hello")
        public String hello(Model model) {
        
            VelocityContext velocityContext = new VelocityContext();
            velocityContext.put("name", "Spring Boot with Velocity");
            
            Template template = velocityEngine.getTemplate("templates/hello.vm");
            StringWriter stringWriter = new StringWriter();
            template.merge(velocityContext, stringWriter);
            
            model.addAttribute("htmlContent", stringWriter.toString());
            return "hello";
        }
    }

在上述代码中，我们创建了一个`HelloController`，它使用Velocity引擎来渲染`hello.vm`模板。在`init`方法中，我们初始化了Velocity引擎。在`hello`方法中，我们创建了一个`VelocityContext`并将`name`变量传递给模板。然后，我们获取模板并将模板内容合并到`stringWriter`中，最后将HTML内容添加到模型中。

### 创建模板渲染视图 ###

为了显示Velocity模板渲染的内容，我们需要创建一个模板渲染视图。在`src/main/resources/templates`目录中，创建一个名为`hello.html`的HTML文件：

<!DOCTYPE html>
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Hello Velocity</title>
    </head>
    <body>
        <div th:utext="${htmlContent}"></div>
    </body>
    </html>

在上述HTML文件中，我们使用Thymeleaf的`th:utext`属性来渲染HTML内容，该内容存储在`${htmlContent}`变量中。

### 配置 Velocity 属性 ###

最后，您需要在`application.properties`文件中添加Velocity属性配置：

# Velocity Configuration
    spring.velocity.resource-loader-path=classpath:/templates/
    spring.velocity.suffix=.vm

这些配置告诉Spring Boot在`classpath:/templates/`目录中查找Velocity模板文件，并指定了模板文件的后缀。

### 运行应用程序 ###

现在，您可以运行应用程序了。使用Maven命令：

mvn spring-boot:run

您的Spring Boot应用程序将启动并运行在默认端口（通常是8080）上。

### 访问 Velocity 模板 ###

使用浏览器访问`http://localhost:8080/hello`，您将看到Velocity模板渲染的页面，页面上将显示"Hello, Spring Boot with Velocity!"。

### 总结 ###

本文介绍了如何在Spring Boot应用程序中使用Velocity模板引擎来生成动态内容。Velocity是一个强大的模板引擎，适用于生成HTML、XML、JSON等多种文本格式的内容。通过配置Velocity引擎、创建模板和控制器，您可以轻松地将Velocity集成到Spring Boot应用中。

以上是使用Velocity模板引擎的示例。希望这篇文章对您有所帮助，让您更好地了解如何在Spring Boot应用程序中使用Velocity来生成动态内容

[cd65311996ba4949b4cd5139ea3e8b4b.png]: https://img-blog.csdnimg.cn/cd65311996ba4949b4cd5139ea3e8b4b.png
[https_start.spring.io]: https://start.spring.io/