Posted on 2006-10-25 16:03
Hally 閱讀(2504)
評(píng)論(0) 編輯 收藏 所屬分類:
技術(shù)文章轉(zhuǎn)載
本文將闡述如何用POI來(lái)讀取/寫入完整的Excel文件。
約定：POI項(xiàng)目2.0版現(xiàn)在已經(jīng)接近正式發(fā)行階段，開(kāi)發(fā)進(jìn)度迅速，不斷有新的功能集成到原有的系統(tǒng)，同時(shí)也有對(duì)原有系統(tǒng)的修改。
為了保證本文的及時(shí)性，本文將按照最近的1.9開(kāi)發(fā)版說(shuō)明。雖然編譯最近的發(fā)行版源代碼也能正常運(yùn)行，但現(xiàn)在的代碼和2.0的發(fā)行版會(huì)有一些出入。
一、Excel基礎(chǔ)
Microsoft Excel 97文件格式也被稱為BIFF8，最近版本的Excel只對(duì)該格式作了少量的改動(dòng)。增加對(duì)新格式的支持除了增加項(xiàng)目的復(fù)雜性之外，唯一的效果也許只是不得不使每個(gè)用戶升級(jí)代碼，沒(méi)有什么實(shí)際的好處。
因此，在下文說(shuō)明中，凡是提到Excel 97格式的地方其實(shí)都是指Excel從97到XP的格式。
二、HSSF概況
POI項(xiàng)目實(shí)現(xiàn)的Excel 97文件格式稱為HSSF??也許你已經(jīng)猜到，HSSF是Horrible SpreadSheet Format的縮寫，也即“討厭的電子表格格式”（微軟使某些原本簡(jiǎn)單的事情過(guò)分復(fù)雜，同時(shí)又過(guò)分簡(jiǎn)單地處理了某些原本需要靈活性的事情，讓人不勝佩服！）
也許HSSF的名字有點(diǎn)滑稽，就本質(zhì)而言它是一個(gè)非常嚴(yán)肅、正規(guī)的API。通過(guò)HSSF，你可以用純Java代碼來(lái)讀取、寫入、修改Excel文件。
前面一篇文章提到了POIFS，那么HSSF和POIFS又有什么關(guān)系呢？就象其他POI的API一樣，HSSF建立在POIFS的基礎(chǔ)上，因此在HSSF內(nèi)的有些代碼和前文的某些代碼很相似。不過(guò)，當(dāng)我們編寫基于HSSF API的代碼時(shí)，一般不需要了解POIFS API的細(xì)節(jié)。
HSSF為讀取操作提供了兩類API：usermodel和eventusermodel，即“用戶模型”和“事件-用戶模型”。前者很好理解，后者比較抽象，但操作效率要高得多。usermodel主要有org.apache.poi.hssf.usermodel和org.apache.poi.hssf.eventusermodel包實(shí)現(xiàn)（在HSSF的早期版本中，org.apache.poi.hssf.eventusermodel屬于eventmodel包）。
usermodel包把Excel文件映射成我們熟悉的結(jié)構(gòu)，諸如Workbook、Sheet、Row、Cell等，它把整個(gè)結(jié)構(gòu)以一組對(duì)象的形式保存在內(nèi)存之中。eventusermodel要求用戶熟悉文件格式的底層結(jié)構(gòu)，它的操作風(fēng)格類似于XML的SAX API和AWT的事件模型（這就是eventusermodel名稱的起源），要掌握竅門才能用好。
另外，eventusermodel的API只提供讀取文件的功能，也就是說(shuō)不能用這個(gè)API來(lái)修改文件。
三、通過(guò)usermodel讀取文件
用HSSF的usermodel讀取文件很簡(jiǎn)單。首先創(chuàng)建一個(gè)InputStream，然后創(chuàng)建一個(gè)HSSFWorkbook：
InputStream myxls = new FileInputStream("workbook.xls"));
HSSFWorkbook wb = new HSSFWorkbook(myxls);
有了HSSFWorkbook實(shí)例，接下來(lái)就可以提取工作表、工作表的行和列，例如：
HSSFSheet sheet = wb.getSheetAt(0); // 第一個(gè)工作表
HSSFRow row = sheet.getRow(2); // 第三行
HSSFCell cell = row.getCell((short)3); // 第四個(gè)單元格
上面這段代碼提取出第一個(gè)工作表第三行第四單元格。利用單元格對(duì)象可以獲得它的值，提取單元格的值時(shí)請(qǐng)注意它的類型：
if (cell.getCellType() == HSSFCell.CELL_TYPE_STRING) {
("單元格是字符串，值是： " + cell.getStringCellValue());
} else if (cell.getCellType() == HSSFCell.CELL_TYPE_NUMERIC) {
("單元格是數(shù)字，值是： " + cell.getCellValue());
} else () {
("單元格的值不是字符串或數(shù)值。");
}
如果搞錯(cuò)了數(shù)據(jù)類型，程序?qū)⒂龅疆惓！Ｌ貏e地，用HSSF處理日期數(shù)據(jù)要小心。Excel內(nèi)部以數(shù)值的形式保存日期數(shù)據(jù)，區(qū)別日期數(shù)據(jù)的唯一辦法是通過(guò)單元格的格式（如果你曾經(jīng)在Excel中設(shè)置過(guò)日期格式，應(yīng)該明白這是什么意思）。
因此，對(duì)于包含日期數(shù)據(jù)的單元格，cell.getCellType()將返回HSSFCell.CELL_TYPE_NUMERIC，不過(guò)利用工具函數(shù)HSSFDateUtil.isCellDateFormatted(cell)可以判斷出單元格的值是否為日期。isCellDateFormatted函數(shù)通過(guò)比較單元格的日期和Excel的內(nèi)置日期格式得出結(jié)論??可以想象，按照這種判斷方法，很多時(shí)候isCellDateFormatted函數(shù)會(huì)返回否定的結(jié)論，存在一定的誤判可能。
本文附錄包含了一個(gè)在Servlet環(huán)境中利用HSSF創(chuàng)建和返回Excel工作簿的實(shí)例。
四、通過(guò)usermodel寫入文件
寫入XLS文件比讀取XLS文件還要簡(jiǎn)單。創(chuàng)建一個(gè)HSSFWorkbook實(shí)例，然后在適當(dāng)?shù)臅r(shí)候創(chuàng)建一個(gè)把文件寫入磁盤的OutputStream，但延遲到處理結(jié)束時(shí)創(chuàng)建OutputStream也可以：
HSSFWorkbook wb = new HSSFWorkbook();
FileOutputStream fileOut
= new FileOutputStream("workbook.xls");
wb.write(fileOut);
fileOut.close();
創(chuàng)建工作表及其內(nèi)容必須從相應(yīng)的父對(duì)象出發(fā)，例如：
HSSFSheet sheet = wb.createSheet();
HSSFRow row = sheet.createRow((short)0);
HSSFCell cell = row.createCell((short)0);
cell.setCellValue(1);
row.createCell((short)1).setCellValue(1.2);
row.createCell((short)2).setCellValue("一個(gè)字符串");
row.createCell((short)3).setCellValue(true);
如果要設(shè)置單元格的樣式，首先要?jiǎng)?chuàng)建一個(gè)樣式對(duì)象，然后把它指定給一個(gè)單元格??或者把它指定給多個(gè)具有相同樣式的單元格，例如，如果Excel表格中有一個(gè)摘要行，摘要行的數(shù)據(jù)必須是粗體、斜體，你可以創(chuàng)建一個(gè)summaryRowStyle樣式對(duì)象，然后把這個(gè)樣式指定給所有摘要行上的單元格。
注意，CellFormat和CellStyle對(duì)象是工作簿對(duì)象的成員，單元格對(duì)象只是引用它們。
...
HSSFCellStyle style = workbook.createCellStyle();
style.setDataFormat
(HSSFDataFormat.getBuiltinFormat("($#,##0_);[Red]($#,##0)"));
style.setFillBackgroundColor(HSSFColor.AQUA.index);
style.setFillPattern(HSSFCellStyle.BIG_SPOTS);
...
someCell.setCellStyle(style);
someOtherCell.setCellStyle(style);
版本較新的HSSF允許使用數(shù)量有限的Excel公式。這一功能目前還是“Beta級(jí)質(zhì)量”，正式使用之前務(wù)必仔細(xì)測(cè)試。指定公式的方式類如：someCell.setCellFormula(SUM(A1:A2:);。
當(dāng)前，公式中已經(jīng)可以調(diào)用所有內(nèi)建的函數(shù)或操作符，但邏輯操作符和函數(shù)（例如IF函數(shù)）除外，這部分功能目前還在開(kāi)發(fā)之中。
五、通過(guò)eventusermodel讀取文件
通過(guò)eventusermodel讀取文件要比使用usermodel復(fù)雜得多，但效率也要高不少，因?yàn)樗髴?yīng)用程序一邊讀取數(shù)據(jù)，一邊處理數(shù)據(jù)。
eventusermodel實(shí)際上模擬了DOM環(huán)境下SAX處理XML文檔的辦法，應(yīng)用程序首先要注冊(cè)期望處理的數(shù)據(jù)，eventusermodel將在遇到匹配的數(shù)據(jù)結(jié)構(gòu)時(shí)回調(diào)應(yīng)用程序注冊(cè)的方法。使用eventusermodel最大的困難在于你必須熟悉Excel工作簿的內(nèi)部結(jié)構(gòu)。
在HSSF中，低層次的二進(jìn)制結(jié)構(gòu)稱為記錄（Record）。記錄有不同的類型，每一種類型由org.apache.poi.hssf.record包中的一個(gè)Java類描述。例如，BOFRecord記錄表示W(wǎng)orkbook或Sheet區(qū)域的開(kāi)始，RowRecord表示有一個(gè)行存在并保存其樣式信息。
所有具有CellValueRecordInterface接口的記錄表示Excel的單元格，包括NumericRecord、LabelSSTRecord和FormulaRecord（還有其他一些，其中部分已被棄置不用，部分用于優(yōu)化處理，但一般而言，HSSF可以轉(zhuǎn)換它們）。
下面是一個(gè)注冊(cè)事件處理句柄的例子：
private EventRecordFactory factory = new EventRecordFactory();
factory.registerListener(new ERFListener() {
public boolean processRecord(Record rec) {
(got BOF Record);
return true;
}
}, new short[] {BOFRecord.sid});
factory.processRecords(someInputStream);
六、HSSF電子表格結(jié)構(gòu)
如前所述，HSSF建立在POIFS的基礎(chǔ)上。具體地說(shuō)，Excel 97+文件是OLE 2復(fù)合文檔（ OLE 2 Compound Document），底層的OLE 2復(fù)合文檔保存了一個(gè)總是命名為Workbook（Excel 95除外，HSSF不支持Excel 95）的流。
然而，宏和圖片并不保存在Workbook流，它們有自己獨(dú)立的流，有時(shí)甚至?xí)诺絆LE 2 CDF文件之內(nèi)的另一個(gè)目錄。理想情況下，宏也應(yīng)該被保留，不過(guò)目前POI項(xiàng)目中還沒(méi)有合適的API來(lái)處理宏。
每一個(gè)流之內(nèi)是一組記錄，一個(gè)記錄其實(shí)就是一個(gè)字節(jié)數(shù)組，可分為記錄頭、記錄體兩部分。記錄頭指明了記錄的類型（也即ID）以及后繼數(shù)據(jù)的長(zhǎng)度，記錄體被分割成多個(gè)字段（Field），字段包含數(shù)值數(shù)據(jù)（包括對(duì)其他記錄的引用）、字符數(shù)據(jù)或標(biāo)記。
Excel工作簿的頂級(jí)結(jié)構(gòu)：
Bla.xls {
OLE2CDF headers
"Workbook" stream {
Workbook {
Static String Table Record..
Sheet names… and pointers
}
Sheet {
ROW
ROW
…
NUMBER RECORD (cell)
LABELSST Record (cell)
…
}
Sheet
}
}
… images, macros, etc.
Document Summary
Summary
七、通過(guò)HPSF讀取文檔屬性
在Microsoft Word、Excel、PowerPoint等軟件中，用戶可以通過(guò)“文件”→“屬性”菜單給文檔添加附加信息，包括文檔的標(biāo)題、主題、摘要、類別、關(guān)鍵詞等，同時(shí)應(yīng)用軟件本身還會(huì)加入最后訪問(wèn)的用戶、最后訪問(wèn)和修改/打印的日期時(shí)間等信息。
文檔的屬性和正文是分開(kāi)保存的。如前所述，OLE 2 CDF文件內(nèi)部就象是一個(gè)容器，里面包含許多類似目錄和文件的結(jié)構(gòu)，而POIFS就是用來(lái)訪問(wèn)其中的文件的工具。這些文件也稱為流，文檔的屬性就保存在POIFS文件系統(tǒng)中專用的流里面。
以一個(gè)Word文檔為例：雖然在資源管理器中你只看到一個(gè)叫做MyFile.doc的文檔，其實(shí)在這個(gè)文檔的內(nèi)部，又包含了一個(gè)WordDocument、一個(gè)SummaryInformation和一個(gè)DocumentSummaryInformation文檔；通常還會(huì)有其他的文檔，這里暫且不管。
你能夠猜出這些文檔（流）分別包含什么內(nèi)容嗎？不錯(cuò)，WordDocument包含了你在Word里面編輯的文本，文檔的屬性保存在SummaryInformation和DocumentSummaryInformation流里面。也許將所有屬性保存在單個(gè)文檔里面看起來(lái)太簡(jiǎn)單了，所以Microsoft決心要使用兩個(gè)流，為了使事情更復(fù)雜一點(diǎn)，這兩個(gè)流的名字前面還加上了八進(jìn)制的\005字符??這是一個(gè)不可打印的字符，因此前面就把它省略了。
Microsoft定義的標(biāo)準(zhǔn)屬性有一個(gè)好處，它們并不在乎主文檔到底是什么類型??不管是Word文檔、Excel工作簿還是PowerPoint幻燈。只要你知道如何讀取Excel文檔的屬性，就知道了如何讀取其他文檔的屬性。
讀取文檔屬性其實(shí)并不復(fù)雜，因?yàn)镴ava程序可以利用POI項(xiàng)目的HPSF包。HPSF是 Horrible Property Set Format的縮寫，譯成中文就是“討厭的屬性集格式”。HPSF包是POI項(xiàng)目實(shí)現(xiàn)的讀取屬性工具，目前還不支持屬性寫入。
對(duì)于讀取Microsoft定義的標(biāo)準(zhǔn)屬性，通過(guò)HPSF提供的API可以很方便地辦到；但如果要讀取任意屬性集就要用到更一般化的API，可以想象它要比讀取標(biāo)準(zhǔn)屬性的API復(fù)雜不少。本文只介紹讀取標(biāo)準(zhǔn)屬性的簡(jiǎn)單API，因?yàn)閷?duì)大多數(shù)應(yīng)用程序來(lái)說(shuō)這已經(jīng)完全足夠了。
下面就是一個(gè)讀取OLE 2 CDF文檔的標(biāo)題（title）屬性的Java程序：
import java.io.*;
import org.apache.poi.hpsf.*;
import org.apache.poi.poifs.eventfilesystem.*;
/**
* 讀取OLE 2文檔標(biāo)題的示例程序，
* 在命令行參數(shù)中指定文檔的文件名字。
*/
public class ReadTitle
{
public static void main(String[] args) throws IOException
{
final String filename = args[0];
POIFSReader r = new POIFSReader();
r.registerListener(new MyPOIFSReaderListener(),
"\005SummaryInformation");
r.read(new FileInputStream(filename));
}
static class MyPOIFSReaderListener
implements POIFSReaderListener
{
public void processPOIFSReaderEvent(POIFSReaderEvent event)
{
SummaryInformation si = null;
try
{
si = (SummaryInformation)
PropertySetFactory.create(event.getStream());
}
catch (Exception ex)
{
throw new RuntimeException
("屬性集流\"" + event.getPath() +
event.getName() + "\": " + ex);
}
final String title = si.getTitle();
if (title != null)
System.out.println("標(biāo)題: \"" + title + "\"");
else
System.out.println("該文檔沒(méi)有標(biāo)題.");
}
}
}
main()方法利用POIFS的事件系統(tǒng)從命令行指定的OLE 2文檔讀取名為\005SummaryInformation的流，當(dāng)POIFSReader 遇到這個(gè)流時(shí)，它把控制傳遞給MyPOIFSReaderListener的processPOIFSReaderEvent()方法。
processPOIFSReaderEvent()到底有什么用呢？它通過(guò)參數(shù)獲得一個(gè)輸入流，該輸入流包含了文檔標(biāo)題等屬性。為了訪問(wèn)文檔的屬性，我們從輸入流創(chuàng)建一個(gè)PropertySet實(shí)例，如下所示：
si = (SummaryInformation) PropertySetFactory.create(event.getStream());
這個(gè)語(yǔ)句其實(shí)包含三個(gè)步驟的操作：
◆ event.getStream()從POIFSReader傳入的POIFSReaderEvent獲得輸入流。
◆ 以剛才獲得的輸入流為參數(shù)，調(diào)用PropertySetFactory的靜態(tài)方法create()。正如其名字所暗示的，PropertySetFactory是一個(gè)工廠類，它有一臺(tái)“機(jī)器”能夠把一個(gè)輸入流轉(zhuǎn)換成一個(gè)PropertySet實(shí)例，這臺(tái)機(jī)器就是create()方法。
◆ 把create()方法返回的PropertySet定型（cast）成為SummaryInformation。PropertySet提供了按照一般辦法讀取屬性集的各種機(jī)制，SummaryInformation是PropertySet的子類，即SummaryInformation類在PropertySet類的基礎(chǔ)上增加了操作Microsoft標(biāo)準(zhǔn)屬性的便捷方法。
在這個(gè)處理過(guò)程中，可能引起錯(cuò)誤的因素很多，因此我們把這部分內(nèi)容放入了一個(gè)try塊，不過(guò)這個(gè)示例程序只按照最簡(jiǎn)單的方式處理了異常，在實(shí)際應(yīng)用中，最好能夠?qū)赡艹霈F(xiàn)的不同異常類型分別處理。
除了一般的I/O異常之外，還有可能遇到HPSF特有的異常，例如，如果輸入流不包含屬性集或?qū)傩约欠ǎ蜁?huì)拋出NoPropertySetStreamException異常。
有一種錯(cuò)誤不太常見(jiàn)，但也不是絕無(wú)可能\005SummaryInformation包含一個(gè)合法的屬性集，但不是摘要信息屬性集。如果出現(xiàn)這種情況，則定型成SummaryInformation操作會(huì)失敗，引發(fā)ClassCastException異常。
獲得SummaryInformation實(shí)例之后，剩下的事情就很簡(jiǎn)單了，只要調(diào)用getTitle()方法，然后輸出結(jié)果。
除了getTitle()之外，SummaryInformation還包含其他一些便捷方法，例如getApplicationName()、getAuthor()、getCharCount()、和getCreateDateTime()等。HPSF的JavaDoc文檔詳細(xì)說(shuō)明了所有這些方法。
八、文檔摘要信息
遺憾的是，并非所有的屬性都保存在摘要信息屬性集之中。許多（但不是全部）OLE 2文件還有另一個(gè)屬性集，稱為“文檔摘要信息”，對(duì)應(yīng)的流是\005DocumentSummaryInformation。這個(gè)屬性集保存的屬性包括文檔的類別、PowerPoint幻燈的多媒體剪輯數(shù)量，等等。
要訪問(wèn)文檔摘要信息屬性集，程序的處理過(guò)程也和上例相似，只是注冊(cè)的目標(biāo)應(yīng)該改成\005DocumentSummaryInformation有時(shí)，你可能想要同時(shí)注冊(cè)到摘要信息和文檔摘要信息這兩個(gè)流。其余的處理方式和前面的例子差不多，你應(yīng)該把包含文檔摘要信息的流傳遞給PropertySetFactory.create()，但這次工廠方法將返回一個(gè)DocumentSummaryInformation對(duì)象（而不是前面例子中的SummaryInformation對(duì)象）。
如果同時(shí)注冊(cè)到了兩個(gè)流，注意檢查返回值的具體類型，或者使用Java的instanceof操作符，或者使用專用的isSummaryInformation()和isDocumentSummaryInformation()方法。記住，create()方法返回的總是一個(gè)PropertySet對(duì)象，因此你總是可以對(duì)create()返回對(duì)象調(diào)用isSummaryInformation()和isDocumentSummaryInformation()方法，PropertySet類之所以要提供這兩個(gè)方法，是因?yàn)閷傩约赡苁亲远x的。
如果你想要處理自定義的屬性集，或者要從標(biāo)準(zhǔn)的屬性集讀取用戶定義的屬性，必須使用一個(gè)更一般化的API，前面已經(jīng)提到，這個(gè)API要復(fù)雜得多，本文不再討論，請(qǐng)參見(jiàn)HPSF的HOW-TO文檔和POI的文檔。
結(jié)束語(yǔ)：本文探討了HSSF的應(yīng)用以及如何輸出到Excel文件，另外還涉及了HPSF以及如何讀取屬性集文檔摘要信息。POI是一個(gè)功能非常強(qiáng)大的項(xiàng)目，許多主題本文尚未涉及，例如如何用HSSF Serializer將XML文檔轉(zhuǎn)換成Excel格式等，這一切仍有待您去研究了。
九、附錄
實(shí)例：利用Servlet創(chuàng)建和返回一個(gè)工作簿。
package org.apache.poi.hssf.usermodel.examples;
import java.io.*;
import java.net.*;
import javax.servlet.*;
import javax.servlet.http.*;
import org.apache.poi.hssf.usermodel.*;
public class HSSFCreate extends HttpServlet {
public void init(ServletConfig config)
throws ServletException {
super.init(config);
}
public void destroy() {
}
/** 處理HTTP GET 和POST請(qǐng)求
* @param request：請(qǐng)求
* @param response：應(yīng)答
*/
protected void processRequest(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("application/vnd.ms-excel");
HSSFWorkbook wb = new HSSFWorkbook();
HSSFSheet sheet = wb.createSheet("new sheet");
// 創(chuàng)建一個(gè)新的行，添加幾個(gè)單元格。
// 行號(hào)從0開(kāi)始計(jì)算
HSSFRow row = sheet.createRow((short)0);
// 創(chuàng)建一個(gè)單元格，設(shè)置單元格的值
HSSFCell cell = row.createCell((short)0);
cell.setCellValue(1);
row.createCell((short)1).setCellValue(1.2);
row.createCell((short)2).setCellValue("一個(gè)字符串值");
row.createCell((short)3).setCellValue(true);
// 寫入輸出結(jié)果
OutputStream out = response.getOutputStream();
wb.write(out);
out.close();
}
/** 處理HTTP GET請(qǐng)求
* @param request：請(qǐng)求
* @param response：應(yīng)答
*/
protected void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response);
}
/** 處理HTTP POST請(qǐng)求
* @param request：請(qǐng)求
* @param response：應(yīng)答
*/
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response);
}
/** 返回關(guān)于Servlet的簡(jiǎn)單說(shuō)明
*/
public String getServletInfo() {
return "示例：在Servlet中用HSSF創(chuàng)建Excel工作簿";
}
}