SpringBoot集成JasperReports实现PDF、HTML、XML的一键生成

JasperReports 是一个基于 Java 的开源报表工具支持多种输出格式如 PDF、HTML、XML 等广泛应用于 Java 开发中生成动态报表‌。本文将完整演示如何在 Spring Boot 项目中整合 JasperReports从环境配置、模板设计到接口开发逐步实现用户数据报表的导出。核心原理‌工作流程‌‌JRXML‌XML 格式的报表模板文件通过设计器如 Jaspersoft Studio创建‌。‌Jasper‌编译 JRXML 生成的二进制文件用于数据填充‌。‌Jrprint‌填充数据后的报表对象最终通过导出器生成目标格式文件‌。‌技术特点‌支持多种数据源JDBC、JavaBeans、XML 等‌。可生成带水印的报表和子报表。集成JasperReports步骤项目目录结构引入依赖在pom.xml中添加 JasperReports 相关依赖12345678910111213141516171819202122232425262728293031dependencies!-- JasperReports 核心依赖 --dependencygroupIdnet.sf.jasperreports/groupIdartifactIdjasperreports/artifactIdversion7.0.3/version/dependency!-- JasperReports PDF 支持 --dependencygroupIdnet.sf.jasperreports/groupIdartifactIdjasperreports-pdf/artifactIdversion7.0.3/version/dependency!-- Spring Boot Web --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependency!-- Lombok 简化实体类代码 --dependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactIdoptionaltrue/optional/dependency/dependencies核心代码实现启动类12345678910111213packagecom.icoderoad;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;SpringBootApplicationpublicclassSpringbootJasperreportApplication {publicstaticvoidmain(String[] args) {SpringApplication.run(SpringbootJasperreportApplication.class, args);}}User 实体类123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263packagecom.icoderoad.entity;publicclassUser {privateLong id;privateString name;privateInteger age;privateString email;privateString address;publicUser(Long id, String name, Integer age, String email, String address) {this.id id;this.name name;this.age age;this.email email;this.address address;}publicUser() {}// Getter 和 SetterpublicLong getId() {returnid;}publicvoidsetId(Long id) {this.id id;}publicString getName() {returnname;}publicvoidsetName(String name) {this.name name;}publicInteger getAge() {returnage;}publicvoidsetAge(Integer age) {this.age age;}publicString getEmail() {returnemail;}publicvoidsetEmail(String email) {this.email email;}publicString getAddress() {returnaddress;}publicvoidsetAddress(String address) {this.address address;}}报表生成工具类123456789101112131415161718192021222324252627282930313233343536373839404142434445packagecom.icoderoad.report;importcom.icoderoad.entity.User;importnet.sf.jasperreports.engine.*;importnet.sf.jasperreports.engine.data.JRBeanCollectionDataSource;importorg.springframework.core.io.ClassPathResource;importjava.nio.file.Files;importjava.nio.file.Paths;importjava.util.*;publicclassReportGenerator {publicstaticbyte[] generate(ListUser users, String format)throwsException {// 1. 加载并编译报表模板ClassPathResource resource newClassPathResource(templates/user.jrxml);JasperReport jasperReport JasperCompileManager.compileReport(resource.getInputStream());// 2. 准备数据源和参数JRBeanCollectionDataSource dataSource newJRBeanCollectionDataSource(users);MapString, Object parameters newHashMap();parameters.put(title,用户列表);JasperPrint jasperPrint JasperFillManager.fillReport(jasperReport, parameters, dataSource);// 3. 导出不同格式returnswitch(format) {casepdf- JasperExportManager.exportReportToPdf(jasperPrint);casexml- JasperExportManager.exportReportToXml(jasperPrint).getBytes();casehtml- {String path /tmp/user.html;JasperExportManager.exportReportToHtmlFile(jasperPrint, path);yield Files.readAllBytes(Paths.get(path));}default-thrownewIllegalArgumentException(不支持的格式: format);};}}控制层1234567891011121314151617181920212223242526272829303132333435363738394041424344packagecom.icoderoad.controller;importcom.icoderoad.entity.User;importcom.icoderoad.report.ReportGenerator;importorg.springframework.core.io.ByteArrayResource;importorg.springframework.core.io.Resource;importorg.springframework.http.*;importorg.springframework.web.bind.annotation.*;importjava.util.*;RestControllerRequestMapping(/users)publicclassReportController {GetMapping(/export/{format})publicResponseEntityResource export(PathVariableString format)throwsException {// 模拟数据ListUser users newArrayList();for(inti 0; i 10; i) {users.add(newUser((long) i,姓名- i,newRandom().nextInt(100),i qq.com,地址- i));}// 生成报表byte[] content ReportGenerator.generate(users, format);ByteArrayResource resource newByteArrayResource(content);returnResponseEntity.ok().contentType(MediaType.APPLICATION_OCTET_STREAM).header(HttpHeaders.CONTENT_DISPOSITION,ContentDisposition.attachment().filename(user-report. format).build().toString()).contentLength(resource.contentLength()).body(resource);}}配置文件12345server:port:8080spring:application:name: springboot-jasperreport-demojasperreports.properties12net.sf.jasperreports.extension.registry.factory.simple.font.familiesnet.sf.jasperreports.engine.fonts.SimpleFontExtensionsRegistryFactorynet.sf.jasperreports.extension.simple.font.families.simheifonts/fonts.xml首先在 Linux 系统中将 Windows 的黑体字体文件simhei.ttf拷贝到项目目录1src/main/resources/fonts/simhei.ttf1fonts/fonts.xml123456789101112131415?xml versinotallow1.0encodingUTF-8?fontFamiliesfontFamily name黑体normalfonts/simhei.ttf/normalboldfonts/simhei.ttf/bolditalicfonts/simhei.ttf/italicboldItalicfonts/simhei.ttf/boldItalicpdfEncodingIdentity-H/pdfEncodingpdfEmbeddedtrue/pdfEmbeddedexportFontsexport keynet.sf.jasperreports.html黑体, Arial, Helvetica, sans-serif/exportexport keynet.sf.jasperreports.xhtml黑体, Arial, Helvetica, sans-serif/export/exportFonts/fontFamily/fontFamiliesuser.jrxml 示例模板12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061?xml versinotallow1.0encodingUTF-8?!-- 用户列表报表模板 --jasperReport xmlnshttp://jasperreports.sourceforge.net/jasperreportsxmlns:xsihttp://www.w3.org/2001/XMLSchema-instancexsi:schemaLocationhttp://jasperreports.sourceforge.net/jasperreportshttp://jasperreports.sourceforge.net/xsd/jasperreport.xsdnameuser_reportpageWidth595pageHeight842columnWidth555leftMargin20rightMargin20topMargin20bottomMargin20uuid123e4567-e89b-12d3-a456-426614174000!-- 报表参数 --parameter nametitleclassjava.lang.String/!-- 字段定义 --field nameidclassjava.lang.Long/field namenameclassjava.lang.String/field nameageclassjava.lang.Integer/field nameemailclassjava.lang.String/field nameaddressclassjava.lang.String/!-- 报表标题 --titleband height50staticTextreportElement x0y10width555height30/textElement textAlignmentCenterfont fontName黑体size16isBoldtrue//textElementtext![CDATA[$P{title}]]/text/staticText/band/title!-- 表头 --columnHeaderband height20staticTextreportElement x0y0width50height20/text![CDATA[ID]]/text/staticTextstaticTextreportElement x50y0width100height20/text![CDATA[姓名]]/text/staticTextstaticTextreportElement x150y0width50height20/text![CDATA[年龄]]/text/staticTextstaticTextreportElement x200y0width150height20/text![CDATA[邮箱]]/text/staticTextstaticTextreportElement x350y0width205height20/text![CDATA[地址]]/text/staticText/band/columnHeader!-- 数据体 --detailband height20textFieldreportElement x0y0width50height20/textFieldExpression![CDATA[$F{id}]]/textFieldExpression/textFieldtextFieldreportElement x50y0width100height20/textFieldExpression![CDATA[$F{name}]]/textFieldExpression/textFieldtextFieldreportElement x150y0width50height20/textFieldExpression![CDATA[$F{age}]]/textFieldExpression/textFieldtextFieldreportElement x200y0width150height20/textFieldExpression![CDATA[$F{email}]]/textFieldExpression/textFieldtextFieldreportElement x350y0width205height20/textFieldExpression![CDATA[$F{address}]]/textFieldExpression/textField/band/detail/jasperReport测试接口启动服务后分别访问以下地址即可获取不同格式的报表PDF 报表http://localhost:8080/users/export/pdfXML 报表http://localhost:8080/users/export/xmlHTML 报表http://localhost:8080/users/export/html结论通过本文的实践我们基于Spring Boot JasperReports搭建了一套完整的报表生成解决方案实现了PDF、HTML、XML的多格式一键导出。整个过程涵盖了依赖引入、字体配置、模板设计、数据填充、接口实现等关键环节。