java使用poi和easypoi导出excel文件

POI简单介绍

Apache POI 是用Java编写的免费开源的跨平台的 Java API，Apache POI提供API给Java程式对Microsoft Office格式档案读和写的功能。POI为“Poor Obfuscation Implementation”的首字母缩写，意为“可怜的模糊实现”。

Apache POI 是创建和维护操作各种符合Office Open XML（OOXML）标准和微软的OLE 2复合文档格式（OLE2）的Java API。用它可以使用Java读取和创建,修改MS Excel文件.而且,还可以使用Java读取和创建MS Word和MSPowerPoint文件。Apache POI 提供Java操作Excel解决方案（适用于Excel97-2008）。

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格式档案的功能。

更多详情api请参看 POI官网

使用POI导出excel文件

本项目基于springboot搭建

• 在pom.xml文件中导入相关Jar包

		<dependency>
		    <groupId>org.apache.poi</groupId>
		    <artifactId>poi</artifactId>
		    <version>3.17</version>
		</dependency>

主要serviceImpl实现
要实现excel文件导出，关键点如下：

1. 创建XSSFWorkbook，之后在workbook（相当于excel文件）基础上创建sheet(相当于excel中的工作薄)，之后在sheet上创建行（Row），每行又分为多少列(Cell)，如果需要给行设置特殊字体和样式可以加入XSSFCellStyle，Font等
2. 将创建好的excel文件写入response流中，就可以下载文件啦~

@Override
	public void exportByPOI(List<ExportData> exportDataList, String[] titles, String titleValue, String fileName, HttpServletResponse response) {
		XSSFWorkbook workbook = new XSSFWorkbook();
		// 创建sheet页
		Sheet sheet = workbook.createSheet();
		// 字体
		XSSFFont font = workbook.createFont();
		font.setFontHeightInPoints((short) 20);// 字号
		font.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);// 加粗

		// 头背景色
		XSSFCellStyle styleTitle = workbook.createCellStyle();
		styleTitle.setAlignment(HSSFCellStyle.ALIGN_CENTER); // 创建一个居中格式
		styleTitle.setFont(font);
		// 创建标题
		Row row = sheet.createRow(0);
		row.setHeightInPoints(30);
		// 设置excel头
		Cell cell = row.createCell(0);
		cell.setCellValue(titleValue);
		cell.setCellStyle(styleTitle);
		sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, titles.length - 1));
		Row rowTitle = sheet.createRow(1);
		// 设置列头
				XSSFCellStyle styleHeader = workbook.createCellStyle();
				styleHeader.setAlignment(HSSFCellStyle.ALIGN_CENTER); // 创建一个居中格式
				// 字体
				XSSFFont fontTitle = workbook.createFont();
				fontTitle.setFontHeightInPoints((short) 12);// 字号
				fontTitle.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);// 加粗
				styleHeader.setAlignment(HSSFCellStyle.ALIGN_CENTER); // 创建一个居中格式
				styleHeader.setFont(fontTitle);
		// 创建标题行
				for (int i = 0; i < titles.length; i++) {
					cell = rowTitle.createCell(i);
					cell.setCellValue(titles[i]);
					cell.setCellStyle(styleHeader);
					sheet.autoSizeColumn((short) i);
				}
				// 创建内容
				for (int i = 0; i < exportDataList.size(); i++) {
					Row rowData = sheet.createRow(1 + i);
					// 此处的6是实体类中的属性个数
						// 将内容按顺序赋给对应的列对象
						rowData.createCell(0).setCellValue(exportDataList.get(i).getName());
						rowData.createCell(1).setCellValue(exportDataList.get(i).getAge());
						rowData.createCell(2).setCellValue(exportDataList.get(i).getGender());
						rowData.createCell(3).setCellValue(exportDataList.get(i).getIdCard());
						rowData.createCell(4).setCellValue(exportDataList.get(i).getAddress());
						rowData.createCell(5).setCellValue(exportDataList.get(i).getRemarks());
				}
				for (int k = 0; k < titles.length; k++) {
					sheet.autoSizeColumn((short) k);
				}
	            try {
	            	response.setContentType("application/octet-stream");
	                // 设置下载文件名
	                response.addHeader("Content-Disposition",
	                    "attachment; filename=\"" + URLEncoder.encode(fileName, StandardCharsets.UTF_8.toString()) + "\"");
					 workbook.write(response.getOutputStream());
				} catch (UnsupportedEncodingException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				} catch (IOException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
	           
	}

	/**
	 * excel表格自适应调整列宽，提供中文支持
	 * 
	 * @param sheet
	 * @param size
	 */
	private void setSizeColumn(Sheet sheet, int size) {
		for (int columnNum = 0; columnNum < size; columnNum++) {
			int columnWidth = sheet.getColumnWidth(columnNum) / 256;
			for (int rowNum = 0; rowNum < sheet.getLastRowNum(); rowNum++) {
				Row currentRow;
				// 当前行未被使用过
				if (sheet.getRow(rowNum) == null) {
					currentRow = sheet.createRow(rowNum);
				} else {
					currentRow = sheet.getRow(rowNum);
				}

				if (currentRow.getCell(columnNum) != null) {
					Cell currentCell = currentRow.getCell(columnNum);
					if (currentCell.getCellType() == XSSFCell.CELL_TYPE_STRING) {
						int length = currentCell.getStringCellValue().getBytes().length;
						if (columnWidth < length) {
							columnWidth = length;
						}
					}
				}
			}
			sheet.setColumnWidth(columnNum, columnWidth * 256);
		}
	}

