Apache POI 教程

教程

Java

欢迎来到Apache POI教程。有时我们需要从Microsoft Excel文件中读取数据，或者我们需要生成Excel格式的报告，主要用于商业或财务目的。Java不提供与Excel文件一起工作的内置支持，因此我们需要寻找开源API来完成这项工作。当我开始寻找Java用于Excel的API时，大多数人推荐使用JExcel或Apache POI。经过进一步研究，我发现Apache POI是前进的方式，主要原因如下。还有一些与高级功能相关的其他原因，但我们不要深入讨论这些。

Apache基金会的支持。
JExcel不支持xlsx格式，而POI支持xls和xlsx格式。
Apache POI提供基于流的处理，适用于大文件，并且需要更少的内存。

Apache POI

Apache POI提供了与Microsoft Excel文档一起工作的出色支持。Apache POI能够处理电子表格的XLS和XLSX格式。有关Apache POI API的一些重要点是：

Apache POI包含用于Excel ’97(-2007)文件格式即XLS的HSSF实现。
应使用Apache POI XSSF实现来处理Excel 2007 OOXML（.xlsx）文件格式。
Apache POI HSSF和XSSF API提供了读取、写入或修改Excel电子表格的机制。
Apache POI还提供了SXSSF API，这是XSSF的扩展，用于处理非常大的Excel表格。SXSSF API需要更少的内存，在处理非常大的电子表格且堆内存有限时非常适用。
有两种模型可供选择 – 事件模型和用户模型。事件模型需要更少的内存，因为Excel文件是以标记形式读取并需要处理这些标记。用户模型更加面向对象且易于使用，在我们的示例中我们将使用它。
Apache POI为处理额外的Excel功能提供了出色的支持，如处理公式、通过填充颜色和边框创建单元格样式、字体、页眉和页脚、数据验证、图像、超链接等。

Apache POI Maven依赖

如果您正在使用Maven，添加如下Apache POI依赖项。

<dependency>
	<groupId>org.apache.poi</groupId>
	<artifactId>poi</artifactId>
	<version>3.10-FINAL</version>
</dependency>
<dependency>
	<groupId>org.apache.poi</groupId>
	<artifactId>poi-ooxml</artifactId>
	<version>3.10-FINAL</version>
</dependency>

当前版本的Apache POI是3.10-FINAL。如果您正在使用独立的Java应用程序，请包含下图中的jar包。

Apache POI示例 – 读取Excel文件

假设我们有一个名为“Sample.xlsx”的Excel文件，其中包含两个工作表，并且具有如下图所示的数据。我们想要读取这个Excel文件并创建国家列表。Sheet1有一些额外的数据，我们在解析时将忽略它。我们的Country Java Bean代码如下：Country.java

package com.journaldev.excel.read;

public class Country {

	private String name;
	private String shortCode;
	
	public Country(String n, String c){
		this.name=n;
		this.shortCode=c;
	}
	
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getShortCode() {
		return shortCode;
	}
	public void setShortCode(String shortCode) {
		this.shortCode = shortCode;
	}
	
	@Override
	public String toString(){
		return name + "::" + shortCode;
	}
	
}

Apache POI示例程序用于将Excel文件读取到国家列表中，代码如下：ReadExcelFileToList.java

package com.journaldev.excel.read;

