基于Java反射機(jī)制的POI實(shí)現(xiàn)Excel數(shù)據(jù)導(dǎo)入/導(dǎo)出

朱文君 黃國權(quán)

摘 ?要： 隨著Java語言越來越多地被選擇用于B/S結(jié)構(gòu)系統(tǒng)的開發(fā)語言，利用POI解析技術(shù)操作Excel文件越來越廣泛。在POI組件下，采用Java反射機(jī)制及自定義注解原理，設(shè)計(jì)實(shí)現(xiàn)了數(shù)據(jù)庫與Excel文件的數(shù)據(jù)交互。此方法不僅能保證數(shù)據(jù)導(dǎo)入的完整性，而且能免去數(shù)據(jù)導(dǎo)出后重新編輯的復(fù)雜性，從而提高POI實(shí)現(xiàn)Excel數(shù)據(jù)導(dǎo)入/導(dǎo)出的靈活性、重用性和易擴(kuò)展性。

關(guān)鍵詞： POI; Excel; 反射機(jī)制; 自定義注解; 數(shù)據(jù)導(dǎo)入導(dǎo)出

中圖分類號(hào)：TP312 ? ? ? ? ?文獻(xiàn)標(biāo)志碼：A ? ? 文章編號(hào)：1006-8228（2015）01-38-02

Realization of import and export of data in Excel files by POI based on Java reflection

Zhu Wenjun， Huang Guoquan

（College of Medical Information Engineering， Guangdong Pharmaceutical University， Guangzhou， Guangdong 510006， China）

Abstract： With more and more systems on B/S structure being developed by Java， operating Excel by POI is used more widely. Under POI component， applying Java reflection and custom annotation， data interaction between database and Excel files is designed and realized. This method can not only ensure the integrity of data import， but also avoid the complexity of the data export. Flexibility， re-usability and ductility of using POI in importing and exporting Excel files are improved.

Key words： POI; Excel; reflection; custom annotation; data import and export

0 引言

在Web應(yīng)用系統(tǒng)中，用戶常會(huì)要求將數(shù)據(jù)庫中的數(shù)據(jù)導(dǎo)出到Excel表格中，或?qū)xcel表格中的數(shù)據(jù)導(dǎo)入到數(shù)據(jù)庫中[1]。然而，傳統(tǒng)的Excel數(shù)據(jù)導(dǎo)入導(dǎo)出技術(shù)，對(duì)于不同的對(duì)象，都需要重新配置固定的表頭并且頻繁更改關(guān)鍵代碼算法，導(dǎo)致程序員操作過于繁瑣。本文介紹一種基于Java反射機(jī)制原理，只需要配置自定義注解，而無需更改關(guān)鍵代碼算法的Excel導(dǎo)入導(dǎo)出技術(shù)。

1 Java反射機(jī)制簡(jiǎn)介

Java反射機(jī)制是指Java語言在運(yùn)行時(shí)擁有的一項(xiàng)自審的能力，對(duì)自身進(jìn)行檢查，并能直接操作程序的內(nèi)部屬性[2]。即在運(yùn)行狀態(tài)中，對(duì)于任意一個(gè)類，都能夠知道這個(gè)類的所有屬性和方法;對(duì)于任意一個(gè)對(duì)象，都能夠調(diào)用它的任意一個(gè)方法和屬性。通過采用該機(jī)制來實(shí)現(xiàn)對(duì)自己行為的描述和檢測(cè)，并能根據(jù)自身行為的狀態(tài)和結(jié)果，為下一步的動(dòng)作做準(zhǔn)備[3]。

也就是說，Java反射機(jī)制提供了一種在運(yùn)行中獲得類信息并構(gòu)建類的Class對(duì)象和生成類的實(shí)例的機(jī)制。同時(shí)，使程序代碼能夠訪問裝載到JVM中的類的內(nèi)部信息，主要包括：已裝載類的字段、方法和構(gòu)造函數(shù)的信息，并允許編寫處理類的代碼[4]。

2 輔助類

2.1 ExcelAnnotation.java

@Retention（RetentionPolicy.RUNTIME）

public @interface ExcelAnnotation {

String title（）;

int order（）;

}

ExcelAnnotation注釋采用自定義注解技術(shù)，可在實(shí)體model類上的字段get（）方法上注釋，同時(shí)設(shè)定屬性所對(duì)應(yīng)的title（標(biāo)題）、order（順序）。通過設(shè)定@Retention（RetentionPolicy.RUNTIME），該注釋會(huì)在Class字節(jié)碼文件中存在，在運(yùn)行時(shí)可通過反射機(jī)制獲取該注釋的屬性。沒有注釋的實(shí)體model類的字段將不受影響，有注釋的實(shí)體model類的字段將會(huì)根據(jù)title的值輸出標(biāo)題，并且根據(jù)order的值進(jìn)行排序。從而在不需要預(yù)定義模板的情況下，實(shí)現(xiàn)Excel表格的表頭的動(dòng)態(tài)輸出，提高了功能模塊的靈活性。

2.2 ExcelHeader.java

public class ExcelHeader implements Comparable

