JasperReport：报表概述和模板制作

缺乏、安全感 2023-07-21 11:07 1阅读 0赞

### 文章目录 ###

*  一、报表概述
 *  二、JasperReport
 *   *  2.1 框架介绍
     *  2.2 相关文件介绍
     *  2.3 开发流程概述
 *  三、模板工具Jaspersoft Studio
 *   *  3.1 Jaspersoft Studio 安装
     *  3.2 面板介绍
 *  四、第一个 JasperReport 案例

# 一、报表概述 #

> 在企业级应用开发中，报表生成、报表打印下载是其重要的一个环节。除了`Excel`报表之外，`PDF`报表也有广泛的应用场景，必须用户详细资料，用户简历等

目前世面上比较流行的制作`PDF`报表的工具如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>iText PDF</td> 
   <td>iText是著名的开放项目，是用于生成PDF文档的一个java类库。通过iText不仅可以生成PDF或rtf的文档，而且可以将XML、Html文件转化为PDF文件。</td> 
  </tr> 
  <tr> 
   <td>Openoffice</td> 
   <td>openoffice是开源软件且能在windows和linux平台下运行，可以灵活的将word或者Excel转化为PDF文档。</td> 
  </tr> 
  <tr> 
   <td>Jasper Report</td> 
   <td>是一个强大、灵活的报表生成工具，能够展示丰富的页面内容，并将之转换成PDF</td> 
  </tr> 
 </tbody> 
</table>

# 二、JasperReport #

## 2.1 框架介绍 ##

`JasperReport`是一个强大、灵活的报表生成工具，能够展示丰富的页面内容，并将之转换成`PDF`，`HTML`，或者`XML`格式。该库完全由`Java`写成，可以用于在各种`Java`应用程序，包括`J2EE`，`Web`应用程序中生成动态内容。只需要将`JasperReport`引入工程中即可完成`PDF`报表的编译、显示、输出等工作。

在开源的`JAVA`报表工具中，`JASPER Report`发展是比较好的，比一些商业的报表引擎做得还好，如支持了十字交叉报表、统计报表、图形报表，支持多种报表格式的输出，如`PDF`、`RTF`、`XML`、`CSV`、`XHTML`、`TEXT`、`DOCX`以`OpenOffice`。

数据源支持更多，常用 `JDBC SQL`查询、`XML`文件、`CSV`文件 、`HQL（Hibernate查询）`，`HBase`，`JAVA`集合等。还允许你义自己的数据源，通过`JASPER`文件及数据源，`JASPER`就能生成最终用户想要的文档格式。

## 2.2 相关文件介绍 ##

1.  **JRXML**：报表填充模板，本质是一个`XML`. `JasperReport`已经封装了一个`dtd`，只要按照规定的格式写这个`xml`文件，那么`jasperReport`就可以将其解析最终生成报表，但是`jasperReport`所解析的不是我们常见的`.xml`文件，而是`.jrxml`文件，其实跟xml是一样的，只是后缀不一样。
2.  **Jasper**：由`JRXML`模板编译生成的二进制文件，用于代码填充数据。解析完成后`JasperReport`就开始编译`.jrxml`文件，将其编译成`.jasper`文件，因为`JasperReport`只可以对`.jasper`文件进行填充数据和转换，这步操作就跟我们`java`中将java文件编译成`class`文件是一样的
3.  **Jrprint**：当用数据填充完`Jasper`后生成的文件，用于输出报表。这一步才是`JasperReport`的核心所在，它会根据你在`xml`里面写好的查询语句来查询指定是数据库，也可以控制在后台编写查询语句，参数，数据库。在报表填充完后，会再生成一个`.jrprint`格式的文件（读取`jasper`文件进行填充，然后生成一个`jrprint`文件）
4.  **Exporter**：决定要输出的报表为何种格式，报表输出的管理类。

## 2.3 开发流程概述 ##

![在这里插入图片描述][20200403153002731.png]

# 三、模板工具Jaspersoft Studio #

`Jaspersoft Studio`是`JasperReports`库和`JasperReports`服务器的基于`Eclipse`的报告设计器; 它可以作为`Eclipse`插件或作为独立的应用程序使用。`Jaspersoft Studio`允许您创建包含图表，图像，子报表，交叉表等的复杂布局。您可以通过`JDBC`，`TableModels`，`JavaBeans`，`XML`，`Hibernate`，`大数据（如Hive）`，`CSV`，`XML / A`以及自定义来源等各种来源访问数据，然后将报告发布为`PDF`，`RTF`，`XML`，`XLS`，`CSV`，`HTML`，`XHTML`，文本，`DOCX`或`OpenOffice`。

`Jaspersoft Studio` 是一个可视化的报表设计工具,使用该软件可以方便地对报表进行可视化的设计，设计结果为格式`.jrxml`的`XML` 文件，并且可以把`.jrxml`文件编译成`.jasper`格式文件方便`JasperReport`报表引擎解析、显示。

## 3.1 Jaspersoft Studio 安装 ##

`STS`中`Marketplace`搜索`Jaspersoft Studio`安装即可。  
![安装Jasper Studio][Jasper Studio]

## 3.2 面板介绍 ##

左侧切换`outline`视图，调整视图的位置  
![jasper面板介绍][jasper]  
**主面板**介绍：