详细代码可以参看github地址

Easypoi介绍

easypoi是对poi进行封装简化之后的一个开源代码
官网介绍：
easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员
就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板
语言(熟悉的表达式语法),完成以前复杂的写法。

详细api和介绍可以参看easypoi官网

本例子还是基于spring boot

• 导入相关pom依赖

	<dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-base</artifactId>
            <version>3.0.3</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-web</artifactId>
            <version>3.0.3</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-annotation</artifactId>
            <version>3.0.3</version>
        </dependency>

• 在实体类上加上注解@Excel，其中name表示导出的excel的title行，orderNum表示列顺序。还有@ExcelTarget等注解，具体可以参考官网介绍。

package com.example.demo.entity;

import cn.afterturn.easypoi.excel.annotation.Excel;

/**
 * @author 张雨轩
 *
 */
public class ExportEasyData {

	@Excel(name = "姓名", orderNum = "0")
	private String name;
	@Excel(name = "年龄 ", orderNum = "1")
	private Integer age;
	@Excel(name = "性别", replace = {"男_1", "女_2"}, orderNum = "2")
	private Integer gender;
	@Excel(name = "地址 ", orderNum = "3")
	private String address;
	@Excel(name = "身份证 ", orderNum = "4")
	private String idCard;
	@Excel(name = "个人备注 ", orderNum = "5")
	private String remarks;

	
	public ExportEasyData(String name, Integer age, Integer gender, String address, String idCard, String remarks) {
		super();
		this.name = name;
		this.age = age;
		this.gender = gender;
		this.address = address;
		this.idCard = idCard;
		this.remarks = remarks;
	}

	public ExportEasyData() {
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

	public Integer getGender() {
		return gender;
	}

	public void setGender(Integer gender) {
		this.gender = gender;
	}

	public String getAddress() {
		return address;
	}

	public void setAddress(String address) {
		this.address = address;
	}

	public String getIdCard() {
		return idCard;
	}

	public void setIdCard(String idCard) {
		this.idCard = idCard;
	}

	public String getRemarks() {
		return remarks;
	}

	public void setRemarks(String remarks) {
		this.remarks = remarks;
	}

}

主要serviceimpl实现
list表示需要导出的list数据，title表示标题行，sheetName表示工作薄名称，pojoClass是list数据中的泛型，也就是导出的实体类。

@Override
	public void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName, HttpServletResponse response){
		defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
	}

    private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams,pojoClass,list);
        if (workbook != null);
        downLoadExcel(fileName, response, workbook);
    }
    private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
        try {
            response.setCharacterEncoding("UTF-8");
            response.setHeader("content-Type", "application/vnd.ms-excel");
            response.setHeader("Content-Disposition",
                    "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
            workbook.write(response.getOutputStream());
        } catch (IOException e) {
            System.out.println(e.getMessage());
        }
    }

具体代码可以查看github

导出excel注意事项

直接用ajax方式访问api接口，只能从response中读到一串二进制乱码的返回值，是因为ajax不能处理文件流，而直接在浏览器中访问api接口可以直接下载文件，因为浏览器可以处理文件流。所以导出excel文件不可以用ajax的方式访问哦~