import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class ReadExcelFileToList {

	public static List readExcelData(String fileName) {
		List countriesList = new ArrayList();
		
		try {
			//从xlsx/xls文件创建输入流
			FileInputStream fis = new FileInputStream(fileName);
			
			//为xlsx/xls文件输入流创建Workbook实例
			Workbook workbook = null;
			if(fileName.toLowerCase().endsWith("xlsx")){
				workbook = new XSSFWorkbook(fis);
			}else if(fileName.toLowerCase().endsWith("xls")){
				workbook = new HSSFWorkbook(fis);
			}
			
			//获取xlsx文件中的工作表数
			int numberOfSheets = workbook.getNumberOfSheets();
			
			//循环遍历每个工作表
			for(int i=0; i < numberOfSheets; i++){
				
				//从workbook获取第n个工作表
				Sheet sheet = workbook.getSheetAt(i);
				
				//每个工作表都有行，对它们进行迭代
				Iterator rowIterator = sheet.iterator();
				while (rowIterator.hasNext()) 
		        {
					String name = "";
					String shortCode = "";
					
					//获取行对象
					Row row = rowIterator.next();
					
					//每一行都有列，获取列迭代器并对其进行迭代
					Iterator cellIterator = row.cellIterator();
		             
		            while (cellIterator.hasNext()) 
		            {
		            	//获取Cell对象
		            	Cell cell = cellIterator.next();
		            	
		            	//检查单元格类型并相应处理
		            	switch(cell.getCellType()){
		            	case Cell.CELL_TYPE_STRING:
		            		if(shortCode.equalsIgnoreCase("")){
		            			shortCode = cell.getStringCellValue().trim();
		            		}else if(name.equalsIgnoreCase("")){
		            			//第2列
		            			name = cell.getStringCellValue().trim();
		            		}else{
		            			//随机数据，忽略
		            			System.out.println("Random data::"+cell.getStringCellValue());
		            		}
		            		break;
		            	case Cell.CELL_TYPE_NUMERIC:
		            		System.out.println("Random data::"+cell.getNumericCellValue());
		            	}
		            } //end of cell iterator
		            Country c = new Country(name, shortCode);
		            countriesList.add(c);
		        } //end of rows iterator
				
				
			} //end of sheets for loop
			
			//关闭文件输入流
			fis.close();
			
		} catch (IOException e) {
			e.printStackTrace();
		}
		
		return countriesList;
	}

	public static void main(String args[]){
		List list = readExcelData("Sample.xlsx");
		System.out.println("Country List\n"+list);
	}

}

该程序非常易于理解，包含以下步骤：

创建基于文件类型的Workbook实例。XSSFWorkbook用于xlsx格式，HSSFWorkbook用于xls格式。注意，我们可以使用工厂模式创建包装类，根据文件名获取工作簿实例。
使用workbook的getNumberOfSheets()方法获取工作表数量，然后使用for循环解析每个工作表。使用getSheetAt(int i)方法获取Sheet实例。
获取Row迭代器，然后获取Cell迭代器以获取Cell对象。Apache POI在这里使用迭代器模式。
使用switch-case读取Cell的类型并相应地处理。

现在运行上述Apache POI示例程序，它在控制台上产生以下输出。

Random data::1.0
Random data::2.0
Random data::3.0
Random data::4.0
Country List
[India::IND, Afghanistan::AFG, United States of America::USA, Anguilla::AIA, 
Denmark ::DNK, Dominican Republic ::DOM, Algeria ::DZA, Ecuador ::ECU]

Apache POI示例 – 写入Excel文件

编写使用Apache POI的Excel文件类似于读取，除了这里我们首先创建工作簿。然后设置表、行和单元格的值，并使用FileOutputStream将其写入文件。让我们编写一个简单的Apache POI示例，我们将使用上述方法中的国家列表保存到另一个文件中的单个工作表中。 WriteListToExcelFile.java

package com.journaldev.excel.read;

import java.io.FileOutputStream;
import java.util.Iterator;
import java.util.List;

import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class WriteListToExcelFile {

	public static void writeCountryListToFile(String fileName, List countryList) throws Exception{
		Workbook workbook = null;
		
		if(fileName.endsWith("xlsx")){
			workbook = new XSSFWorkbook();
		}else if(fileName.endsWith("xls")){
			workbook = new HSSFWorkbook();
		}else{
			throw new Exception("invalid file name, should be xls or xlsx");
		}
		
		Sheet sheet = workbook.createSheet("Countries");
		
		Iterator iterator = countryList.iterator();
		
		int rowIndex = 0;
		while(iterator.hasNext()){
			Country country = iterator.next();
			Row row = sheet.createRow(rowIndex++);
			Cell cell0 = row.createCell(0);
			cell0.setCellValue(country.getName());
			Cell cell1 = row.createCell(1);
			cell1.setCellValue(country.getShortCode());
		}
		
		//现在将Excel数据写入文件
		FileOutputStream fos = new FileOutputStream(fileName);
		workbook.write(fos);
		fos.close();
		System.out.println(fileName + " written successfully");
	}
	
	public static void main(String args[]) throws Exception{
		List list = ReadExcelFileToList.readExcelData("Sample.xlsx");
		WriteListToExcelFile.writeCountryListToFile("Countries.xls", list);
	}
}

