Apache POI的简单使用记录

Posted 2023-03-30 碳烤小肥羊。。。

Apache POI

• 1. POI介绍
• 2. 入门案例
• • 2.1 从Excel文件读取数据
  • 2.2 向Excel文件写入数据
• 3. 通用的POIUtils

1. POI介绍

Apache POI是用Java编写的免费开源的跨平台的Java API，Apache POI提供API给Java程序对Microsoft Office格式档案读和写的功能，其中使用最多的就是使用POI操作Excel文件。

注意：jxl是专门操作Excel的。

maven坐标：

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

POI结构：

HSSF － 提供读写Microsoft Excel XLS格式档案的功能
XSSF － 提供读写Microsoft Excel OOXML XLSX格式档案的功能
HWPF － 提供读写Microsoft Word DOC格式档案的功能
HSLF － 提供读写Microsoft PowerPoint格式档案的功能
HDGF － 提供读Microsoft Visio格式档案的功能
HPBF － 提供读Microsoft Publisher格式档案的功能
HSMF － 提供读Microsoft Outlook格式档案的功能

2. 入门案例

2.1 从Excel文件读取数据

使用POI可以从一个已经存在的Excel文件中读取数据

//创建工作簿
XSSFWorkbook workbook = new XSSFWorkbook("D:\\\\hello.xlsx");
//获取工作表，既可以根据工作表的顺序获取，也可以根据工作表的名称获取
XSSFSheet sheet = workbook.getSheetAt(0);
//遍历工作表获得行对象
for (Row row : sheet) 
  //遍历行对象获取单元格对象
  for (Cell cell : row) 
    //获得单元格中的值
    String value = cell.getStringCellValue();
    System.out.println(value);
  

workbook.close();

通过上面的入门案例可以看到，POI操作Excel表格封装了几个核心对象：

XSSFWorkbook：工作簿
XSSFSheet：工作表
Row：行
Cell：单元格

上面案例是通过遍历工作表获得行，遍历行获得单元格，最终获取单元格中的值。

还有一种方式就是获取工作表最后一个行号，从而根据行号获得行对象，通过行获取最后一个单元格索引，从而根据单元格索引获取每行的一个单元格对象，代码如下：

//创建工作簿
XSSFWorkbook workbook = new XSSFWorkbook("D:\\\\hello.xlsx");
//获取工作表，既可以根据工作表的顺序获取，也可以根据工作表的名称获取
XSSFSheet sheet = workbook.getSheetAt(0);
//获取当前工作表最后一行的行号，行号从0开始
int lastRowNum = sheet.getLastRowNum();
for(int i=0;i<=lastRowNum;i++)
  //根据行号获取行对象
  XSSFRow row = sheet.getRow(i);
  short lastCellNum = row.getLastCellNum();
  for(short j=0;j<lastCellNum;j++)
    String value = row.getCell(j).getStringCellValue();
    System.out.println(value);
  

workbook.close();

2.2 向Excel文件写入数据

使用POI可以在内存中创建一个Excel文件并将数据写入到这个文件，最后通过输出流将内存中的Excel文件下载到磁盘

//在内存中创建一个Excel文件
XSSFWorkbook workbook = new XSSFWorkbook();
//创建工作表，指定工作表名称
XSSFSheet sheet = workbook.createSheet("测试表");

//创建行，0表示第一行
XSSFRow row = sheet.createRow(0);
//创建单元格，0表示第一个单元格
row.createCell(0).setCellValue("编号");
row.createCell(1).setCellValue("名称");
row.createCell(2).setCellValue("年龄");

XSSFRow row1 = sheet.createRow(1);
row1.createCell(0).setCellValue("1");
row1.createCell(1).setCellValue("小明");
row1.createCell(2).setCellValue("10");

XSSFRow row2 = sheet.createRow(2);
row2.createCell(0).setCellValue("2");
row2.createCell(1).setCellValue("小王");
row2.createCell(2).setCellValue("20");

//通过输出流将workbook对象下载到磁盘
FileOutputStream out = new FileOutputStream("D:\\\\itcast.xlsx");
workbook.write(out);
out.flush();
out.close();
workbook.close();

3. 通用的POIUtils

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
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;
import org.springframework.web.multipart.MultipartFile;

