您的位置:

Java模板引擎的全面解析

一、介绍

Java模板引擎是一个让开发人员能够方便快捷地生成文本的框架。它将预设的文本固定部分以及动态生成的数据部分混合起来,最终呈现出一个带有数据的文本。Java模板引擎是基于模板开发的,其中包含:

  • 写死的文本
  • 可以被动态替换的表达式
  • 一些模板语言特定的符号,用于控制表达式的使用

二、使用场景

Java模板引擎在各种场景下都可以被应用:

  • Web开发中,用于渲染HTML文档
  • 邮件模板中,用于填写邮件的内容
  • Word文档中,用于控制文档格式及内容的生成

三、主要的Java模板引擎

目前市面上主要的Java模板引擎有:

  • FreeMarker: FreeMarker是一个强大、灵活的模板引擎,使用范围广泛,特别适用于处理较大的项目。它具有良好的性能,提供了完整的指令,包括条件语句,迭代,表达式等。
  • Thymeleaf:Thymeleaf是一种现代的、服务器端的Java模板引擎,代码更易读,并且具有很好的扩展性和潜力。Thymeleaf支持HTML,XML,JavaScript,CSS甚至纯文本。
  • Velocity: Velocity是一种模板引擎,用于完全分离Web设计与程序开发。与其他Java模板引擎相比,它有一个更小的语法集和更少的语言操作,而且更容易上手,是为初学者而设的。

四、FreeMarker用法示例

1、添加依赖

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

2、编写模板

以下是一个简单的模板示例:

<html>
<head>
    <title>User Information</title>
</head>
<body>
    <p>Username: ${user.username}</p>
    <p>Email: ${user.email}</p>
</body>
</html>

3、填充数据

在代码中填充数据:

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;

public class FreemarkerDemo {

    public static void main(String[] args) throws IOException, TemplateException {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
        cfg.setDirectoryForTemplateLoading(new File("src/main/resources/templates"));
        cfg.setDefaultEncoding("UTF-8");
        Template temp = cfg.getTemplate("user.ftl");
        Map root = new HashMap<>();
        User user = new User("John", "john@gmail.com");
        root.put("user", user);
        PrintWriter out = new PrintWriter("output.html");
        temp.process(root, out);
    }
}

  

五、Thymeleaf用法示例

1、添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

2、编写模板

以下是一个简单的模板示例:

<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>User Information</title>
</head>
<body>
    <p>Username: <span th:text="${user.username}"></span></p>
    <p>Email: <span th:text="${user.email}"></span></p>
</body>
</html>

3、填充数据

在代码中填充数据:

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/users")
public class UserController {

    @GetMapping("/show")
    public String show(Model model) {
        User user = new User("John", "john@gmail.com");
        model.addAttribute("user", user);
        return "user";
    }
}

六、Velocity用法示例

1、添加依赖

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

2、编写模板

以下是一个简单的模板示例:

<html>
<head>
    <title>User Information</title>
</head>
<body>
    <p>Username: $user.username</p>
    <p>Email: $user.email</p>
</body>
</html>

3、填充数据

在代码中填充数据:

import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;

import java.io.StringWriter;

public class VelocityDemo {

    public static void main(String[] args) throws Exception {
        VelocityEngine ve = new VelocityEngine();
        ve.init();
        Template t = ve.getTemplate("user.vm");
        VelocityContext ctx = new VelocityContext();
        User user = new User("John", "john@gmail.com");
        ctx.put("user", user);
        StringWriter writer = new StringWriter();
        t.merge(ctx, writer);
        System.out.println(writer.toString());
    }
}

七、总结

Java模板引擎是一个功能强大的工具,可以帮助开发人员以一种高效的方式生成文本。在本文中,我们介绍了Java模板引擎的用法,并提供了主要的Java模板引擎示例。通过本文的学习,相信读者已经掌握了Java模板引擎的核心概念,能够根据实际项目的需求选择最适合的模板引擎,提高开发效率。