Posted on 2006-10-25 16:03
Hally 閱讀(2501)
評論(0) 編輯 收藏 所屬分類:
技術文章轉載
本文將闡述如何用POI來讀取/寫入完整的Excel文件。
約定：POI項目2.0版現在已經接近正式發行階段，開發進度迅速，不斷有新的功能集成到原有的系統，同時也有對原有系統的修改。
為了保證本文的及時性，本文將按照最近的1.9開發版說明。雖然編譯最近的發行版源代碼也能正常運行，但現在的代碼和2.0的發行版會有一些出入。
一、Excel基礎
Microsoft Excel 97文件格式也被稱為BIFF8，最近版本的Excel只對該格式作了少量的改動。增加對新格式的支持除了增加項目的復雜性之外，唯一的效果也許只是不得不使每個用戶升級代碼，沒有什么實際的好處。
因此，在下文說明中，凡是提到Excel 97格式的地方其實都是指Excel從97到XP的格式。
二、HSSF概況
POI項目實現的Excel 97文件格式稱為HSSF??也許你已經猜到，HSSF是Horrible SpreadSheet Format的縮寫，也即“討厭的電子表格格式”（微軟使某些原本簡單的事情過分復雜，同時又過分簡單地處理了某些原本需要靈活性的事情，讓人不勝佩服！）
也許HSSF的名字有點滑稽，就本質而言它是一個非常嚴肅、正規的API。通過HSSF，你可以用純Java代碼來讀取、寫入、修改Excel文件。
前面一篇文章提到了POIFS，那么HSSF和POIFS又有什么關系呢？就象其他POI的API一樣，HSSF建立在POIFS的基礎上，因此在HSSF內的有些代碼和前文的某些代碼很相似。不過，當我們編寫基于HSSF API的代碼時，一般不需要了解POIFS API的細節。
HSSF為讀取操作提供了兩類API：usermodel和eventusermodel，即“用戶模型”和“事件-用戶模型”。前者很好理解，后者比較抽象，但操作效率要高得多。usermodel主要有org.apache.poi.hssf.usermodel和org.apache.poi.hssf.eventusermodel包實現（在HSSF的早期版本中，org.apache.poi.hssf.eventusermodel屬于eventmodel包）。
usermodel包把Excel文件映射成我們熟悉的結構，諸如Workbook、Sheet、Row、Cell等，它把整個結構以一組對象的形式保存在內存之中。eventusermodel要求用戶熟悉文件格式的底層結構，它的操作風格類似于XML的SAX API和AWT的事件模型（這就是eventusermodel名稱的起源），要掌握竅門才能用好。
另外，eventusermodel的API只提供讀取文件的功能，也就是說不能用這個API來修改文件。
三、通過usermodel讀取文件
用HSSF的usermodel讀取文件很簡單。首先創建一個InputStream，然后創建一個HSSFWorkbook：
InputStream myxls = new FileInputStream("workbook.xls"));
HSSFWorkbook wb = new HSSFWorkbook(myxls);
有了HSSFWorkbook實例，接下來就可以提取工作表、工作表的行和列，例如：
HSSFSheet sheet = wb.getSheetAt(0); // 第一個工作表
HSSFRow row = sheet.getRow(2); // 第三行
HSSFCell cell = row.getCell((short)3); // 第四個單元格
上面這段代碼提取出第一個工作表第三行第四單元格。利用單元格對象可以獲得它的值，提取單元格的值時請注意它的類型：
if (cell.getCellType() == HSSFCell.CELL_TYPE_STRING) {
("單元格是字符串，值是： " + cell.getStringCellValue());
} else if (cell.getCellType() == HSSFCell.CELL_TYPE_NUMERIC) {
("單元格是數字，值是： " + cell.getCellValue());
} else () {
("單元格的值不是字符串或數值。");
}
如果搞錯了數據類型，程序將遇到異常。特別地，用HSSF處理日期數據要小心。Excel內部以數值的形式保存日期數據，區別日期數據的唯一辦法是通過單元格的格式（如果你曾經在Excel中設置過日期格式，應該明白這是什么意思）。
因此，對于包含日期數據的單元格，cell.getCellType()將返回HSSFCell.CELL_TYPE_NUMERIC，不過利用工具函數HSSFDateUtil.isCellDateFormatted(cell)可以判斷出單元格的值是否為日期。isCellDateFormatted函數通過比較單元格的日期和Excel的內置日期格式得出結論??可以想象，按照這種判斷方法，很多時候isCellDateFormatted函數會返回否定的結論，存在一定的誤判可能。
本文附錄包含了一個在Servlet環境中利用HSSF創建和返回Excel工作簿的實例。
四、通過usermodel寫入文件
寫入XLS文件比讀取XLS文件還要簡單。創建一個HSSFWorkbook實例，然后在適當的時候創建一個把文件寫入磁盤的OutputStream，但延遲到處理結束時創建OutputStream也可以：
HSSFWorkbook wb = new HSSFWorkbook();
FileOutputStream fileOut
= new FileOutputStream("workbook.xls");
wb.write(fileOut);
fileOut.close();
創建工作表及其內容必須從相應的父對象出發，例如：
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("一個字符串");
row.createCell((short)3).setCellValue(true);
如果要設置單元格的樣式，首先要創建一個樣式對象，然后把它指定給一個單元格??或者把它指定給多個具有相同樣式的單元格，例如，如果Excel表格中有一個摘要行，摘要行的數據必須是粗體、斜體，你可以創建一個summaryRowStyle樣式對象，然后把這個樣式指定給所有摘要行上的單元格。
注意，CellFormat和CellStyle對象是工作簿對象的成員，單元格對象只是引用它們。
...
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允許使用數量有限的Excel公式。這一功能目前還是“Beta級質量”，正式使用之前務必仔細測試。指定公式的方式類如：someCell.setCellFormula(SUM(A1:A2:);。
當前，公式中已經可以調用所有內建的函數或操作符，但邏輯操作符和函數（例如IF函數）除外，這部分功能目前還在開發之中。
五、通過eventusermodel讀取文件
通過eventusermodel讀取文件要比使用usermodel復雜得多，但效率也要高不少，因為它要求應用程序一邊讀取數據，一邊處理數據。
eventusermodel實際上模擬了DOM環境下SAX處理XML文檔的辦法，應用程序首先要注冊期望處理的數據，eventusermodel將在遇到匹配的數據結構時回調應用程序注冊的方法。使用eventusermodel最大的困難在于你必須熟悉Excel工作簿的內部結構。
在HSSF中，低層次的二進制結構稱為記錄（Record）。記錄有不同的類型，每一種類型由org.apache.poi.hssf.record包中的一個Java類描述。例如，BOFRecord記錄表示Workbook或Sheet區域的開始，RowRecord表示有一個行存在并保存其樣式信息。
所有具有CellValueRecordInterface接口的記錄表示Excel的單元格，包括NumericRecord、LabelSSTRecord和FormulaRecord（還有其他一些，其中部分已被棄置不用，部分用于優化處理，但一般而言，HSSF可以轉換它們）。
下面是一個注冊事件處理句柄的例子：
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電子表格結構
如前所述，HSSF建立在POIFS的基礎上。具體地說，Excel 97+文件是OLE 2復合文檔（ OLE 2 Compound Document），底層的OLE 2復合文檔保存了一個總是命名為Workbook（Excel 95除外，HSSF不支持Excel 95）的流。
然而，宏和圖片并不保存在Workbook流，它們有自己獨立的流，有時甚至會放到OLE 2 CDF文件之內的另一個目錄。理想情況下，宏也應該被保留，不過目前POI項目中還沒有合適的API來處理宏。
每一個流之內是一組記錄，一個記錄其實就是一個字節數組，可分為記錄頭、記錄體兩部分。記錄頭指明了記錄的類型（也即ID）以及后繼數據的長度，記錄體被分割成多個字段（Field），字段包含數值數據（包括對其他記錄的引用）、字符數據或標記。
Excel工作簿的頂級結構：
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
七、通過HPSF讀取文檔屬性
在Microsoft Word、Excel、PowerPoint等軟件中，用戶可以通過“文件”→“屬性”菜單給文檔添加附加信息，包括文檔的標題、主題、摘要、類別、關鍵詞等，同時應用軟件本身還會加入最后訪問的用戶、最后訪問和修改/打印的日期時間等信息。
文檔的屬性和正文是分開保存的。如前所述，OLE 2 CDF文件內部就象是一個容器，里面包含許多類似目錄和文件的結構，而POIFS就是用來訪問其中的文件的工具。這些文件也稱為流，文檔的屬性就保存在POIFS文件系統中專用的流里面。
以一個Word文檔為例：雖然在資源管理器中你只看到一個叫做MyFile.doc的文檔，其實在這個文檔的內部，又包含了一個WordDocument、一個SummaryInformation和一個DocumentSummaryInformation文檔；通常還會有其他的文檔，這里暫且不管。
你能夠猜出這些文檔（流）分別包含什么內容嗎？不錯，WordDocument包含了你在Word里面編輯的文本，文檔的屬性保存在SummaryInformation和DocumentSummaryInformation流里面。也許將所有屬性保存在單個文檔里面看起來太簡單了，所以Microsoft決心要使用兩個流，為了使事情更復雜一點，這兩個流的名字前面還加上了八進制的\005字符??這是一個不可打印的字符，因此前面就把它省略了。
Microsoft定義的標準屬性有一個好處，它們并不在乎主文檔到底是什么類型??不管是Word文檔、Excel工作簿還是PowerPoint幻燈。只要你知道如何讀取Excel文檔的屬性，就知道了如何讀取其他文檔的屬性。
讀取文檔屬性其實并不復雜，因為Java程序可以利用POI項目的HPSF包。HPSF是 Horrible Property Set Format的縮寫，譯成中文就是“討厭的屬性集格式”。HPSF包是POI項目實現的讀取屬性工具，目前還不支持屬性寫入。
對于讀取Microsoft定義的標準屬性，通過HPSF提供的API可以很方便地辦到；但如果要讀取任意屬性集就要用到更一般化的API，可以想象它要比讀取標準屬性的API復雜不少。本文只介紹讀取標準屬性的簡單API，因為對大多數應用程序來說這已經完全足夠了。
下面就是一個讀取OLE 2 CDF文檔的標題（title）屬性的Java程序：
import java.io.*;
import org.apache.poi.hpsf.*;
import org.apache.poi.poifs.eventfilesystem.*;
/**
* 讀取OLE 2文檔標題的示例程序，
* 在命令行參數中指定文檔的文件名字。
*/
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("標題: \"" + title + "\"");
else
System.out.println("該文檔沒有標題.");
}
}
}
main()方法利用POIFS的事件系統從命令行指定的OLE 2文檔讀取名為\005SummaryInformation的流，當POIFSReader 遇到這個流時，它把控制傳遞給MyPOIFSReaderListener的processPOIFSReaderEvent()方法。
processPOIFSReaderEvent()到底有什么用呢？它通過參數獲得一個輸入流，該輸入流包含了文檔標題等屬性。為了訪問文檔的屬性，我們從輸入流創建一個PropertySet實例，如下所示：
si = (SummaryInformation) PropertySetFactory.create(event.getStream());
這個語句其實包含三個步驟的操作：
◆ event.getStream()從POIFSReader傳入的POIFSReaderEvent獲得輸入流。
◆ 以剛才獲得的輸入流為參數，調用PropertySetFactory的靜態方法create()。正如其名字所暗示的，PropertySetFactory是一個工廠類，它有一臺“機器”能夠把一個輸入流轉換成一個PropertySet實例，這臺機器就是create()方法。
◆ 把create()方法返回的PropertySet定型（cast）成為SummaryInformation。PropertySet提供了按照一般辦法讀取屬性集的各種機制，SummaryInformation是PropertySet的子類，即SummaryInformation類在PropertySet類的基礎上增加了操作Microsoft標準屬性的便捷方法。
在這個處理過程中，可能引起錯誤的因素很多，因此我們把這部分內容放入了一個try塊，不過這個示例程序只按照最簡單的方式處理了異常，在實際應用中，最好能夠對可能出現的不同異常類型分別處理。
除了一般的I/O異常之外，還有可能遇到HPSF特有的異常，例如，如果輸入流不包含屬性集或屬性集非法，就會拋出NoPropertySetStreamException異常。
有一種錯誤不太常見，但也不是絕無可能\005SummaryInformation包含一個合法的屬性集，但不是摘要信息屬性集。如果出現這種情況，則定型成SummaryInformation操作會失敗，引發ClassCastException異常。
獲得SummaryInformation實例之后，剩下的事情就很簡單了，只要調用getTitle()方法，然后輸出結果。
除了getTitle()之外，SummaryInformation還包含其他一些便捷方法，例如getApplicationName()、getAuthor()、getCharCount()、和getCreateDateTime()等。HPSF的JavaDoc文檔詳細說明了所有這些方法。
八、文檔摘要信息
遺憾的是，并非所有的屬性都保存在摘要信息屬性集之中。許多（但不是全部）OLE 2文件還有另一個屬性集，稱為“文檔摘要信息”，對應的流是\005DocumentSummaryInformation。這個屬性集保存的屬性包括文檔的類別、PowerPoint幻燈的多媒體剪輯數量，等等。
要訪問文檔摘要信息屬性集，程序的處理過程也和上例相似，只是注冊的目標應該改成\005DocumentSummaryInformation有時，你可能想要同時注冊到摘要信息和文檔摘要信息這兩個流。其余的處理方式和前面的例子差不多，你應該把包含文檔摘要信息的流傳遞給PropertySetFactory.create()，但這次工廠方法將返回一個DocumentSummaryInformation對象（而不是前面例子中的SummaryInformation對象）。
如果同時注冊到了兩個流，注意檢查返回值的具體類型，或者使用Java的instanceof操作符，或者使用專用的isSummaryInformation()和isDocumentSummaryInformation()方法。記住，create()方法返回的總是一個PropertySet對象，因此你總是可以對create()返回對象調用isSummaryInformation()和isDocumentSummaryInformation()方法，PropertySet類之所以要提供這兩個方法，是因為屬性集可能是自定義的。
如果你想要處理自定義的屬性集，或者要從標準的屬性集讀取用戶定義的屬性，必須使用一個更一般化的API，前面已經提到，這個API要復雜得多，本文不再討論，請參見HPSF的HOW-TO文檔和POI的文檔。
結束語：本文探討了HSSF的應用以及如何輸出到Excel文件，另外還涉及了HPSF以及如何讀取屬性集文檔摘要信息。POI是一個功能非常強大的項目，許多主題本文尚未涉及，例如如何用HSSF Serializer將XML文檔轉換成Excel格式等，這一切仍有待您去研究了。
九、附錄
實例：利用Servlet創建和返回一個工作簿。
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請求
* @param request：請求
* @param response：應答
*/
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");
// 創建一個新的行，添加幾個單元格。
// 行號從0開始計算
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("一個字符串值");
row.createCell((short)3).setCellValue(true);
// 寫入輸出結果
OutputStream out = response.getOutputStream();
wb.write(out);
out.close();
}
/** 處理HTTP GET請求
* @param request：請求
* @param response：應答
*/
protected void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response);
}
/** 處理HTTP POST請求
* @param request：請求
* @param response：應答
*/
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response);
}
/** 返回關于Servlet的簡單說明
*/
public String getServletInfo() {
return "示例：在Servlet中用HSSF創建Excel工作簿";
}
}