摘要:格式文档导出,是信息系统中非常实用的一种功能,用于各种报表和文档的到处。示例中,使用生成要导出的格式文档,通过来实现文件下载。将转换成文档生成的代码比较简单,创建一个对象,然后会在指定的中输入生成的文件。作用相当于在中使用进行配置。
PDF格式文档导出,是信息系统中非常实用的一种功能,用于各种报表和文档的到处。最近正好有空,用之前项目中使用过的itext做一个简单的示例,方便以后使用。示例中,使用Freemarker生成要导出的HTML格式文档,通过Spring Boot来实现PDF文件下载。
创建Gradle项目源代码:GitHub
需要在build.gradle中添加要引入的jar包,还有Gradle插件。主要有spring boot plugin和spring boot相关的包;freemarker,还有itextpdf,这里的itext-asian会引入中文支持。
buildscript { repositories { mavenLocal() mavenCentral() } dependencies { classpath("org.freemarker:freemarker:2.3.23") classpath("org.springframework.boot:spring-boot-gradle-plugin:1.4.0.RELEASE") } } ... ... dependencies { // tag::jetty[] compile("org.springframework.boot:spring-boot-starter-web") { exclude module: "spring-boot-starter-tomcat" } compile("org.springframework.boot:spring-boot-starter-jetty") // end::jetty[] // tag::actuator[] compile("org.springframework.boot:spring-boot-starter-actuator") compile("org.springframework.boot:spring-boot-starter-aop") compile("org.springframework:spring-context-support") compile "com.itextpdf:itextpdf:5.5.9" compile "com.itextpdf:itext-asian:5.2.0" compile "com.itextpdf.tool:xmlworker:5.5.9" compile "org.freemarker:freemarker:2.3.23" compile "javax.servlet:javax.servlet-api:3.1.0" testCompile (group: "junit", name: "junit", version: "4.12") testCompile("org.springframework.boot:spring-boot-starter-test") }用Freemarker来生成html字符串
freemarker是一种非常轻量易用的模板引擎,除了用于在web mvc框架中渲染html页面以外,还可以用在其他需要生成其他有复杂格式的文档,并且需要用数据进行格式化的场景下;将生成的字符串写入指定的Java流中。
public class FreemarkerUtils { public static String loadFtlHtml(File baseDir, String fileName,Map globalMap){ if(baseDir == null || !baseDir.isDirectory() || globalMap ==null || fileName == null || "".equals(fileName)){ throw new IllegalArgumentException("Directory file"); } Configuration cfg = new Configuration(Configuration.VERSION_2_3_22); try { cfg.setDirectoryForTemplateLoading(baseDir); cfg.setDefaultEncoding("UTF-8"); cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);//.RETHROW cfg.setClassicCompatible(true); Template temp = cfg.getTemplate(fileName); StringWriter stringWriter = new StringWriter(); temp.process(globalMap, stringWriter); return stringWriter.toString(); } catch (IOException | TemplateException e) { e.printStackTrace(); throw new RuntimeException("load fail file"); } } }
传入的参数是ftl文件的根目录和文件名,还有要用来格式化文档的数据。
itext将html转换成PDF文档itext生成PDF的代码比较简单,创建一个Document对象,然后XmlWorkerHelper会在指定的OutputStream中输入生成的pdf文件。
public static void savePdf(OutputStream out, String html) { Document document = new Document(PageSize.A4, 50, 50, 60, 60); try { PdfWriter writer = PdfWriter.getInstance(document, out); document.open(); XMLWorkerHelper.getInstance().parseXHtml(writer, document, new StringReader(html)); } catch (Exception e) { e.printStackTrace(); } finally { document.close(); } }
如果简单的实现文件下载的话,可以直接使用HttpServletResponse的OutputStream,就可以实现pdf下载,但是Spring MVC支持自定义View,使用Spring boot可以通过简单的配置实现对应功能。
集成Spring Boot实现文件下载Spring MVC通过继承基类AbstractView,可以实现自定义的View,在子类中,可以设置header,通过对输出流的操作,就可以实现在Java代码中调用需要的资源,输出对应的内容的功能。详细内容参看源代码。
@Override protected void renderMergedOutputModel(Mapmodel, HttpServletRequest request, HttpServletResponse response) throws Exception { // IE workaround: write into byte array first. ByteArrayOutputStream baos = createTemporaryOutputStream(); // Apply preferences and build metadata. Document document = newDocument(); PdfWriter writer = newWriter(document, baos); prepareWriter(model, writer, request); buildPdfMetadata(model, document, request); // Build PDF document. document.open(); buildPdfDocument(model, document, writer, request, response); document.close(); // Flush to HTTP response. writeToResponse(response, baos); } ...... protected void buildPdfDocument(Map model, Document document, PdfWriter writer, HttpServletRequest request, HttpServletResponse response) throws Exception { URL fileResource = FormPdfview.class.getResource("/templates"); String html = FreemarkerUtils.loadFtlHtml(new File(fileResource.getFile()), "simpleForm.ftl", model); XMLWorkerHelper.getInstance().parseXHtml(writer, document, new ByteArrayInputStream(html.getBytes()), Charset.forName("UTF-8"), new AsianFontProvider() ); }
为了能够在Spring MVC的控制器中通过MVC模式调用自定义的View对象,还需要进行一些配置;
首先,在WebMvcConfigurerAdapter的子类中,添加view resolver配置。作用相当于在spring mvc中使用xml进行配置。
@Bean public ResourceBundleViewResolver viewResolver() { ResourceBundleViewResolver resolver = new ResourceBundleViewResolver(); resolver.setOrder(1); resolver.setBasename("views"); return resolver; }
然后要在resources目录下创建一个views.properties文件,为我们自定义的view指定一个名字,就可以在controller中正常使用。
simplePDF.(class)=com.liuwill.text.view.Pdfview simpleFormPDF.(class)=com.liuwill.text.view.FormPdfview效果
下载源代码之后,执行gradle bootRun来运行Spring Boot,运行起来之后,访问 http://localhost:8888/download 查看结果。
文/liuwill(简书作者)
原文链接:Spring Boot集成Freemarker和iText生成PDF文档
著作权归作者所有,转载请联系作者获得授权,并标注“简书作者”。
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/66755.html
摘要:由于工作需要,要实现后端根据模板动态填充数据生成文档,通过技术选型,使用来设计模板,结合工具库来调用渲染生成文档。 由于工作需要,要实现后端根据模板动态填充数据生成PDF文档,通过技术选型,使用Ireport5.6来设计模板,结合JasperReports5.6工具库来调用渲染生成PDF文档。本人文采欠缺,写作能力差,下面粗略的介绍其使用步骤,若有不对的地方,望大家莫喷,谢谢! 一、使...
摘要:一需求说明根据业务需要,需要在服务器端生成可动态配置的文档,方便数据可视化查看。能配置动态的模板,正好解决了样式动态渲染和排版问题。包负责模板之外的额外信息填写,这里主要是页眉页脚的定制。包的画图工具包,目前只有一个线形图。 一、需求说明:根据业务需要,需要在服务器端生成可动态配置的PDF文档,方便数据可视化查看。 二、解决方案:iText+FreeMarker+JFreeChart生...
摘要:一需求说明根据业务需要,需要在服务器端生成可动态配置的文档,方便数据可视化查看。能配置动态的模板,正好解决了样式动态渲染和排版问题。包负责模板之外的额外信息填写,这里主要是页眉页脚的定制。包的画图工具包,目前只有一个线形图。 一、需求说明:根据业务需要,需要在服务器端生成可动态配置的PDF文档,方便数据可视化查看。 二、解决方案:iText+FreeMarker+JFreeChart生...
摘要:日期和时间处理日期和时间的函数库。使用中可观察序列,创建异步基于事件应用程序的函数库。为分布式系统提供延迟和容错处理。发布使用本机格式分发应用程序的工具。将程序资源和打包成和的本机文件。图像处理用来帮助创建评估或操作图形的函数库。 好资源要分享原文 译者 唐尤华 翻译自 github akullpp 构建 这里搜集了用来构建应用程序的工具。 Apache Maven:Mave...
摘要:数据和信息是不可分离的,数据是信息的表达,信息是数据的内涵。数据本身没有意义,数据只有对实体行为产生影响时才成为信息。主要目标是为开发提供天然的模板,并且能在里面准确的显示。目前是自然更加推荐。 这是泥瓦匠的第105篇原创 文章工程: JDK 1.8 Maven 3.5.2 Spring Boot 2.1.3.RELEASE 工程名:springboot-webflux-4-thym...
阅读 1216·2021-11-23 09:51
阅读 1589·2021-11-16 11:45
阅读 3919·2021-10-09 09:43
阅读 2631·2021-07-22 16:47
阅读 913·2019-08-27 10:55
阅读 3375·2019-08-26 17:40
阅读 3041·2019-08-26 11:39
阅读 3188·2019-08-23 18:39