根据 FreeMarker 模板导出 PDF 文件 (基于 Spring Boot)

根据 FreeMarker 模板导出 PDF 文件

  • pom.xml 文件添加依赖
<dependency>
    <groupId>org.xhtmlrenderer</groupId>
    <artifactId>flying-saucer-pdf-openpdf</artifactId>
    <version>${flying-saucer.version}</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>${freemarker.version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context-support</artifactId>
	<version>${spring.version}</version>
</dependency>
  • 准备中文字体
  1. MacOS Mojave: “字体册” 中寻找合适字体(/System/Library/Fonts)
  2. Windows 10: “设置-个性化-字体” 中寻找合适字体(C:/Windows/Fonts)
  3. 在互联网上寻找合适字体(免费商业字体
  • PDF 导出工具类
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Map;

import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.ui.freemarker.SpringTemplateLoader;
import org.xhtmlrenderer.pdf.ITextFontResolver;
import org.xhtmlrenderer.pdf.ITextRenderer;

import com.lowagie.text.DocumentException;
import com.lowagie.text.pdf.BaseFont;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import freemarker.template.TemplateExceptionHandler;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
public class PDFUtil {

    private static Configuration cfg = null;

    // 导出到指定 PDF 路径
    public static void exportPDF(String html, String pdf, String... fonts) throws DocumentException, IOException, TemplateException {
        ITextRenderer renderer = new ITextRenderer();
        addFont(renderer, fonts);
        try (OutputStream os = new FileOutputStream(pdf)) {
            renderer.setDocumentFromString(html);
            renderer.layout();
            renderer.createPDF(os);
        }
    }

    // 解析 FreeMarker 模板
    public static String parseFreemarker(String freemarker, Map<String, Object> dataModel) throws IOException, TemplateException {
        if (cfg == null) {
            cfg = initConfiguration();
        }
        Template temp = cfg.getTemplate(freemarker);
        try (Writer out = new StringWriter()) {
            temp.process(dataModel, out);
            return out.toString();
        }
    }

    // 加载准备好的字体
    private static void addFont(ITextRenderer renderer, String... fonts) throws DocumentException, IOException {
        ITextFontResolver fontResolver = renderer.getFontResolver();
        for (String font : fonts) {
			fontResolver.addFont(font, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
		}
    }

    // 初始化 FreeMarker 配置
    private static Configuration initConfiguration() throws IOException {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_27);
        // 模板路径
        cfg.setTemplateLoader(new SpringTemplateLoader(new DefaultResourceLoader(), "classpath:/templates/"));
        cfg.setDefaultEncoding("UTF-8");
        cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
        cfg.setLogTemplateExceptions(false);
        cfg.setWrapUncheckedExceptions(true);
        return cfg;
    }

}
  • 准备模板(classpath:/templates/template.ftl
<!DOCTYPE html>
<html>
	<head>
		<link href="https://cdn.bootcss.com/twitter-bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet"></link>
		<style type="text/css">
			body {
				font-family: 'Microsoft YaHei';
			}
			@page {
				size: A4;
			}
			.pdf {
				max-width: 680px!important;
			}
			.container {
				margin-left: 0;
			}
		</style>
	</head>
	<body class="pdf">
		<div class="container pdf">
			<h1 class="pdf">根据 FreeMarker 模板导出 PDF 文件(基于 Spring Boot)</h1>
			<h2 class="pdf">作者:${author}</h2>
			<hr></hr>
			<h3 class="pdf">测试换行1测试换行2测试换行3测试换行4测试换行5测试换行6测试换行7测试换行测试换行9测试换行10测试换行11测试换行12测试换行</h3>
			<p class="pdf">
				<img src="https://avatar.csdn.net/6/1/D/3_sai_simon.jpg"></img>
				<br></br>
				<a href="${url}">文章地址</a>
			</p>
			<div class="pdf">&nbsp;</div>
		</div>
	</body>
</html>
  • 使用工具类导出
    public static void main(String[] args) throws IOException, TemplateException {
        // 数据模型
        Map<String, Object> dataModel = new HashMap<>();
        dataModel.put("author", "Saisimon");
        dataModel.put("url", "https://blog.csdn.net/sai_simon/article/details/98898380");
        // 解析 FreeMarker 模板
        String content = PDFUtil.parseFreemarker("template.ftl", dataModel);
        // 导出 PDF 文件路径
        String pdf = System.getProperty("user.home") + File.separator + "freemarker.pdf";
        // 微软雅黑字体
        String font = System.getProperty("user.home") + File.separator + "fonts" + File.separator + "msyh.ttf";
        // 导出到 PDF 文件
        PDFUtil.exportPDF(content, pdf, font);
    }
  • 注意事项
  1. FreeMarker 模板中的 HTML 标签必须严格按照 XML 的标准,每个标签必须有结束标签。<img></img><link></link><br></br><hr></hr><input></input>
  2. 加载的字体需要与样式中的 font-family 对应,否则中文不会显示
  • 导出效果
    在这里插入图片描述
  • 3
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
Spring Boot 中集成 Freemarker 导出 Excel,可以通过以下步骤实现: 1. 首先,需要在 Spring Boot 中添加 Freemarker 和 Apache POI 依赖: ```xml <dependencies> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>${freemarker.version}</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>${apache.poi.version}</version> </dependency> </dependencies> ``` 2. 创建 Excel 模板文件,可以使用 Freemarker模板语法来定义表头和数据内容,同时在模板中可以使用 `img` 标签来引用图片,例如: ```html <html> <head> <title>Excel Template</title> </head> <body> <table> <thead> <tr> <th>Name</th> <th>Age</th> <th>Photo</th> </tr> </thead> <tbody> <#list users as user> <tr> <td>${user.name}</td> <td>${user.age}</td> <td><img src="${user.photo}" /></td> </tr> </#list> </tbody> </table> </body> </html> ``` 其中,`users` 是一个包含数据的列表,每个元素是一个包含 `name`、`age` 和 `photo` 属性的对象,`photo` 属性是图片的 URL。 3. 在 Spring Boot 中定义一个控制器,用于处理导出 Excel 的请求: ```java @Controller public class ExcelController { @Autowired private Configuration freemarkerConfig; @GetMapping("/export") public void exportExcel(HttpServletResponse response) throws Exception { // 读取 Excel 模板文件 Template template = freemarkerConfig.getTemplate("excel-template.ftl"); // 准备数据 List<User> users = prepareData(); // 创建 Excel 工作簿 Workbook workbook = new XSSFWorkbook(); // 渲染模板,生成 Excel 文件 Map<String, Object> model = new HashMap<>(); model.put("users", users); StringWriter out = new StringWriter(); template.process(model, out); InputStream is = new ByteArrayInputStream(out.toString().getBytes("UTF-8")); workbook = WorkbookFactory.create(is); // 设置响应头,告诉浏览器文件类型是 Excel response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); response.setHeader("Content-disposition", "attachment; filename=users.xlsx"); // 将 Excel 文件写入响应流中 OutputStream os = response.getOutputStream(); workbook.write(os); os.flush(); os.close(); } private List<User> prepareData() { // TODO: 从数据库或其他来源读取数据 return Arrays.asList( new User("Alice", 25, "https://example.com/alice.jpg"), new User("Bob", 30, "https://example.com/bob.jpg"), new User("Charlie", 20, "https://example.com/charlie.jpg") ); } private static class User { private String name; private int age; private String photo; public User(String name, int age, String photo) { this.name = name; this.age = age; this.photo = photo; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public String getPhoto() { return photo; } public void setPhoto(String photo) { this.photo = photo; } } } ``` 在该控制器中,我们注入了 `Configuration` 类,它是 Freemarker 的配置类,用于加载 Excel 模板文件。在 `exportExcel` 方法中,我们先准备数据,然后通过 `template.process` 方法渲染模板,生成 Excel 文件。最后将 Excel 文件写入响应流中,浏览器会自动下载该文件。 4. 如果 Excel 模板中包含图片,那么需要在渲染模板之前,将图片下载到本地,然后将图片的本地路径传递给模板。例如: ```java private String downloadImage(String imageUrl) throws Exception { URL url = new URL(imageUrl); String fileName = url.getFile(); String filePath = "images/" + fileName.substring(fileName.lastIndexOf("/") + 1); FileUtils.copyURLToFile(url, new File(filePath)); return filePath; } @GetMapping("/export") public void exportExcel(HttpServletResponse response) throws Exception { // 读取 Excel 模板文件 Template template = freemarkerConfig.getTemplate("excel-template.ftl"); // 准备数据 List<User> users = prepareData(); // 下载图片并将本地路径传递给模板 for (User user : users) { String photoPath = downloadImage(user.getPhoto()); user.setPhoto(photoPath); } // 创建 Excel 工作簿 Workbook workbook = new XSSFWorkbook(); // 渲染模板,生成 Excel 文件 Map<String, Object> model = new HashMap<>(); model.put("users", users); StringWriter out = new StringWriter(); template.process(model, out); InputStream is = new ByteArrayInputStream(out.toString().getBytes("UTF-8")); workbook = WorkbookFactory.create(is); // 设置响应头,告诉浏览器文件类型是 Excel response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); response.setHeader("Content-disposition", "attachment; filename=users.xlsx"); // 将 Excel 文件写入响应流中 OutputStream os = response.getOutputStream(); workbook.write(os); os.flush(); os.close(); } ``` 在该示例中,我们定义了一个 `downloadImage` 方法,用于下载图片,并将图片保存到 `images` 目录下。然后在 `exportExcel` 方法中,遍历用户列表,调用 `downloadImage` 方法下载每个用户的图片,并将本地路径传递给模板。注意,模板中使用的图片路径应该和下载到本地的路径一致。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值