JasperReport JSON datasource 快速上车

JasperReport库是世界上最流行的开源报告引擎。它完全用Java编写,可以使用任何数据源的数据生成像素级的完美文档。然后,可以以各种格式(包括HTML、PDF、Excel、OpenOffice和Word)查看、打印或导出这些文档。

关于Jaspersoft Studio的安装可以参考我们一位同事的文章JasperReport 中踩过的坑
以及官方文档,安装社区版即可。
Jasper的页面设计分为9个Bands。关于Bands的基本介绍请阅读官方文档:Understanding Bands

本文主要记录下我们使用JSON格式的数据创建JasperRepor时遇到的一些坑和经验。


json data adapter

创建jasper report时需要选择data source



可选的数据链接有csv文件,jdbc连接,java beans,json等等



json数据方便前端开发快速开始,官方文档中又无详细介绍,因此本文以json为例,创建一个jasper report.

数据: valuation-list-data.json

{
    "valuationOrder": {
        "company": {
            "nameCN": "珠海仁孚南星",
            "nameSuffix": "汽车销售服务有限公司",
            "nameEn": "Zhuhai Zungfu NanXing Co.,Ltd",
            "address": "珠海市香洲区南屏科技园西路1号华科汽车城内",
            "postCode": "519000",
            "phone": "+86-756-8520011",
            "fax": "+86-756-8520011"
        },
        "customer": {
            "name": "王圆圆",
            "gender": "女士"
        },
        "id": "39524395243952",
        "operator": "parts manager",
        "printDatetime": "2010/04/11 14:09:45",
        "totalPrice": 1111111111165.69,
        "lineItems": [
            {
                "id": "2",
                "stock": "y",
                "name": "2010087/气缸盖密封",
                "identify": "原厂G",
                "quantity": 1.00,
                "unitPrice": 70.00,
                "discount": 0.71556,
                "salePrice": 9999999.99
            }
         ]
}
  • 新建一个jasper report文件,data source 这里选择 new,再选择json文件。

  • 点击 next 后,填写data adapter名字,选择导入json文件,并选择Use the report JSON expression when filling the report选项。
  • 点击 finish 后双击 valuationOrder,query valuationOrder.
  • 点击next选择需要的fields


  • 点击next,按需求选择以哪些fields进行分组。最后选择next -> finish.

    创建好jasper report后可以直接将field拖拽至需要的位置,也可以添加Text Filed后双击,选择要展示的数据。


    点击preview可进行预览

    注意到,valuationOrder中的customercompany都是对象,要展示其中的字段时,直接创建field,输入要创建的field的名字和class即可。

elements

jaspersoft studion提供了一些常用的elements,如可插入变量的text field和静态文本static filed. image, line, list, chart, tabl, page number等等。frame类似div,可将elements在bands内分组。



我们可以在三种模式下操作元素:

design

design模式下可以直接拖拽元素进行设计布局,在右下角可以对元素进行定位,设置大小,颜色,border, padding等操作。


source

source模式下可以利用代码编辑、更改元素。


design

design模式预览report,查看元素渲染。

text field

当变量的长度未知时,勾选上stretch with overflow选项, text filed的高度会随文本的长度而相应增高。


当需要在一个text filed内对文本使用不用的样式时,可以将style标签
写进text field,如:


    
    " + $F{customer.name} + "  "]]>

customer.namecustomer.gender采用不同的字号。
此时,text field的Markup需为styled.

customer font

当我们要引入jaspersoft studio未提供的字体时,可以通过如下步骤实现:
Jaspersoft Studio -> Preferences -> Jaspersoft Studio -> fonts,选择要导入的字体的路径


添加成功后apply,导入的字体即可使用。
注意导入的customer字体位于font下拉列表的最前面!

当我们要将jasper reposrt导出为pdf时,可能会出现customer font导致的错误,因为pdf格式有自己的font set。将customer font添加至pdf font,可解决此问题。

  • fonts设置中选择导入的的font,点击edit

  • 将字体嵌入到pdf中


  • 在report目录中引入自添加的字体

    • 导出字体(如果已有字体压缩包,可跳过此步)
      fonts中选中字体,点击export,导出字体

    • 引入字体
      右键report所在目录,选择 properties


      选择Java Build Path -> Libraries -> Add external JARs...,读取字体压缩包。
      点击apply,即可引入字体。

table

对于valuationOrder.lineItems这类的数组数据,常见的需求是通过table来展示。
我们可以使用 columnHeader, detail, columnFooter等bands组合创建table,eg: create a new report,也可以使用jaspersoft studio提供的table元素。
以下为table元素的添加步骤:

  • 选择、添加table


  • table元素需要dataset(可以创建新dataset或者使用已存在的dataset)


  • 创建dataset,步骤和创建data adapter类似





    选择lineItems

    选择dataset的fields

    选择dataset分组的fields

  • 选择table的dataset的连接。
    因为我们的数据是json格式,因此选择Use a JRDatasource express, 填入

((net.sf.jasperreports.engine.data.JsonDataSource)$P{REPORT_DATA_SOURCE}).subDataSource("lineItems")

其中lineItems为json中数组的key,与dataset的名字无关。

  • 选择需要在table中要展示的columns


  • 选择布局
    layout中可以选择是否需要table header、table footer、column header、column footer、group header和group footer;设置table中单元格的颜色和border.

    点击finish,完成table的添加。当table的dataset数据很多时,table会自动分页。下图分别为分页后的table的第一页和最后一页:
    第一页

    最后一页

    可以看到,table header只在表格第一页显示,table footer只在表格最后一个显示,column headercolumn footer在表格的每一页显示,column header为“表头”。

为了使表格更美观,我们需要给表格添加样式。除了在创建table时的layout中可以添加样式,还可以在design 模式下双击表格,进入table,左下角可以看到table的结构,选择table中的元素,编辑其样式。


当然也可以在source 中直接编辑table代码。


参考链接

  1. https://www.jianshu.com/p/b46b158a8289
  2. https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v630/creating-new-report#jss-user-basicreport_293982575_1024061
  3. https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v720/design-tab-3
  4. https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v720/working-font-extensions-0
  5. http://jasperreports.sourceforge.net/sample.reference/jsondatasource/index.html
  6. https://stackoverflow.com/questions/42821983/display-json-array-in-table-on-jasper-report
  7. https://stackoverflow.com/questions/42821983/display-json-array-in-table-on-jasper-report

你可能感兴趣的:(JasperReport JSON datasource 快速上车)