开源组件ExcelReport 1.5.2 使用手册

开源组件ExcelReport 1.5.2 使用手册

ExcelReport是一款基于NPOI开发的报表引擎组件。它基于关注点分离的理念,将数据与样式、格式分离。让模板承载样式、格式等NPOI不怎么擅长且实现繁琐的信息,结合NPOI对数据的处理的优点将Excel报表的生成化繁为简。同时,对报表组成的基本元素进行了抽象,进一步简化了Excel报表的生成过程。

官方站点

NuGet:https://www.nuget.org/packages/ExcelReport

clip_image002[1]

GitHub:https://github.com/hanzhaoxin/ExcelReport

cnblogs:http://www.cnblogs.com/hanzhaoxin/tag/ExcelReport /

QQ Group:116476496  687474703a2f2f7075622e69647171696d672e636f6d2f7770612f696d616765732f67726f75702e

团队介绍

Jensen

来自于中国深圳,是这个项目的发起人和开发人员,2014年11月开始了ExcelReport的开发,负责ExcelReport的开发、测试和bug修复。

个人博客地址:http:// hanzhaoxin.cnblogs.com

许可证说明

ExcelReport采用的是MIT许可,这意味着它可以被用于任何商业或非商业项目,你不用担心因为使用它而必须开放你自己的源代码,且可借助ExcelReport的影响力推广你的产品。

当然作为一个开源许可证,肯定也是有一些义务。例如:在软件和软件的所有副本中都必须包含以上版权声明和本许可声明。

完整的MIT许可证请见:http://mit-license.org/

版本升级说明:

clip_image002

如果您项目中使用了ExcelReport,Bug修复和功能扩充的升级版本请放心升级,这类升级不能影响您现有的项目。如果架构修改版本信息发生了变化,请谨慎升级,这类升级有可能影响您现有的项目。

为什么要用ExcelReport?

回答这个问题前,我们先看看Tony Qu是怎么回答为什么要用NPOI的?

1)你不需要在服务器上安装微软的 Office,可以避免版权问题。

2)NPOI使用起来比 Office PIA 的 API 更加方便,更人性化。

3)你不用去花大力气维护 NPOI,NPOI Team 会不断更新、改善 NPOI,绝对省成本。

4)很多事情是 html 和cvs法做不到的,比如说公式计算[Cell C1]=A1+B1*A2单元格

高级样式(如文本旋转、对齐、宽度)等,其中公式计算可以适当减轻服务器端的计算压力

回到我们的问题,为什么要用ExcelReport呢?

1) 复杂的事情简单了,不可能的事情可行了。

2) 你不需要了解NPOI大量的API,你不需要用.NET语言写蹩脚的Java的语法。

3) 套用Tony兄的描述,你不用去花大力气维护ExcelReport,ExcelReport Team会不断更新、改善ExcelReport,绝对省成本。

目录

1报表元素与元素格式化器

2演示:使用ExcelReport生成报表

3格式化器示例

3.1局部格式化器

3.2单元格格式化器

3.3表格格式化器

3.4重复单元格式化器

4多Sheet报表生成

1报表元素与元素格式化器

在开始示例之前,我们用一章的篇幅介绍ExcelReport是如何将报表的内容抽象为元素的?

又是如何为元素填充数据的?为了说明第一个问题,我们从一个现有的报表开始。

如下报表有两个Sheet:Sheet1名为“工资表”Sheet2名为“工资条”,其截图如下所示。

clip_image004

clip_image006

我们先把数据部用蓝色框线标出来。

clip_image008

clip_image010

名正才能言顺,先说说ExcelReport中报表元素的概念:

元素:填充到报表模板中的数据源对象,我们称之为元素。

局部元素:填充到报表模板中的数据源对象是一个单元格内容的一部分,我们称这样的数据源对象为局部元素。

单元格元素:填充到报表模板中的数据源对象是一个单元格的内容,我们称这样的数据源对象为单元格元素。

表格元素:填充到报表模板中的数据源是某对象的集合,该对象是一行中多个单元格的内容集合,我们称这样的数据源集合为表格元素。