public class POIUtils 
    private final static String xls = "xls";
    private final static String xlsx = "xlsx";
    private final static String DATE_FORMAT = "yyyy/MM/dd";
    /**
     * 读入excel文件，解析后返回
     * @param file
     * @throws IOException
     */
    public static List<String[]> readExcel(MultipartFile file) throws IOException 
        //检查文件
        checkFile(file);
        //获得Workbook工作薄对象
        Workbook workbook = getWorkBook(file);
        //创建返回对象，把每行中的值作为一个数组，所有行作为一个集合返回
        List<String[]> list = new ArrayList<String[]>();
        if(workbook != null)
            for(int sheetNum = 0;sheetNum < workbook.getNumberOfSheets();sheetNum++)
                //获得当前sheet工作表
                Sheet sheet = workbook.getSheetAt(sheetNum);
                if(sheet == null)
                    continue;
                
                //获得当前sheet的开始行
                int firstRowNum  = sheet.getFirstRowNum();
                //获得当前sheet的结束行
                int lastRowNum = sheet.getLastRowNum();
                //循环除了第一行的所有行
                for(int rowNum = firstRowNum+1;rowNum <= lastRowNum;rowNum++)
                    //获得当前行
                    Row row = sheet.getRow(rowNum);
                    if(row == null)
                        continue;
                    
                    //获得当前行的开始列
                    int firstCellNum = row.getFirstCellNum();
                    //获得当前行的列数
                    int lastCellNum = row.getPhysicalNumberOfCells();
                    String[] cells = new String[row.getPhysicalNumberOfCells()];
                    //循环当前行
                    for(int cellNum = firstCellNum; cellNum < lastCellNum;cellNum++)
                        Cell cell = row.getCell(cellNum);
                        cells[cellNum] = getCellValue(cell);
                    
                    list.add(cells);
                
            
            workbook.close();
        
        return list;
    

    //校验文件是否合法
    public static void checkFile(MultipartFile file) throws IOException
        //判断文件是否存在
        if(null == file)
            throw new FileNotFoundException("文件不存在！");
        
        //获得文件名
        String fileName = file.getOriginalFilename();
        //判断文件是否是excel文件
        if(!fileName.endsWith(xls) && !fileName.endsWith(xlsx))
            throw new IOException(fileName + "不是excel文件");
        
    
    public static Workbook getWorkBook(MultipartFile file) 
        //获得文件名
        String fileName = file.getOriginalFilename();
        //创建Workbook工作薄对象，表示整个excel
        Workbook workbook = null;
        try 
            //获取excel文件的io流
            InputStream is = file.getInputStream();
            //根据文件后缀名不同(xls和xlsx)获得不同的Workbook实现类对象
            if(fileName.endsWith(xls))
                //2003
                workbook = new HSSFWorkbook(is);
            else if(fileName.endsWith(xlsx))
                //2007
                workbook = new XSSFWorkbook(is);
            
         catch (IOException e) 
            e.printStackTrace();
        
        return workbook;
    
    public static String getCellValue(Cell cell)
        String cellValue = "";
        if(cell == null)
            return cellValue;
        
        //如果当前单元格内容为日期类型，需要特殊处理
        String dataFormatString = cell.getCellStyle().getDataFormatString();
        if(dataFormatString.equals("m/d/yy"))
            cellValue = new SimpleDateFormat(DATE_FORMAT).format(cell.getDateCellValue());
            return cellValue;
        
        //把数字当成String来读，避免出现1读成1.0的情况
        if(cell.getCellType() == Cell.CELL_TYPE_NUMERIC)
            cell.setCellType(Cell.CELL_TYPE_STRING);
        
        //判断数据的类型
        switch (cell.getCellType())
            case Cell.CELL_TYPE_NUMERIC: //数字
                cellValue = String.valueOf(cell.getNumericCellValue());
                break;
            case Cell.CELL_TYPE_STRING: //字符串
                cellValue = String.valueOf(cell.getStringCellValue());
                break;
            case Cell.CELL_TYPE_BOOLEAN: //Boolean
                cellValue = String.valueOf(cell.getBooleanCellValue());
                break;
            case Cell.CELL_TYPE_FORMULA: //公式
                cellValue = String.valueOf(cell.getCellFormula());
                break;
            case Cell.CELL_TYPE_BLANK: //空值
                cellValue = "";
                break;
            case Cell.CELL_TYPE_ERROR: //故障
                cellValue = "非法字符";
                break;
            default:
                cellValue = "未知类型";
                break;
        
        return cellValue;
    

Apache POI 合并单元格--简单解释版带Demo

合并单元格所使用的方法：

sheet.addMergedRegion( CellRangeAddress  cellRangeAddress  );

 

CellRangeAddress  对象的构造方法需要传入合并单元格的首行、最后一行、首列、最后一列。

CellRangeAddress cra=new CellRangeAddress(0, 3, 3, 9);

 

怎样把数据写入合并后的单元格中

1. 首先要查看你 CellRangeAddress 构造方法的firstcol index
2. 创建firstcol cell对象
3. cell 的set 方法写数据

在合并单元格的后一个位置写数据

1. 查看  CellRangeAddress 构造方法的lastcol index     
2. 创建lastcol+1  cell
3. cell 的set方法写数据

 

以下是demo：

 1 FileOutputStream fos=new FileOutputStream("D:\\13.xls");  
 2           
 3         Workbook wb=new HSSFWorkbook();  
 4           
 5         Sheet sheet=wb.createSheet();  
 6         /* 
 7          * 设定合并单元格区域范围 
 8          *  firstRow  0-based 
 9          *  lastRow   0-based 
10          *  firstCol  0-based 
11          *  lastCol   0-based 
12          */  
13         CellRangeAddress cra=new CellRangeAddress(0, 3, 3, 9);        
14           
15         //在sheet里增加合并单元格  
16         sheet.addMergedRegion(cra);  
17           
18         Row row = sheet.createRow(0);  
19           
20         Cell cell_1 = row.createCell(3);  
21           
22         cell_1.setCellValue("When you‘re right , no one remembers, when you‘re wrong ,no one forgets .");  
23           
24         //cell 位置3-9被合并成一个单元格，不管你怎样创建第4个cell还是第5个cell…然后在写数据。都是无法写入的。  
25         Cell cell_2 = row.createCell(10);  
26           
27         cell_2.setCellValue("what‘s up ! ");  
28           
29         wb.write(fos);  
30           
31         fos.close();