springboot集成 birt 来做一个稍微复杂的report

左手的ㄟ右手 2022-03-22 18:20 456阅读 0赞

# 前言 #

在[SpringBoot 集成 Birt][SpringBoot _ Birt]中，最后的例子只是比较简单的例子。这篇主要讲述如何去做一个稍微复杂点的report

# 目标report #

> 要建立一个user report,数据展示分为2部分  
> 第一部分列出所有用用户，第二部分列出用户的详情，详情里包含了用户的不同的account类型，完成后的pdf如下图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70]

### 数据结构 ###

后端获取到的数据是一个`list<User>`

User的数据结构如下，注意user里关联了一个`List<Account>`对象

Class User{
        private Long userKy;
        private String fullName;
        private String email;
        private String mobile;
        private Date birthDay;
        private String userId;
        private String language;
        private String companyName;
        private List<Account> accounts;
    }

Class Account{
        private long key;
        private String accountName;
        private String accountNo;
        private String ccy;
        private int paymentType;  // 1.payment 2.payroll 3.fix deposit
        private int userKy;
    }

# 知识点 #

*  dataSource
 *  dataset open fetch
 *  dataSource 和 dataset的关系
 *  dataset filter
 *  grid和table 组件的使用
 *  script使用
 *  css 使用
 *  master page 设置页头和页尾

# 代码流程 #

1.  birt工具里新建立1个report，命名为user.rptdesin
2.  新建立scripted data Source的DataSource,打开它的script，在initialize 事件输入以下代码。

//获取到spring的上下文
    var spring=reportContext.getAppContext().get("spring");
    //获取到userReportDataService这个service
    var userService=spring.getBean("userReportDataService");
    //获取数据，也就说datasource里的数据就是userList
    userList=userService.getUsers();

userService的java代码如下

public class UserReportDataService {
     //从一个user.json文件里获取到user的list
         public List<User> getUsers(){
             InputStream is=UserReportDataService.class.getClassLoader().getResourceAsStream("mock/user.json");
             try {
                 ObjectMapper mapper = new ObjectMapper();
                 JavaType javaType = mapper.getTypeFactory().constructParametricType(ArrayList.class,User.class);
                 List<User> users=mapper.readValue(is,javaType);
                 return users;
             } catch (IOException e) {
                 e.printStackTrace();
             }
             return null;
         }
    }

1.  新建立 dataSet ,关联上刚选中的dataSource。命名为users,打开它的script

选中open输入

count=0;

选中fech输入

if(userList.size()>count) {
     user=userList.get(count);
     row.userId=user.getUserId();
     row.fullName=user.getFullName();
     row.mobile=user.getMobile();
     row.language=user.getLanguage(); 
     row.email=user.getEmail();   
     row.companyName=user.getCompanyName();
     row.birthDay=user.getBirthDay();
     row.userKy=user.getUserKy();
     count++;
     return true;
    }
    return false;

fetch里的row就是dataset里的一条记录，注意在这里只能插入一条记录。

1.  新建立 dataSet ,关联上刚选中的dataSource。命名为userAccount,打开它的script

选中open输入

importPackage(Packages.java.util)
    acctArrList = new ArrayList();
    
    for(var i=0;i<userList.size();i++) {
     u=userList.get(i);
     var accts=u.getAccounts();
     if(accts!=null){
      j=0;
      while(j<accts.size()){
        acct=accts.get(j);
        acct.setUserKy(u.getUserKy());
        acctArrList.add(acct);
        j++;
      }
     }
    }
    count=0;

> 由于fetch只能写入1条记录。所以只能先把所有的account拿出来放到一个ArrayList里

选中fech输入

if(acctArrList.size()>count) {
       acct=acctArrList.get(count);
       row.accountName=acct.getAccountName();
       row.accountNo=acct.getAccountNo();
       row.ccy=acct.getCcy();
       row.key=acct.getKey();
       row.paymentType=acct.getPaymentType();
       row.userKy=acct.getUserKy();
       count++;
       return true;
    }
    return false;

**data source和data set 的关系？**

data source 是获取到数据的数据源，选中scripted data source就是说通过script的方法来获取到数据，如上第2步的代码。  
当数据源获取完毕后，data set通过open 和 fetch操作来从data source里获取到需要的数据集

1.  整个report 设计  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 1]  
    总共分成1,2,3,4,5张table。

1和2通过一个上下的grid分开  
2里的3,4,5 各是一个detail 的row  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 2]  
一个蓝色框就是一个detail的row  
[rptdesign文件下载][rptdesign]

1.  table 1很简单，拖个table到grid然后选中data set为users.
2.  table 2 ,拖个table到grid,选中data set为 userAccount , table2里包含了 3,4,5 .

*  table 3 是当前行的user的对应account的paymentType=1 的账号
 *  table 4 是当前行的user的对应account的paymentType=2 的账号
 *  table 5 是当前行的user的对应account的paymentType=3 的账号

1.  以table 3为例讲解，拖个table到图中的位置后，选中data set为userAccounts,该 userAccounts已经在fetch的时候将所有的account放到里面了。注意下面的红色框里的filter条件的使用  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 3]
2.  接下来就是加入css使report美观些  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 4]  
    在styles里加入一个css的文件，在下面的框里选择需要导入的style
3.  修改master page,加入页头和页尾  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 5]  
    在最上面加入一个Grid,Grid内容可以参看下载的[rptdesign文件][rptdesign]
4.  加入一个logo图片  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 6]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 7]  
    add Image加入一张图片，并且选择为Emedded image,这样图片就会嵌入到report的设计文件里。
5.  java code  
    这个和 [SpringBoot 集成 Birt][SpringBoot _ Birt]基本相同这里不具体说明  
    整个代码在[github code][]里。
6.  运行spring boot后，在postman里输入`http://localhost:8080/report/user`

# debug 方法 #

> 脚本很不好发现问题，目前简单的方法就是在script里打印出来，如下

importPackage(Packages.java.lang);
    System.out.println("xxxxx");

[github code][]

# 参考 #

*  script  
    [https://www.eclipse.org/birt/documentation/integrating/scripting.php][https_www.eclipse.org_birt_documentation_integrating_scripting.php]
 *  各种文档,主要是css文档 [https://www.eclipse.org/birt/documentation/reference.php][https_www.eclipse.org_birt_documentation_reference.php]

[SpringBoot _ Birt]: https://blog.csdn.net/guo_xl/article/details/86080466
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70]: /images/20220322/7234fe314a94480bb2f3c2c1720315f8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 1]: /images/20220322/c9acc26334ae414d91ee68c8139edc74.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 2]: /images/20220322/8be2751510294dbcb16d0b3d1cc28f61.png
[rptdesign]: https://github.com/rechardguo/spring-learn/blob/master/springboot/springboot-birt/src/main/resources/report/user.rptdesign
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 3]: /images/20220322/4d86a5f599224f899909d5050d6696f7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 4]: /images/20220322/fb48584f2dd44c35969f63efa03d3316.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 5]: /images/20220322/78cb257af79e472ebbcae4b71fc511ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 6]: /images/20220322/0c1e1443347141d0933a294ed6446255.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b194bA_size_16_color_FFFFFF_t_70 7]: /images/20220322/13290ab9fd884b00b4796428ddcf1ad5.png
[github code]: https://github.com/rechardguo/spring-learn/tree/master/springboot/springboot-birt
[https_www.eclipse.org_birt_documentation_integrating_scripting.php]: https://www.eclipse.org/birt/documentation/integrating/scripting.php
[https_www.eclipse.org_birt_documentation_reference.php]: https://www.eclipse.org/birt/documentation/reference.php