重复单元元素:填充到报表模板中的数据源是某对象的集合,该对象是多行中多个单元格的内容集合,我们称这样的数据源集合为重复单元元素。

【表格元素与重复单元元素数据源以集合出现。为复元素。】

【对应的,局部元素和单元格元素称之为单元素。】

clip_image012

有了定义,我们让元素们各就各位。

clip_image014

clip_image016

那么,ExcelReport又是如何为元素填充数据的?

clip_image018

话说元素格式化器为此而生。

报表元素

元素格式化器

局部元素

PartFormatter

单元格元素

CellFormatter

表格元素

TableFormatter

重复单元元素

RepeaterFormatter

【元素格式化器的作用是格式化元素将其填充到报表模板。】

2演示:使用ExcelReport生成报表

目标报表,生成上章分析的”工资表-工资条”报表。

第一步:设计模板

【模板中参数格式:$[ParameterName]】

clip_image020

clip_image022

clip_image024

第二步:由模板生成模板填充规则文件

1) 打开模板填充规则文件生成工具

clip_image025

2) 将设计好的模板拖入Excel模板文件选择框

clip_image027

3) 点击“生成模板规则文件(.XML)”按钮,生成规则文件。

clip_image029

第三步:填充模板,生成报表【项目中要添加对ExcelReport及NPOI(2.0以上)的引用】

clip_image031

生成导出报表:

clip_image033

clip_image035

【注:演示示例“生成工资表-工资条报表”源码见解决方案:ExcelReportExamples】

clip_image037

3格式化器示例

通过上一章的示例,我们了解了ExcelReport生成报表的步骤,也用到了各种格式化器。在本章,我们将对格式化器逐一展开讲解,以更详细的了解它们。

3.1局部格式化器

局部格式化器用于格式化填充一个单元格内容的一部分。填充数据类型为string。

构成函数:

clip_image039

参数

描述

cellPoint

参数所在单元格位置

parameterName

参数名

value

要格式化填充的值

示例:(局部格式化器示例)

第一步:设计模板

clip_image041

第二步:由模板生成模板填充规则文件

clip_image043

第三步:填充模板,生成报表

clip_image045

生成导出报表:

clip_image047

3.2单元格格式化器

单元格格式化器用于格式化填充一个单元格。填充数据类型为object,详见下表:

填充数据类型

Excel中对应的数据类型

可视化设置项

String

String

 

DateTime

DateTime

clip_image049

Boolean

Boolean

 

Int16

Int32

Int64

Byte

Single

Double

UInt16

UInt32

UInt64

Double

clip_image051

Byte[]

Image

 

构成函数:

clip_image053

参数

描述

cellPoint

参数所在单元格位置

value

要格式化填充的值

示例:(单元格格式化器示例)

第一步:设计模板

clip_image055

第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

第三步:填充模板,生成报表

clip_image057

生成导出报表:

clip_image059

3.3表格格式化器

表格格式化器用于格式化填充一个表格。填充数据类型为IEnumerable<TSource>。

构造函数:

clip_image061

参数

描述

templateRowIndex

模板行行标

dataSource

要格式化填充的数据

columnInfos

列信息集合

TableColumnInfo构造函数:

clip_image063

参数

描述

columnIndex

列标

dgSetValue

Func<TSource, object>类型的委托对象(返回值Object,可参照第二节填充数据类型与Excel中数据类型对应表。)

示例:(表格格式化器示例)

第一步:设计模板

clip_image065

第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

第三步:填充模板,生成报表

clip_image067

生成导出报表:

clip_image069

提问回复:【关于TableFormatter有以下知识点,多次被提问,这里做出统一回答。】

问题一:TableFormatter的数据源可以是DataTable吗?

答:你可以这样写:

clip_image071

问题二:我的实体类中没有实现外链,在实体对象中有一个ID属性,我想导出的内容是ID对应的Name,这怎么办?

答:和示例中的“性别”没什么区别吧。好吧,贴行代码:

clip_image073

3.4重复单元格式化器

重复单元格式化器用于格式化填充一个重复单元元素。填充数据类型为IEnumerable<TSource>。

构造函数:

clip_image075