<table> 
 <thead> 
  <tr> 
   <th>区域</th> 
   <th align="left">简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Report editing area（主编辑区域）</td> 
   <td align="left">通过拖动，定位，对齐和通过 Designer palette（设计器调色板）对报表元素调整大小</td> 
  </tr> 
  <tr> 
   <td>Editor Area</td> 
   <td align="left">Design tab: 当你打开一个报告文件，它允许您以图形方式创建报表选中<br>Source tab： 包含用于报表的 JRXML 源代码。<br>Preview tab： 允许在选择数据源和输出格式后，运行报表预览。</td> 
  </tr> 
  <tr> 
   <td>Repository Explorer view</td> 
   <td align="left">包含 JasperServer 生成的连接和可用的数据适配器列表</td> 
  </tr> 
  <tr> 
   <td>Outline view</td> 
   <td align="left">在大纲视图中显示了一个树的形式的方式报告的完整结构</td> 
  </tr> 
  <tr> 
   <td>Properties view</td> 
   <td align="left">控件属性设置</td> 
  </tr> 
  <tr> 
   <td>Design tab</td> 
   <td align="left">以图形方式创建报表中的控件</td> 
  </tr> 
 </tbody> 
</table>

**Report Editor Area**介绍  
![在这里插入图片描述][20200403174538577.png]

<table> 
 <thead> 
  <tr> 
   <th align="left">区域</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Title</td> 
   <td>标题:只在整个报表的第一页的最上端显示。只在第一页显示，其他页面均不显示</td> 
  </tr> 
  <tr> 
   <td align="left">Page Header</td> 
   <td>页头:在整个报表中每一页都会显示。在第一页中，出现的位置在 Title Band的下面。在除了第一页的其他页面中Page Header 的内容均在页面的最上端显示。</td> 
  </tr> 
  <tr> 
   <td align="left">Page Footer</td> 
   <td>页脚: 在整个报表中每一页都会显示。显示在页面的最下端。一般用来显示页码。</td> 
  </tr> 
  <tr> 
   <td align="left">Detail 1</td> 
   <td>详细 ： 报表内容，每一页都会显示。</td> 
  </tr> 
  <tr> 
   <td align="left">Column Header</td> 
   <td>列头: Detail中打印的是一张表的话，这Column Header就是表中列的列头。</td> 
  </tr> 
  <tr> 
   <td align="left">Column Footer</td> 
   <td>列脚 :Detail中打印的是一张表的话，这Column Footer就是表中列的列脚。</td> 
  </tr> 
  <tr> 
   <td align="left">Summary</td> 
   <td>统计: 表格的合计段，出现在整个报表的最后一页中，在Detail 1 Band后面。主要是用来做报表的合计显示。</td> 
  </tr> 
 </tbody> 
</table>

# 四、第一个 JasperReport 案例 #

**① 引入依赖**

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.13.RELEASE</version>
        <relativePath /> 
    </parent>
    
    <dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		
    		<dependency>
    			<groupId>net.sf.jasperreports</groupId>
    			<artifactId>jasperreports</artifactId>
    			<version>6.5.0</version>
    		</dependency>
    		<dependency>
    			<groupId>org.olap4j</groupId>
    			<artifactId>olap4j</artifactId>
    			<version>1.2.0</version>
    		</dependency>
    		<dependency>
    			<groupId>com.lowagie</groupId>
    			<artifactId>itext</artifactId>
    			<version>2.1.7</version>
    		</dependency>
    		
    </dependencies>

**② 引入配置文件**

spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver
    spring.datasource.url=jdbc:oracle:thin:@127.0.0.1:1521/oracle
    spring.datasource.username=scott
    spring.datasource.password=1234

**③ 模板制作**

1.  创建`jasper`文件：`File` \-> `New` \-> `Jasper Report`
2.  删除不需要的`band`,添加两个`Static Text`到`Column Header`,命名为`ID`和`用户名`，`用户名`这个`Static Text`需设置为中文字体，否则无法显示，最后设置`Border`  
    ![在这里插入图片描述][20200403175600946.png]
3.  点击`Compile Repot`生成`Jasper`文件  
    ![在这里插入图片描述][20200403175941215.png]
4.  创建测试`controller`

/** * JasperReport的简单使用 */
    @RequestMapping("/test1")
    public void createHtml(HttpServletResponse response, HttpServletRequest request) throws Exception { 
    	Resource resource = new ClassPathResource("templates/demo.jasper");
    	FileInputStream is = new FileInputStream(resource.getFile());
    	ServletOutputStream os = response.getOutputStream();
    	try { 
    		/** * 创建JasperPrint对象 * 数据填充 * is:inputstream params：参数填充 DataSource：数据源填充 */
    		JasperPrint jasperPrint = JasperFillManager.fillReport(is, new HashMap<>(), new JREmptyDataSource());
    		// 写入pdf数据
    		JasperExportManager.exportReportToPdfStream(jasperPrint, os);
    	} finally { 
    		os.flush();
    		os.close();
    	}
    }

1.  访问`http://localhost:8080/test1`，效果：  
    ![在这里插入图片描述][2020040318082247.png]

[20200403153002731.png]: /images/20230528/e6ddf13539c34284b05c0428d4f964ee.png
[Jasper Studio]: /images/20230528/18f169c558b64fa7b444d76db9908741.png
[jasper]: /images/20230528/67df55ce88a94d8196473e25ee9d4aa5.png
[20200403174538577.png]: /images/20230528/4d5e7cb437274549bb1c6f112a3bcdd1.png
[20200403175600946.png]: /images/20230528/d03b6b8235954865bfd2f241598ef1ab.png
[20200403175941215.png]: /images/20230528/35b85aee3bca46088072afecddc38977.png
[2020040318082247.png]: /images/20230528/fc7c9a2057fc4bcea5abf939308a7126.png