首页 > 软件编程 > java > springboot 渲染html

springboot 如何通过SpringTemplateEngine渲染html

2024-10-26 11:17:10 作者：abments

通过Spring的Thymeleaf模板引擎可以实现将模板渲染为HTML字符串,而不是直接输出到浏览器,这样可以对渲染后的字符串进行其他操作,如保存到文件或进一步处理,感兴趣的朋友跟随小编一起看看吧

要单独获取到渲染后的 HTML 字符串，便于进行其他操作，可以通过以下几种方式实现。常见的用法是通过 Spring 的 Thymeleaf 模板引擎渲染模板为 HTML 字符串，而不是直接将其输出到浏览器。这样你就可以对渲染后的字符串进行其他操作，比如保存到文件或进一步处理。

1. 使用 Thymeleaf 渲染为字符串

你可以使用 Thymeleaf 的 TemplateEngine 手动渲染模板为字符串。需要通过 TemplateEngine 渲染模板文件，并且将渲染后的 HTML 作为一个字符串返回。你可以创建一个自定义的服务来处理这个需求。

1.1 添加依赖

除了 Thymeleaf 依赖之外，还需要确保有 Spring Web 和 Thymeleaf 依赖在 pom.xml 中：

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

1.2 自定义服务类渲染 Thymeleaf 模板为字符串

import org.springframework.stereotype.Service;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;
import java.util.Map;
@Service
public class HtmlRenderingService {
    private final TemplateEngine templateEngine;
    public HtmlRenderingService(TemplateEngine templateEngine) {
        this.templateEngine = templateEngine;
    }
    public String renderHtml(String templateName, Map<String, Object> variables) {
        // 创建一个上下文对象
        Context context = new Context();
        // 将传递的变量设置到上下文
        context.setVariables(variables);
        // 渲染指定模板为字符串
        return templateEngine.process(templateName, context);
    }
}

templateEngine.process() 会根据提供的模板名称和上下文变量，渲染出最终的 HTML 字符串。
variables 是一个 Map 对象，用于传递到模板中的变量。

1.3 控制器调用服务类渲染 HTML 字符串

你可以在控制器中调用这个服务，将模板渲染为字符串，并执行你想要的操作（如返回、保存、日志等）。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
@RestController
public class HtmlRenderController {
    @Autowired
    private HtmlRenderingService htmlRenderingService;
    @GetMapping("/render-html")
    public String renderHtml() {
        // 假设要传递的热点资源和推荐资源数据
        HotResource hotResource = new HotResource("热点资源1", "12345", "67890");
        Map<String, Object> variables = new HashMap<>();
        variables.put("hotResource", hotResource);
        return htmlRenderingService.renderHtml("resources", variables);
    }
}

在上面的代码中，当你访问 /render-html 这个接口时，控制器会调用 HtmlRenderingService 服务，将 resources.html 模板渲染为字符串并返回。

1.4 Thymeleaf 模板文件 (resources.html)

你可以使用和之前一样的 Thymeleaf 模板文件进行动态渲染，例如：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>资源推荐</title>
    <!-- 样式略 -->
</head>
<body>
    <div class="container">
        <div class="section">
            <h2>热点资源</h2>
            <div class="item hot-resource">
                <a th:href="@{/resource/hot(id=${hotResource.resourceId})}" rel="external nofollow"  target="_blank" th:text="${hotResource.name}">热点资源名称</a>
                <p th:text="'资源ID：' + ${hotResource.resourceId}">资源ID</p>
                <p th:text="'热点记录ID：' + ${hotResource.recordId}">热点记录ID</p>
            </div>
        </div>
    </div>
</body>
</html>

2. 渲染 HTML 后进行其他操作

通过上述方式获取的 HTML 字符串，你可以在控制器中进行任意操作：

返回 HTML 字符串：直接返回渲染后的 HTML 字符串给前端。
保存 HTML 文件：将 HTML 字符串保存到服务器上的某个文件。
传递到其他服务：你可以将这个字符串发送到其他服务或系统。

例如，将渲染后的 HTML 保存为文件：

import java.io.FileWriter;
import java.io.IOException;
public class HtmlFileWriter {
    public static void saveHtmlToFile(String htmlContent, String filePath) throws IOException {
        FileWriter fileWriter = new FileWriter(filePath);
        fileWriter.write(htmlContent);
        fileWriter.close();
    }
}

在控制器中调用这个方法：

@GetMapping("/save-html")
public String saveHtmlToFile() {
    HotResource hotResource = new HotResource("热点资源1", "12345", "67890");
    Map<String, Object> variables = new HashMap<>();
    variables.put("hotResource", hotResource);
    String renderedHtml = htmlRenderingService.renderHtml("resources", variables);
    try {
        HtmlFileWriter.saveHtmlToFile(renderedHtml, "/path/to/save/file.html");
        return "HTML file saved successfully!";
    } catch (IOException e) {
        e.printStackTrace();
        return "Failed to save HTML file!";
    }
}

总结

通过上述方案，你可以：

动态渲染 HTML 页面为字符串。
根据需要返回 HTML 字符串、保存到文件或进行其他处理。

使用 Thymeleaf 渲染为字符串的方式非常灵活，适合你进行更多自定义操作。

到此这篇关于springboot 通过SpringTemplateEngine渲染html的文章就介绍到这了,更多相关springboot 渲染html内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！