Java 導(dǎo)出 Excel 利器:JXLS
jxls是一個(gè)輕量級(jí)的Java庫(kù),用于基于模板的Excel報(bào)表生成。
jxls作為一個(gè)開(kāi)源工具,提供了一種高效且易于維護(hù)的方式來(lái)處理復(fù)雜的Excel導(dǎo)出需求。它允許用戶(hù)通過(guò)在Excel模板中放置特定的標(biāo)記或注釋來(lái)定義數(shù)據(jù)的輸出格式和布局,從而避免了編寫(xiě)大量重復(fù)且易出錯(cuò)的代碼。
標(biāo)注:簡(jiǎn)單的excel格式,用簡(jiǎn)單的poi,easyExcel等工具都能導(dǎo)出。但是針對(duì)復(fù)雜的excel,有固定的樣式、合并單元格、動(dòng)態(tài)列等各類(lèi)要求,導(dǎo)致excel 導(dǎo)出需要花很大一部分精力去寫(xiě)代碼。jxls在很大程度上解決了以上問(wèn)題。
以下是jxls的一些主要特點(diǎn):
- 簡(jiǎn)單性: jxls的設(shè)計(jì)哲學(xué)是簡(jiǎn)單和直觀,使得即使是初學(xué)者也能快速上手并使用它來(lái)創(chuàng)建復(fù)雜的Excel報(bào)表。
- 靈活性: 通過(guò)在Excel模板中使用類(lèi)似jsp的標(biāo)簽,jXls提供了極高的靈活性,可以輕松地生成各種格式的報(bào)表。
- 輕量級(jí): 與其他Java Excel庫(kù)相比,jxls更加輕量,不會(huì)給項(xiàng)目增加太多的負(fù)擔(dān)。
- 功能強(qiáng)大: jxls特別適合于處理包含固定樣式、合并單元格和動(dòng)態(tài)列等復(fù)雜要求的Excel導(dǎo)出任務(wù)。
- 易于維護(hù): 使用jxls可以減少因手動(dòng)編碼導(dǎo)致的維護(hù)成本和出錯(cuò)概率,提高項(xiàng)目的可維護(hù)性。
添加jar
很高興在編寫(xiě)文章時(shí)發(fā)現(xiàn)jxls的大版本升級(jí)了,所使用的jdk版本也來(lái)到了17。
對(duì)于原先的jxls2.x版本的使用者來(lái)說(shuō),新的構(gòu)建器 API 取代了 JxlsHelper
。TransformerFactory
和 createTransformer()
方法也已被刪除。
Context 現(xiàn)在包含創(chuàng)建報(bào)表所需的所有信息。但數(shù)據(jù)以Map<String, Object>
的形式傳遞給 JxlsTemplateFiller
。
<dependency>
<groupId>org.jxls</groupId>
<artifactId>jxls-poi</artifactId>
<version>3.0.0</version>
</dependency>
XlsArea 區(qū)域
Area是jXLS中的一個(gè)主要概念,它本質(zhì)上代表了一個(gè)矩形區(qū)域,這個(gè)區(qū)域包含了需要進(jìn)行數(shù)據(jù)轉(zhuǎn)換的單元格。每個(gè)Area可以包含一組轉(zhuǎn)換命令和一組嵌套的子區(qū)域,這些子區(qū)域也是Area,它們有自己的命令和子區(qū)域。
如下命令表示需要處理的區(qū)域?yàn)閺腁1至K列第4行:
jx:area(lastCell="K4")
創(chuàng)建報(bào)表
因?yàn)榇蟀姹镜纳?jí),我們不再使用如下方式:
Context context = new Context();
context.putVar("list", list);
JxlsHelper.getInstance().setEvaluateFormulas(evaluateFormulas).processTemplate(inputStream, outPutStream, context);
而是:
Map<String, Object> data = new HashMap<>();
data.put("employees", employees);
JxlsPoiTemplateFillerBuilder.newInstance()
.withTemplate("template.xlsx")
.build()
.fill(data, new File("report.xlsx"));
循環(huán)
循環(huán)是用的最多的標(biāo)簽,用于循環(huán)輸出各列數(shù)據(jù):
jx:each(items="weeks" var="week" lastCell="B4")
示例:
publicclassEmployee{
private String name;
private Date birthDate;
private BigDecimal payment;
private BigDecimal bonus;
// getters/setters ...
publicEmployee(String name, Date birthDate, double payment, double bonus){
this(name, birthDate, new BigDecimal(payment), new BigDecimal(bonus));
}
public String getSalaryGroup(){
return payment.doubleValue() > 2000d ? "high" : "normal";
}
}
List<Employee> employees = new ArrayList<>();
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MMM-dd", Locale.US);
employees.add(new Employee("Elsa", dateFormat.parse("1970-Jul-10"), 1500, 0.15));
employees.add(new Employee("Oleg", dateFormat.parse("1973-Apr-30"), 2300, 0.25));
employees.add(new Employee("John", dateFormat.parse("1970-Jul-10"), 3500, 0.10));
employees.add(new Employee("Neil", dateFormat.parse("1975-Oct-05"), 2500, 0.00));
employees.add(new Employee("Maria", dateFormat.parse("1978-Jan-07"), 1700, 0.15));
employees.add(new Employee("John", dateFormat.parse("1969-May-30"), 2800, 0.20));
employees.add(new Employee("Oleg", dateFormat.parse("1988-Apr-30"), 1500, 0.15));
employees.add(new Employee("Maria", dateFormat.parse("1970-Jul-10"), 3000, 0.10));
employees.add(new Employee("John", dateFormat.parse("1973-Apr-30"), 1000, 0.05));
return employees;
將模版編輯為如下:
圖片
根據(jù)輸出報(bào)表查看結(jié)果。
1.multisheet 多sheet頁(yè)
jx:each(items="employees" var="e" multisheet="sheetNames" lastCell="B4")
圖片
輸出:
圖片
2.方向向右
默認(rèn)值為 directinotallow=“DOWN”
,將創(chuàng)建行。將使用 directinotallow=“RIGHT”
創(chuàng)建列。
您也可以為特殊情況設(shè)置自己的 cellRefGenerator
,但在此不再進(jìn)一步描述。
jx:each(items="e.departments" var="d" lastCell="D2" directinotallow="RIGHT")
3.索引
有時(shí)我們需要顯示循環(huán)的索引。使用屬性 varIndex
指定將保存從 0 開(kāi)始的迭代索引的變量名稱(chēng)。
jx:each(items="employees" var="e" varIndex="index" lastCell="C2")
顯示:
圖片
4.過(guò)濾
只有選擇條件為 true 的項(xiàng)才會(huì)成為輸出的一部分。
jx:each(items="employees" var="e" select="e.payment > 2000" lastCell="C2")
圖片
圖片
5. 分組和分組排序
在屬性中指定 var name + “.” + 屬性名稱(chēng)
以對(duì)項(xiàng)目進(jìn)行分組。還必須在屬性中指定 ASC、DESC此時(shí)將在組內(nèi)部進(jìn)行排序。
比如employee
類(lèi)中有salaryGroup
(工資)方法來(lái)指定該人是否大于2000元。
示例代碼:
jx:each(items="employees" var="g" groupBy="g.salaryGroup" groupOrder="ASC" lastCell="C3")
示例圖:
圖片
圖片
判斷
jx:if
命令根據(jù)條件表達(dá)式顯示/隱藏單元格。這就像 Java 中的 if
或 if,else
。
jx:if(cnotallow="e.payment<2000" lastCell="C2" areas=["A2:C2","A3:C3"])
condition:
如果表達(dá)式結(jié)果為真,則顯示區(qū)域,否則隱藏區(qū)域; 如果表達(dá)式結(jié)果不為 true,則顯示其他區(qū)域,否則隱藏其他區(qū)域。
圖片
圖片
動(dòng)態(tài)行列
jx:grid
命令可用于生成具有標(biāo)題區(qū)域和數(shù)據(jù)行區(qū)域的動(dòng)態(tài)網(wǎng)格。
jx:grid(headers="headers" data="items" areas=["A3:A3","A4:A4"] formatCells="BigDecimal:C1,Date:D1" lastCell="A4")
圖片
圖片
合并單元格
jx:mergeCells(cols="" rows="" minCols="" minRows="" lastCell="C2")
- cols: 組合列數(shù)
- rows: 合并的行數(shù)
- minCols: 要合并的最小列數(shù)
- minRows: 要合并的最小行數(shù)
- lastCell: 合并單元格范圍。
圖片
使用此命令將圖像添加到工作表中。
jx:image(src="image" lastCell="A2")
- src: 返回包含圖像數(shù)據(jù)的
byte[]
數(shù)組的表達(dá)式 - imageType: 可以包含以下值:
PNG
(默認(rèn)值)、JPEG
(非 JPG)、EMF
、WMF
、PICT
、DIB
。 - scaleX和scaleY: 縮放參數(shù)(可選)
- lastCell: 區(qū)域結(jié)束
excel 公式處理
參數(shù)化公式允許在公式中使用變量,必須將其括在$[ ]
符號(hào)中,比如我們需要把數(shù)據(jù)輸出的同時(shí)進(jìn)行計(jì)算,比如我們數(shù)據(jù)中的比率值是1(excel上最終需要顯示為1%)。我們可以修改代碼為$[${item.taxRate}/100]
,其中${item.taxRate}
表示我們自己的迭代變量,同時(shí)改變單元格樣式為百分比,此時(shí)輸出的值才會(huì)是1%
JXLS官網(wǎng):https://jxls.sourceforge.net/