为什么80%的码农都做不了架构师？>>>   

1    介绍

jXLS是用于生成Excel报表的小型Java类库。jXLS使用特殊标记在Excel模板中定义输出格式和数据布局。

Java有优秀的创建Excel文件的开源和社区类库。值得关注的开源类库有Apache POI和Java Excel API。在某种意义上，这些类库非常低级，需要编写许多Java代码才能创建一个简单的Excel文件。通常需要手动设置每个单元格的格式和数据。报表布局和数据格式越复杂会导致Java代码非常复杂和难以调试和维护。此外，不是所有的Excel特性都支持和使用API操作（例如，宏或图表）。

在使用jXLS时，你所需要做的就是在一个Excel模板中定义所有报表格式和数据布局，并运行jXLS引擎，为它提供数据以填充模板。在大多数情况下，你需要编写的唯一代码是使用适当配置的jXLS引擎的简单调用。

2    主要概念

2.1    Area（区域）

Area代表Excel文件中的矩形区域。可以使用单元格范围或使用开始单元格和区域大小（行和列数）定义矩形区域。Area包括特定范围的所有Excel单元格。

每个Area可以关联一组命令，jXLS引擎处理区域时执行和区域相关的命令。Area可以嵌套子区域。每个子区域也是一个Area，也可以包含自己的命令和自己的子区域。

Area可以使用以下方式定义：

• 在Excel模板文件中使用特定标记语法。
• 使用XML配置。
• 使用jXLS Java API。

2.2    Command（命令）

命令代表一个或多个Area的转换动作。Command接口如下所示： 

public interface Command {String getName();List<Area> getAreaList();Command addArea(Area area);Size applyAt(CellRef cellRef, Context context);void reset(); }

Command的主要方法是Size applyAt(CellRef cellRef, Context context)。该方法在单元格cellRef执行命令动作。context类似于一个map，用于为命令传递数据。该方法返回转换后区域的大小作为Size对象。

当前，jXLS提供以下内置命令：

• Each
• If
• Image

2.3    Transformer

Transformer接口允许Area与特定Excel实现无关。这意味着通过提供不同的Transformer接口实现，我们可以使用不同的底层Java->Excel库。

Transformer接口如下所示：

public interface Transformer {void transform(CellRef srcCellRef, CellRef targetCellRef, Context context, boolean updateRowHeight);void setFormula(CellRef cellRef, String formulaString);Set<CellData> getFormulaCells();CellData getCellData(CellRef cellRef);List<CellRef> getTargetCellRef(CellRef cellRef);void resetTargetCellRefs();void resetArea(AreaRef areaRef);void clearCell(CellRef cellRef);List<CellData> getCommentedCells();void addImage(AreaRef areaRef, byte[] imageBytes, ImageType imageType);void write() throws IOException;TransformationConfig getTransformationConfig();void setTransformationConfig(TransformationConfig transformationConfig);boolean deleteSheet(String sheetName);void setHidden(String sheetName, boolean hidden);void updateRowHeight(String srcSheetName, int srcRowNum, String targetSheetName, int targetRowNum); }

尽管Transformer接口看起来有很多方法，但大多数方法已经在AbstractTransformer基础抽象类中实现，如果需要提供新Java->Excel实现，只需继承抽象类即可。

当前，jXLS提供两种Transformer接口实现：

• PoiTransformer
• JexcelTransformer

PoiTransformer使用Apache POI类库生成Excel文件。JexcelTransformer基于较老的Java Excel API类库。

3    例子：使用jXLS基于模板输出员工列表到Excel中

3.1    引入依赖

jXLS对Apache POI和Java Excel API进行高级封装，因此，要使用jXLS必须引入底层Apache POI或Java Excel API，毋庸置疑，Apache POI是Java开源社区最强Excel解决方案，因此，我们选择使用Apache POI作为jXLS的底层API。下面是引入Apache POI的依赖配置：

<dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-scratchpad</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml-schemas</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-excelant</artifactId><version>3.15</version> </dependency>

接下来我们需要引入jXLS的核心类库：

<dependency><groupId>org.jxls</groupId><artifactId>jxls</artifactId><version>2.4.5</version> </dependency>

jXLS核心类库，并没有直接实现对Excel的操作，而是定义了两个适配器，分别使用Apache POI和Java Excel API对Excel进行操作。因为我们选择使用Apache POI作为底层API操作Excel，因此，我们需要导入Apache POI适配器依赖：

<dependency><groupId>org.jxls</groupId><artifactId>jxls-poi</artifactId><version>1.0.15</version> </dependency>

一个完整的Maven依赖配置如下所示：

<!-- jXLS核心库 --> <dependency><groupId>org.jxls</groupId><artifactId>jxls</artifactId><version>2.4.5</version> </dependency> <!-- jXLS-POI适配器 --> <dependency><groupId>org.jxls</groupId><artifactId>jxls-poi</artifactId><version>1.0.15</version> </dependency> <!-- Apache POI依赖包 --> <dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-scratchpad</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml-schemas</artifactId><version>3.15</version> </dependency> <dependency><groupId>org.apache.poi</groupId><artifactId>poi-excelant</artifactId><version>3.15</version> </dependency>

3.1    定义员工实体类

/*** 员工实体类* * @since 2018年7月11日* @author 赵凡* @version 1.0**/ public class Employee {private String name;// 员工名称private String sex;// 性别private String telephone;// 手机号码private Date birthday;// 生日private BigDecimal payment;// 工资// ... 构造函数// ... getters/setters}

3.2    创建Excel模板

模板是使用特定标记规定jXLS应该如何输出数据的Excel文件。jXLS提供一些内置标记处理器解析Excel模板和提取控制命令。如有需要可以自定义标记处理器。因此，可以为Excel模板定义自己的标记，并以适当的方式进行解析，以创建jXLS命令结构。

默认，jXLS以Apache JEXL作为表达式语言在Excel模板中引用Java对象属性和方法。对象必须在jXLS上下文中某一键上可用。为了在单元格中输出员工名称，可以在单元格中放入${employee.name}。使用${和}环绕JEXL表达式。假设在上下文中employee键下有一个Employee对象。

输出员工列表信息的最终模板如下所示：

模板中第三行的单元格使用JEXL表达式引用employee对象的属性。单元格A1包含的Excel注释jx:area(lastCell="E4")定义模板根区域为A1:E4。单元格A3包含的Excel注释jx:each(items="employees" var="employee" lastCell="E4")定义jXLS Each命令。Each命令迭代employees（由items属性定义）集合的条目到上下文的employee（由var属性定义）键。执行Each命令的区域是A3:E4（有lastCell属性定义），该区域将会被克隆，并使用上下文中的每个新的Employee对象处理。

3.3    使用jXLS API处理模板

List<Employee> employees = generateSampleEmployeeData(); try(InputStream is = ObjectCollectionDemo.class.getResourceAsStream("object_collection_template.xls")) {try (OutputStream os = new FileOutputStream("target/object_collection_output.xls")) {Context context = new Context();context.putVar("employees", employees);JxlsHelper.getInstance().processTemplate(is, os, context);} }

运行程序生成如下所示的Excel：

 

 

 

转载于:https://my.oschina.net/leeck/blog/1844426

总结

以上是生活随笔为你收集整理的第一章——快速入门的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得生活随笔网站内容还不错，欢迎将生活随笔推荐给好友。