Apache POI 3.17 Javadocs
用Java编写的免费开源的跨平台的 Java API,Apache POI提供API给Java程式对Microsoft Office(Excel、WORD、PowerPoint、Visio等)格式档案读和写的功能。POI为“Poor Obfuscation Implementation”的首字母缩写,意为“可怜的模糊实现”。
Apache POI常用的类
- HSSF - 提供读写Microsoft Excel XLS格式档案的功能。
- XSSF - 提供读写Microsoft Excel OOXML XLSX格式档案的功能。
- HWPF - 提供读写Microsoft Word DOC97格式档案的功能。
- XWPF - 提供读写Microsoft Word DOC2003格式档案的功能。
- HSLF - 提供读写Microsoft PowerPoint格式档案的功能。
- HDGF - 提供读Microsoft Visio格式档案的功能。
- HPBF - 提供读Microsoft Publisher格式档案的功能。
- HSMF - 提供读Microsoft Outlook格式档案的功能。
在开发中我们经常使用HSSF用来操作Excel处理表格数据,对于其它的不经常使用。
HSSF 是Horrible SpreadSheet Format的缩写,通过HSSF,你可以用纯Java代码来读取、写入、修改Excel文件。HSSF 为读取操作提供了两类API:usermodel和eventusermodel,即“用户模型”和“事件-用户模型”。
常用的类和方法
HSSFWorkbook :工作簿,代表一个excel的整个文档
- HSSFWorkbook(); // 创建一个新的工作簿
- HSSFWorkbook(InputStream inputStream); // 创建一个关联输入流的工作簿,可以将一个excel文件封装成工作簿
- HSSFSheet createSheet(String sheetname); 创建一个新的Sheet
- HSSFSheet getSheet(String sheetName); 通过名称获取Sheet
- HSSFSheet getSheetAt(int index); // 通过索引获取Sheet,索引从0开始
- HSSFCellStyle createCellStyle(); 创建单元格样式
- int getNumberOfSheets(); 获取sheet的个数
- setActiveSheet(int index); 设置默认选中的工作表
- write();
- write(File newFile);
- write(OutputStream stream);
HSSFSheet:工作表
- HSSFRow createRow(int rownum); 创建新行,需要指定行号,行号从0开始
- HSSFRow getRow(int index); 根据索引获取指定的行
- int addMergedRegion(CellRangeAddress region); 合并单元格
- CellRangeAddress(int firstRow, int lastRow, int firstCol, int lastCol); 单元格范围, 用于合并单元格,需要指定要合并的首行、最后一行、首列、最后一列。
- autoSizeColumn(int column); 自动调整列的宽度来适应内容
- getLastRowNum(); 获取最后的行的索引,没有行或者只有一行的时候返回0
- setColumnWidth(int columnIndex, int width); 设置某一列的宽度,width=字符个数 * 256,例如20个字符的宽度就是20 * 256
HSSFRow :行
- HSSFCell createCell(int column); 创建新的单元格
- HSSFCell setCell(shot index);
- HSSFCell getCell(shot index);
- setRowStyle(HSSFCellStyle style); 设置行样式
- short getLastCellNum(); 获取最后的单元格号,如果单元格有第一个开始算,lastCellNum就是列的个数
- setHeightInPoints(float height); 设置行的高度
HSSFCell:单元格
- setCellValue(String value); 设置单元格的值
- setCellType(); 设置单元格类型,如 字符串、数字、布尔等
- setCellStyle(); 设置单元格样式
- String getStringCellValue(); 获取单元格中的字符串值
- setCellStyle(HSSFCellStyle style); 设置单元格样式,例如字体、加粗、格式化
- setCellFormula(String formula); 设置计算公式,计算的结果作为单元格的值,也提供了异常常用的函数,如求和”sum(A1,C1)”、日期函数、字符串相关函数、CountIf和SumIf函数、随机数函数等
HSSFCellStyle :单元格样式
setFont(Font font); 为单元格设置字体样式
setAlignment(HorizontalAlignment align); // 设置水平对齐方式
setVerticalAlignment(VerticalAlignment align); // 设置垂直对齐方式
setFillPattern(FillPatternType fp);
setFillForegroundColor(short bg); 设置前景色
setFillBackgroundColor(short bg); 设置背景颜色
HSSFFont:字体
- setColor(short color); // 设置字体颜色
- setBold(boolean bold); // 设置是否粗体
- setItalic(boolean italic); 设置倾斜
- setUnderline(byte underline); 设置下划线
HSSFName:名称
HSSFDataFormat :日期格式化
HSSFHeader : Sheet的头部
HSSFFooter :Sheet的尾部
HSSFDateUtil :日期工具
HSSFPrintSetup :打印设置
HSSFErrorConstants:错误信息表
Excel中的工作簿、工作表、行、单元格中的关系:
- 一个Excel文件对应于一个workbook(HSSFWorkbook)
- 一个workbook可以有多个sheet(HSSFSheet)组成
- 一个sheet是由多个row(HSSFRow)组成
- 一个row是由多个cell(HSSFCell)组成
基础示例
引入apache poi的依赖
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.8</version>
</dependency>
示例一:在桌面上生成一个Excel文件
package cnblogs.com.ooo0.poi;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Date;
import javax.swing.filechooser.FileSystemView;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFCreationHelper;
import org.apache.poi.hssf.usermodel.HSSFDataFormat;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
public class TestPoi {
public static void main(String[] args) {
try {
createExcel();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 在桌面上生成一个Excel文件
*/
public static void createExcel() throws IOException {
// 获取桌面路径
FileSystemView fsv = FileSystemView.getFileSystemView();
String desktop = fsv.getHomeDirectory().getPath();
String filePath = desktop + "/template.xls";
File file = new File(filePath);
OutputStream outputStream = new FileOutputStream(file);
// 创建一个新的工作簿
HSSFWorkbook workbook = new HSSFWorkbook();
// ---单元格样式---
// 日期格式化
HSSFCellStyle cellStyle2 = workbook.createCellStyle();// 创建单元格样式
HSSFCreationHelper creationHelper = workbook.getCreationHelper();
cellStyle2.setDataFormat(creationHelper.createDataFormat().getFormat("yyyy-MM-dd HH:mm:ss"));
// 保留两位小数
HSSFCellStyle cellStyle3 = workbook.createCellStyle();
cellStyle3.setDataFormat(HSSFDataFormat.getBuiltinFormat("0.00"));
// 货币格式化
HSSFCellStyle cellStyle4 = workbook.createCellStyle();
HSSFFont font = workbook.createFont();
font.setFontName("华文行楷");
font.setFontHeightInPoints((short) 15);
font.setColor(HSSFColor.RED.index);
cellStyle4.setFont(font);
// 创建一个新的Sheet
HSSFSheet sheet = workbook.createSheet("Sheet1");
HSSFRow row = sheet.createRow(0);// 创建新行,需要指定行号,行号从0开始
row.setHeightInPoints(30); // 设置行的高度
sheet.setColumnWidth(2, 20 * 256); // 设置2列的宽度,width=字符个数 * 256,例如20个字符的宽度就是20 * 256
row.createCell(0).setCellValue("id");// 创建新的单元格;设置单元格的值;
row.createCell(1).setCellValue("订单号");
row.createCell(2).setCellValue("下单时间");
row.createCell(3).setCellValue("个数");
row.createCell(4).setCellValue("单价");
row.createCell(5).setCellValue("订单金额");
HSSFRow row1 = sheet.createRow(1);
row1.createCell(0).setCellValue("1");
row1.createCell(1).setCellValue("NO00001");
HSSFCell cell2 = row1.createCell(2);
cell2.setCellStyle(cellStyle2);
cell2.setCellValue(new Date());
row1.createCell(3).setCellValue(2);
HSSFCell cell4 = row1.createCell(4);
cell4.setCellStyle(cellStyle3);
cell4.setCellValue(29.5);
HSSFCell cell5 = row1.createCell(5);
cell5.setCellFormula("D2*E2"); // 设置计算公式,计算的结果作为单元格的值,也提供了异常常用的函数,如求和”sum(A1,C1)”、日期函数、字符串相关函数、CountIf和SumIf函数、随机数函数等
cell5.setCellStyle(cellStyle4);
// 获取计算公式的值
// HSSFFormulaEvaluator e = new HSSFFormulaEvaluator(workbook);
// cell5 = e.evaluateInCell(cell5);
// System.out.println(cell5.getNumericCellValue());
workbook.setActiveSheet(0);// 设置默认选中的工作表
workbook.write(outputStream);
outputStream.close();
}
}
示例2:读取Excel,解析数据
package cnblogs.com.ooo0.poi;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Date;
import javax.swing.filechooser.FileSystemView;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFCreationHelper;
import org.apache.poi.hssf.usermodel.HSSFDataFormat;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
public class TestPoi {
public static void main(String[] args) {
try {
readExcel();
} catch (IOException e) {
e.printStackTrace();
}
}
public static void readExcel() throws IOException {
FileSystemView fsv = FileSystemView.getFileSystemView();
String desktop = fsv.getHomeDirectory().getPath();
String filePath = desktop + "/template.xls";
FileInputStream fileInputStream = new FileInputStream(filePath);
BufferedInputStream bufferedInputStream = new BufferedInputStream(fileInputStream);
POIFSFileSystem fileSystem = new POIFSFileSystem(bufferedInputStream);
HSSFWorkbook workbook = new HSSFWorkbook(fileSystem);// 创建一个关联输入流的工作簿,可以将一个excel文件封装成工作簿
HSSFSheet sheet = workbook.getSheet("Sheet1");// 通过名称获取Sheet
int lastRowIndex = sheet.getLastRowNum();// 获取最后的行的索引,没有行或者只有一行的时候返回0
System.out.println(lastRowIndex);
for (int i = 0; i <= lastRowIndex; i++) {
HSSFRow row = sheet.getRow(i);// 根据索引获取指定的行
if (row == null) {
break;
}
short lastCellNum = row.getLastCellNum();// 获取最后的单元格号,如果单元格有第一个开始算,lastCellNum就是列的个数
for (int j = 0; j < lastCellNum; j++) {
String cellValue = row.getCell(j).getStringCellValue();// 获取单元格中的字符串值
System.out.println(cellValue);
}
}
bufferedInputStream.close();
}
}
导出示例
package com.xc.servlet;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment;
import org.apache.poi.ss.util.CellRangeAddress;
import com.xc.entity.User;
/**
* 导出示例
*/
@WebServlet("/ExportExcelServlet")
public class ExportExcelServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
public ExportExcelServlet() {
super();
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
String[] tableHeaders = { "id", "姓名", "年龄" };
HSSFWorkbook workbook = new HSSFWorkbook();
HSSFCellStyle cellStyle = workbook.createCellStyle();// 创建单元格样式
cellStyle.setAlignment(HorizontalAlignment.CENTER);// 设置水平对齐方式
cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);// 设置垂直对齐方式
HSSFFont font = workbook.createFont();
font.setColor(HSSFFont.COLOR_RED);// 设置字体颜色
font.setBold(true);// 设置是否粗体
cellStyle.setFont(font);
HSSFSheet sheet = workbook.createSheet("Sheet1");
// 将第一行的三个单元格给合并
sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, 2));// 合并单元格
HSSFRow row = sheet.createRow(0);
HSSFCell beginCell = row.createCell(0);
beginCell.setCellValue("通讯录");
beginCell.setCellStyle(cellStyle);
// 创建表头
row = sheet.createRow(1);
for (int i = 0; i < tableHeaders.length; i++) {
HSSFCell cell = row.createCell(i);
cell.setCellValue(tableHeaders[i]);
cell.setCellStyle(cellStyle);
}
List<User> users = new ArrayList<>();
users.add(new User(1, "张三", "123456"));
users.add(new User(2, "李四", "123456"));
users.add(new User(3, "王五", "123456"));
for (int i = 0; i < users.size(); i++) {
row = sheet.createRow(i + 2);
User user = users.get(i);
row.createCell(0).setCellValue(user.getId());
row.createCell(1).setCellValue(user.getName());
row.createCell(2).setCellValue(user.getPassword());
}
OutputStream outputStream = response.getOutputStream();
response.reset();
response.setContentType("application/vnd.ms-excel");
response.setHeader("Content-disposition", "attachment;filename=template.xls");
workbook.write(outputStream);
outputStream.flush();
outputStream.close();
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
参考文档:
Apache POI使用详解
官方API