当我执行上面的Apache POI示例程序时，生成的Excel文件如下图所示。

Apache POI示例 – 读取Excel公式

有时我们需要处理带有公式的复杂Excel文件，让我们看一个简单的Apache POI示例，读取带有其值的单元格的公式。 ReadExcelFormula.java

package com.journaldev.excel.read;

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Iterator;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class ReadExcelFormula {

	public static void readExcelFormula(String fileName) throws IOException{
		
		FileInputStream fis = new FileInputStream(fileName);
		
		//假设是xlsx文件
		Workbook workbook = new XSSFWorkbook(fis);
		Sheet sheet = workbook.getSheetAt(0);
		Iterator rowIterator = sheet.iterator();
		while (rowIterator.hasNext()) 
        {
			Row row = rowIterator.next();
			Iterator cellIterator = row.cellIterator();
            
            while (cellIterator.hasNext()) 
            {
            	Cell cell = cellIterator.next();
            	switch(cell.getCellType()){
            	case Cell.CELL_TYPE_NUMERIC:
            		System.out.println(cell.getNumericCellValue());
            		break;
            	case Cell.CELL_TYPE_FORMULA:
            		System.out.println("Cell Formula="+cell.getCellFormula());
            		System.out.println("Cell Formula Result Type="+cell.getCachedFormulaResultType());
            		if(cell.getCachedFormulaResultType() == Cell.CELL_TYPE_NUMERIC){
            			System.out.println("Formula Value="+cell.getNumericCellValue());
            		}
            	}
            }
        }
	}
	
	public static void main(String args[]) throws IOException {
		readExcelFormula("FormulaMultiply.xlsx");
	}
}

当我们执行上面的Apache POI示例程序时，我们得到以下输出。

1.0
2.0
3.0
4.0
Cell Formula=A1*A2*A3*A4
Cell Formula Result Type=0
Formula Value=24.0

Apache POI示例 – Excel写入公式

有时，我们需要进行一些计算，然后编写单元格的值。我们可以使用Excel公式来进行这种计算，这样做会更准确，因为如果计算中使用的单元格值发生变化，数值也会变化。让我们看一个简单的示例，使用Apache POI API编写带有公式的Excel文件。 WriteExcelWithFormula.java

package com.journaldev.excel.read;

import java.io.FileOutputStream;
import java.io.IOException;

import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class WriteExcelWithFormula {

	public static void writeExcelWithFormula(String fileName) throws IOException{
		Workbook workbook = new XSSFWorkbook();
		Sheet sheet = workbook.createSheet("Numbers");
		Row row = sheet.createRow(0);
		row.createCell(0).setCellValue(10);
		row.createCell(1).setCellValue(20);
		row.createCell(2).setCellValue(30);
		//设置公式单元格
		row.createCell(3).setCellFormula("A1*B1*C1");
		
		//将其写入文件
		FileOutputStream fos = new FileOutputStream(fileName);
		workbook.write(fos);
		fos.close();
		System.out.println(fileName + " written successfully");
	}
	
	public static void main(String[] args) throws IOException {
		writeExcelWithFormula("Formulas.xlsx");
	}
}

上述Apache POI API示例程序生成的Excel文件如下图所示。这就是有关使用Excel文件的Apache POI教程的全部内容，请查看Apache POI类方法以了解更多功能。 参考资料: Apache POI开发人员指南

Source:
https://www.digitalocean.com/community/tutorials/apache-poi-tutorial