原 spring boot 集成easypoi

版权声明：本文为博主原创文章，请尊重他人的劳动成果，转载请附上原文出处链接和本声明。
本文链接：https://www.91mszl.com/zhangwuji/article/details/1223

一：引入easypoi POM依赖 。

1.1 如果是 spring boot项目。

<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-spring-boot-starter</artifactId>
    <version>4.1.3</version>
</dependency>

1.2 如果是非spring boot项目

<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-base</artifactId>
    <version>4.1.3</version>
</dependency>

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

二：ExcelUtils工具类。

package com.mszl.util;

import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;

public class ExcelUtils {

	public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
			boolean isCreateHeader, HttpServletResponse response) {
		ExportParams exportParams = new ExportParams(title, sheetName);
		exportParams.setCreateHeadRows(isCreateHeader);
		defaultExport(list, pojoClass, fileName, response, exportParams);
	}
 
	public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
			HttpServletResponse response) {
		defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
	}
 
	public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
		defaultExport(list, fileName, response);
	}
 
	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) {
			// throw new NormalException(e.getMessage());
		}
	}
 
	private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
		Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
		if (workbook != null)
			;
		downLoadExcel(fileName, response, workbook);
	}
 
	public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
		if (StringUtils.isBlank(filePath)) {
			return null;
		}
		ImportParams params = new ImportParams();
		params.setTitleRows(titleRows);
		params.setHeadRows(headerRows);
		List<T> list = null;
		try {
			list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
		} catch (NoSuchElementException e) {
			// throw new NormalException("模板不能为空");
		} catch (Exception e) {
			e.printStackTrace();
			// throw new NormalException(e.getMessage());
		}
		return list;
	}
 
	public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows,
			Class<T> pojoClass) {
		if (file == null) {
			return null;
		}
		ImportParams params = new ImportParams();
		params.setTitleRows(titleRows);
		params.setHeadRows(headerRows);
		List<T> list = null;
		try {
			list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
		} catch (NoSuchElementException e) {
			// throw new NormalException("excel文件不能为空");
		} catch (Exception e) {
			// throw new NormalException(e.getMessage());
			System.out.println(e.getMessage());
		}
		return list;
	}
	
	
	
}

三：实体类。

package com.mszl.entity;

import java.io.Serializable;
import cn.afterturn.easypoi.excel.annotation.Excel;
import lombok.Data;

@Data
public class Ajob implements Serializable {
    
	@Excel(name = "序号")
    private String id;

	@Excel(name = "岗位名称")
    private String jobName;
	
	@Excel(name = "工作日天数")
    private Integer workDays;

    private static final long serialVersionUID = 1L;
}

四：控制层。这里没有连接数据库进行操作，是模拟的数据。

package com.mszl.controller;

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

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import com.alibaba.fastjson.JSONObject;

import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.result.ExcelImportResult;
import cn.gaialab.gaiamind.microservice.brp.entity.Ajob;
import cn.gaialab.gaiamind.microservice.brp.util.ExcelUtils;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RestController
@RequestMapping("/execl")
public class ExeclController {
	
	@GetMapping("/exportExecl")
	public void exportExecl(HttpServletResponse response) {
		List<Ajob> list = new ArrayList<>();
		Ajob bb = new Ajob();
		bb.setId("111111");
		bb.setJobName("MA");
		bb.setWorkDays(10);
		list.add(bb);
		ExcelUtils.exportExcel(list, null, null, Ajob.class, "123.xlsx", response);
	}
	
	@PostMapping("/importExecl")
	public String importExecl(@RequestParam("file") MultipartFile file) {
		ImportParams importParams = new ImportParams();
		// 数据处理
		importParams.setTitleRows(0); // 表格标题行数,默认0
		importParams.setHeadRows(1); // 表头行数,默认1
		// 需要验证
		importParams.setNeedVerify(false);
		try {
			ExcelImportResult<Ajob> result = ExcelImportUtil.importExcelMore(file.getInputStream(), Ajob.class, importParams);
			List<Ajob> jobList = result.getList();
			for (Ajob bb : jobList) {
				log.info("从Excel导入数据到数据库的详细为 ：{}", JSONObject.toJSONString(bb));
				// 将导入的数据保存数据库......
			}
			log.info("从Excel导入数据一共 {} 行 ", jobList.size());
		} catch (IOException e) {
			log.error("导入失败：{}", e.getMessage());
		} catch (Exception e1) {
			log.error("导入失败：{}", e1.getMessage());
		}
		return "导入成功";
	}
	

}

五：测试导出功能。

请求地址：http://localhost:8080/execl/exportExecl

下载下来的execl打开如下图所示。

六：测试导入功能，使用postman工具。

6.1 需要导入的execl 如下图所示。

6.2 采用postman导入execl需要配置如下。注意要选择form-data，key填写file与导入controller里面填写的变量保持一致。

在控制台打印如下。

到此就大功告成了。