参数

描述

startTagCell

重复单元(开始)标识单元格

endTagCell

重复单元(结束)标识单元格

dataSource

要格式化填充的数据

cellInfos

重复单元包含的单元格信息集合

RepeaterCellInfo构造函数:

clip_image077

参数

描述

cellPoint

单元格坐标

dgSetValue

Func<TSource, object>类型的委托对象(返回值Object,可参照第二节填充数据类型与Excel中数据类型对应表。)

示例:(重复单元格式化器示例)

第一步:设计模板

clip_image079

根据需求,隐藏重复单元标识行。

clip_image081

第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

第三步:填充模板,生成报表

clip_image083

生成导出报表:

clip_image085

4多Sheet报表生成

到目前为止,我们所有导出都直接使用的是:ExportHelper类中的静态方法。其实在ExcelReport组件的设计中Export类便是终点了,ExportHelper类正如它的名字只是为了方便操作提供的助手类而已。

【哦,它还是部分类,你可以根据需求扩展。】

clip_image087

回到本章的主题,我们要谈的是多Sheet报表的生成。什么?这和前边啰嗦的那些有什么关系?好吧,其实关系也不大,我只是想说关注报表的生成,你看Export类就对了。

clip_image089

参数

描述

templateFile

模板文件路径

containers

Sheet格式化容器的数组【数组中的每个元素对应一个Sheet】

示例:(多Sheet报表生成示例)

第一步:设计模板

clip_image091

clip_image093

第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

第三步:填充模板,生成报表

clip_image095

生成导出报表:

clip_image097

clip_image099

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/109469.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • 对Spring的IOC和AOP的理解,可做面试题用「建议收藏」

    对Spring的IOC和AOP的理解,可做面试题用「建议收藏」IOC:控制反转,也叫DI依赖注入,它并不是一种技术实现,而是一种设计思想。在实际项目开发中,我们往往是通过类与类之间的相互协作来完成特定的业务逻辑,这个时候,每个类都要管理与自己有交互的类的引用和依赖,这就使得代码的维护异常困难并且耦合度过高,而IOC的出现正是为了解决这个问题,IOC将类与类的依赖关系写在配置文件中,程序在运行时根据配置文件动态加载依赖的类,降低的类与类之间的耦合度。它的原…

  • vscode html注释快捷键_VSCode 的快捷键及常用插件总结

    vscode html注释快捷键_VSCode 的快捷键及常用插件总结1、注释:·单行注释:ctrl+/,注释后再按取消·取消单行注释:alt+shift+A注释后再按取消2、移动行·向上移动一行:alt+up·向下移动一行:alt+down3、显示/隐藏左侧目录栏·ctrl+b4、复制当前行·向上复制一行:shift+alt+up·向下复制一行:shift+alt+down5、删除当前行·shift+ctrl+k6、控制台显示隐藏…

  • C++函数指针详解

    C++函数指针详解1.定义每一个函数都占用一段内存单元,它们有一个起始地址,指向函数入口地址的指针称为函数指针。2.语法指向函数的指针变量的一般定义形式为:数据类型(*指针变量名)(参数表);3.说明1)函数指针的定义形式中的数据类型是指函

  • c语言入门教程–-5判断语句

    c语言入门教程–-5判断语句

  • 计算机病毒级防范措施总结,计算机病毒及防范措施

    计算机病毒级防范措施总结,计算机病毒及防范措施计算机病毒及防范措施计算机病毒及防范措施摘要随着全球计算机用户的激增,随着带来的计算机病毒的危害力度也逐渐显现,迫切需要在防范计算机病毒方面加强研究。基于此,本文在全面总结了计算机病毒的内涵、分类以及计算机感染病毒的诸多现象的基础上,深入探讨了防范计算机病毒的具体可行性措施,以期为广大计算用用户安全使用计算机提供一些理论指导和参考。关键词:计算机;病毒;类型;防范;措施1计算机病毒的概念、分…

  • 第4课,python 条件语句if用法[通俗易懂]

    第4课,python 条件语句if用法[通俗易懂]pythonif语句的使用,关系运算和逻辑运算复习

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号