{

private String title;

private int order;

private String methodName;

……

public int compareTo（ExcelHeader eh） {

return order>eh.order？1：（order

public ExcelHeader（String title， int order，

String methodName） {

super（）;

this.title = title;

……

}

}

ExcelHeader類用來存儲(chǔ)Excel標(biāo)題的對(duì)象，通過該類在反射機(jī)制中可以動(dòng)態(tài)獲取標(biāo)題和方法的對(duì)應(yīng)關(guān)系。同時(shí)，該類實(shí)現(xiàn)Comparable接口，重寫了public int compareTo（）方法。通過調(diào)用Collections.sort（）方法，可根據(jù)order的值進(jìn)行標(biāo)題的排序，從而實(shí)現(xiàn)Excel表格的表頭的靈活配置。

3 主類

3.1 Excel數(shù)據(jù)導(dǎo)出

傳統(tǒng)的Excel數(shù)據(jù)導(dǎo)出技術(shù)，只能根據(jù)數(shù)據(jù)持久層或業(yè)務(wù)邏輯層中已經(jīng)由程序員寫好的sql查詢語句導(dǎo)出規(guī)定的數(shù)據(jù)，不能滿足用戶的自定義需求。引用Java反射機(jī)制后，通過BeanUtils.getProperty（）方法，根據(jù)加載類對(duì)象和字段名便可以動(dòng)態(tài)獲得對(duì)應(yīng)的屬性值，因此，不需要更改關(guān)鍵代碼的算法，減少了程序員的操作，同時(shí)也提高了功能模塊的重用性。

以下為Excel數(shù)據(jù)導(dǎo)出的關(guān)鍵代碼：

private List getHeaderList（Class model） {

List headers=new ArrayList（）;

//通過反射機(jī)制，能訪問model對(duì)象表示的類的所有方法

Method[] methods=model.getDeclaredMethods（）;

for （Method m：methods） {

String mn=m.getName（）;

if （mn.startsWith（"get"） ） {

//通過反射機(jī)制，判斷注釋存在于方法上，篩選出指定的數(shù)據(jù)集

if （m.isAnnotationPresent（ExcelAnnotation.class）） {

ExcelAnnotation ea=m.getAnnotation（ExcelAnnotation.class）;

headers.add（new ExcelHeader（ea.title（），ea.order（）， mn））;

}

}

}

return headers;

}

getHeaderList（）方法首先通過反射機(jī)制，獲取實(shí)體model類的所有方法，然后通過自定義注解技術(shù)獲取存在于方法上的注釋，并且把注釋的內(nèi)容添加到headers對(duì)象中，從而動(dòng)態(tài)的綁定標(biāo)題和方法的對(duì)應(yīng)關(guān)系。

private Workbook exportExcel（List objs， Class model） {

……

List headers=getHeaderList（model）;

Collections.sort（headers）;

//輸出表頭

for （int i=0; i

cell1.setCellValue（headers.get（i）.getTitle（））; }

//輸出對(duì)象信息

for （int i=0; i

……

obj=objs.get（i）;

for （int j=0; j

Cell cell2=r.createCell（j）;

setDefaultCellStyle（cell2， cellStyle）;

//通過反射機(jī)制，調(diào)用加載類對(duì)象和字段名獲取對(duì)應(yīng)的屬性值

cell2.setCellValue（BeanUtils.getProperty（obj，

getMethodName（headers.get（j））））;

……

}

exportExcel（）方法通過調(diào)用getHeaderList（）取得headers對(duì)象中標(biāo)題和方法的對(duì)應(yīng)關(guān)系。通過反射機(jī)制，調(diào)用加載類對(duì)象和字段名獲取對(duì)應(yīng)的屬性值，從而動(dòng)態(tài)的綁定表頭和屬性值的映射關(guān)系。最后，通過Workbook對(duì)象傳值調(diào)用POI生成Excel表格方法，便實(shí)現(xiàn)將數(shù)據(jù)庫中的數(shù)據(jù)導(dǎo)出到Excel表格中。

3.2 Excel數(shù)據(jù)導(dǎo)入

傳統(tǒng)的Excel數(shù)據(jù)導(dǎo)入技術(shù)，需要程序員在數(shù)據(jù)持久層或業(yè)務(wù)邏輯層中手動(dòng)組合sql插入語句。數(shù)據(jù)處理效率過低，并且容易導(dǎo)致數(shù)據(jù)處理出錯(cuò)。引用Java反射機(jī)制后，通過BeanUtils.copyProperty（）方法，把字段名和對(duì)應(yīng)的屬性值復(fù)制到加載類對(duì)象中，調(diào)用數(shù)據(jù)持久層的存儲(chǔ)操作即可。同樣，不需要更改關(guān)鍵代碼的算法，體現(xiàn)了功能模塊的重用性。

以下為Excel數(shù)據(jù)導(dǎo)入的關(guān)鍵代碼：

private Map getHeaderMap（Row titleRow，

Class model） { List headers=getHeaderList

（model）;

for （Cell c：titleRow） {

String title=c.getStringCellValue（）;

for （ExcelHeader eh ： headers） {

if （eh.getTitle（）.equals（title.trim（））） {

maps.put（c.getColumnIndex（）， eh.getMethodName（）

.replace（"get"， "set"））;

……

return maps; }

getHeaderMap（）方法首先獲取Excel表格中的表頭，然后通過與實(shí)體model類中注釋的標(biāo)題作對(duì)比，若一致，則把標(biāo)題的順序和對(duì)應(yīng)的方法名添加到maps對(duì)象中。

public List