常用工具类之使用POI实现导入导出Excel
Java利用POI实现导入导出Excel表格
1.引入依赖
org.apache.poi
poi
3.13
org.apache.poi
poi-ooxml
4.1.2
org.apache.commons
commons-lang3
3.11
com.baomidou
mybatis-plus-boot-starter
2.3
自定义实体类所需要的bean(Excel属性标题、位置等)
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author zhaomaolin
*/
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelColumn {
/**
* Excel标题
* @author zhaomaolin
*/
String value() default "";
/**
* Excel从左往右排列位置
* @author zhaomaolin
*/
int col() default 0;
}创建工具类
import java.io.*;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.servlet.http.HttpServletResponse;
import com.baomidou.mybatisplus.toolkit.CollectionUtils;
import com.example.vip.interfaces.ExcelColumn;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.CharUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import org.apache.poi.hssf.usermodel.HSSFDateUtil;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.IndexedColors;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.web.multipart.MultipartFile;
public class ExcelUtils {
private final static Logger log = LoggerFactory.getLogger(ExcelUtils.class);
private final static String EXCEL2003 = "xls";
private final static String EXCEL2007 = "xlsx";
public static List readExcel(String path, Class cls, MultipartFile file) {
String fileName = file.getOriginalFilename();
if (!fileName.matches("^.+\\.(?i)(xls)$") && !fileName.matches("^.+\\.(?i)(xlsx)$")) {
log.error("上传文件格式不正确");
}
List dataList = new ArrayList<>();
Workbook workbook = null;
try {
InputStream is = file.getInputStream();
if (fileName.endsWith(EXCEL2007)) {
// FileInputStream is = new FileInputStream(new File(path));
workbook = new XSSFWorkbook(is);
}
if (fileName.endsWith(EXCEL2003)) {
// FileInputStream is = new FileInputStream(new File(path));
workbook = new HSSFWorkbook(is);
}
if (workbook != null) {
//类映射 注解 value-->bean columns
Map> classMap = new HashMap<>();
List fields = Stream.of(cls.getDeclaredFields()).collect(Collectors.toList());
fields.forEach(
field -> {
ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
if (annotation != null) {
String value = annotation.value();
if (StringUtils.isBlank(value)) {
return;//return起到的作用和continue是相同的 语法
}
if (!classMap.containsKey(value)) {
classMap.put(value, new ArrayList<>());
}
field.setAccessible(true);
classMap.get(value).add(field);
}
}
);
//索引-->columns
Map> reflectionMap = new HashMap<>(16);
//默认读取第一个sheet
Sheet sheet = workbook.getSheetAt(0);
boolean firstRow = true;
for (int i = sheet.getFirstRowNum(); i <= sheet.getLastRowNum(); i++) {
Row row = sheet.getRow(i);
//首行 提取注解
if (firstRow) {
for (int j = row.getFirstCellNum(); j <= row.getLastCellNum(); j++) {
Cell cell = row.getCell(j);
String cellValue = getCellValue(cell);
if (classMap.containsKey(cellValue)) {
reflectionMap.put(j, classMap.get(cellValue));
}
}
firstRow = false;
} else {
//忽略空白行
if (row == null) {
continue;
}
try {
T t = cls.newInstance();
//判断是否为空白行
boolean allBlank = true;
for (int j = row.getFirstCellNum(); j <= row.getLastCellNum(); j++) {
if (reflectionMap.containsKey(j)) {
Cell cell = row.getCell(j);
String cellValue = getCellValue(cell);
if (StringUtils.isNotBlank(cellValue)) {
allBlank = false;
}
List fieldList = reflectionMap.get(j);
fieldList.forEach(
x -> {
try {
handleField(t, cellValue, x);
} catch (Exception e) {
log.error(String.format("reflect field:%s value:%s exception!", x.getName(), cellValue), e);
}
}
);
}
}
if (!allBlank) {
dataList.add(t);
} else {
log.warn(String.format("row:%s is blank ignore!", i));
}
} catch (Exception e) {
log.error(String.format("parse row:%s exception!", i), e);
}
}
}
}
} catch (Exception e) {
log.error(String.format("parse excel exception!"), e);
} finally {
if (workbook != null) {
try {
workbook.close();
} catch (Exception e) {
log.error(String.format("parse excel exception!"), e);
}
}
}
return dataList;
}
private static void handleField(T t, String value, Field field) throws Exception {
Class type = field.getType();
if (type == null || type == void.class || StringUtils.isBlank(value)) {
return;
}
if (type == Object.class) {
field.set(t, value);
//数字类型
} else if (type.getSuperclass() == null || type.getSuperclass() == Number.class) {
if (type == int.class || type == Integer.class) {
field.set(t, NumberUtils.toInt(value));
} else if (type == long.class || type == Long.class) {
field.set(t, NumberUtils.toLong(value));
} else if (type == byte.class || type == Byte.class) {
field.set(t, NumberUtils.toByte(value));
} else if (type == short.class || type == Short.class) {
field.set(t, NumberUtils.toShort(value));
} else if (type == double.class || type == Double.class) {
field.set(t, NumberUtils.toDouble(value));
} else if (type == float.class || type == Float.class) {
field.set(t, NumberUtils.toFloat(value));
} else if (type == char.class || type == Character.class) {
field.set(t, CharUtils.toChar(value));
} else if (type == boolean.class) {
field.set(t, BooleanUtils.toBoolean(value));
} else if (type == BigDecimal.class) {
field.set(t, new BigDecimal(value));
}
} else if (type == Boolean.class) {
field.set(t, BooleanUtils.toBoolean(value));
} else if (type == Date.class) {
//
field.set(t, value);
} else if (type == String.class) {
field.set(t, value);
} else {
Constructor constructor = type.getConstructor(String.class);
field.set(t, constructor.newInstance(value));
}
}
private static String getCellValue(Cell cell) {
if (cell == null) {
return "";
}
if (cell.getCellType() == Cell.CELL_TYPE_NUMERIC) {
if (HSSFDateUtil.isCellDateFormatted(cell)) {
return HSSFDateUtil.getJavaDate(cell.getNumericCellValue()).toString();
} else {
return new BigDecimal(cell.getNumericCellValue()).toString();
}
} else if (cell.getCellType() == Cell.CELL_TYPE_STRING) {
return StringUtils.trimToEmpty(cell.getStringCellValue());
} else if (cell.getCellType() == Cell.CELL_TYPE_FORMULA) {
return StringUtils.trimToEmpty(cell.getCellFormula());
} else if (cell.getCellType() == Cell.CELL_TYPE_BLANK) {
return "";
} else if (cell.getCellType() == Cell.CELL_TYPE_BOOLEAN) {
return String.valueOf(cell.getBooleanCellValue());
} else if (cell.getCellType() == Cell.CELL_TYPE_ERROR) {
return "ERROR";
} else {
return cell.toString().trim();
}
}
private static Workbook writeExcel(List dataList, Class cls) {
Field[] fields = cls.getDeclaredFields();
List fieldList = Arrays.stream(fields)
.filter(field -> {
ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
if (annotation != null && annotation.col() > 0) {
field.setAccessible(true);
return true;
}
return false;
}).sorted(Comparator.comparing(field -> {
int col = 0;
ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
if (annotation != null) {
col = annotation.col();
}
return col;
})).collect(Collectors.toList());
Workbook wb = new XSSFWorkbook();
Sheet sheet = wb.createSheet("Sheet1");
AtomicInteger ai = new AtomicInteger();
{
Row row = sheet.createRow(ai.getAndIncrement());
AtomicInteger aj = new AtomicInteger();
//写入头部
fieldList.forEach(field -> {
ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
String columnName = "";
if (annotation != null) {
columnName = annotation.value();
}
Cell cell = row.createCell(aj.getAndIncrement());
CellStyle cellStyle = wb.createCellStyle();
cellStyle.setFillForegroundColor(IndexedColors.WHITE.getIndex());
cellStyle.setFillPattern(CellStyle.SOLID_FOREGROUND);
cellStyle.setAlignment(CellStyle.ALIGN_CENTER);
Font font = wb.createFont();
font.setBoldweight(Font.BOLDWEIGHT_NORMAL);
cellStyle.setFont(font);
cell.setCellStyle(cellStyle);
cell.setCellValue(columnName);
});
}
if (CollectionUtils.isNotEmpty(dataList)) {
dataList.forEach(t -> {
Row row1 = sheet.createRow(ai.getAndIncrement());
AtomicInteger aj = new AtomicInteger();
fieldList.forEach(field -> {
Class type = field.getType();
Object value = "";
try {
value = field.get(t);
} catch (Exception e) {
e.printStackTrace();
}
Cell cell = row1.createCell(aj.getAndIncrement());
if (value != null) {
if (type == Date.class) {
cell.setCellValue(value.toString());
} else {
cell.setCellValue(value.toString());
}
cell.setCellValue(value.toString());
}
});
});
}
//冻结窗格
wb.getSheet("Sheet1").createFreezePane(0, 1, 0, 1);
return wb;
//生成excel文件
// buildExcelFile("D:/srv/abbot.xlsx",wb);
//浏览器下载excel
// buildExcelFile(".\\default.xlsx",wb,response);
}
/**
* 浏览器下载（导出）excel
*
* @param fileName 文件名
* @param response 响应
*/
public static void buildExcelDocument(String fileName, HttpServletResponse response, List dataList, Class cls) {
Workbook wb = writeExcel(dataList, cls);
try {
response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "utf-8"));
response.flushBuffer();
wb.write(response.getOutputStream());
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 生成excel文件到本地
*
* @param path 生成excel路径
*/
public static void buildExcelFile(String path, List dataList, Class cls) {
Workbook wb = writeExcel(dataList, cls);
File file = new File(path);
if (file.exists()) {
file.delete();
}
try {
wb.write(new FileOutputStream(file));
} catch (Exception e) {
e.printStackTrace();
}
}
}
接下来就可以使用导入导出功能了
实体类需要用的注解
@ExcelColumn(value = "xxx", col = 0)
需要调用工具类的方法
咱们这里用的定时任务
@Component
public class StockTask {
private static final String Every_THREE_SECONDS = "*/3 * * * * ?"; //每3秒执行一次
private static final String Every_FIVE_MINUTES = "0 */5 * * * ?";//每隔5分执行一次
private static final String ONCE_TWELVE_AM_BY_DAY = "0 0 12 * * ?";//每天中午十二点执行一次
private static final String ONCE_PER_HOUR = "0 0 0/1 * * ?";//每个整点执行一次
private static final String EVERYDAY_SIXTEEN_DOT = "0 5 16 * * ?";//每天16点执行一次
private static final String EVERYDAY_NIN_TO_SIXTEEN_DOT_THREE = "*/3 * 9-16 * * ?";//每天9点到16点每隔3秒执行一次
@Resource
private StockMapper stockMapper;//股票行情数据表
//数据导出.xls
@Scheduled(cron = Every_FIVE_MINUTES)
public void outXls() {
System.out.println("开始执行= " + StaticUitls.getNewDate());
List resultList = stockMapper.outXlsDate();
ExcelUtils.buildExcelFile("D:/srv/abbot.xlsx", resultList, Stock.class);
System.out.println("执行完毕= " + StaticUitls.getNewDate());
}
} 导入导出接口
导入导出demo
controller层
/**
* Excel导入
*/
@PostMapping("/import")
public Result userImport2(@RequestParam("file") MultipartFile file) throws Exception{
Result result=userService.userImportExcel(file);
return result;
}
/**
* 导出
* @param response
* @return
* @throws Exception
*/
@GetMapping("/export")
public Result userExport2(HttpServletResponse response) throws Exception{
Result result=userService.userExportExcel(response);
return result;
}service实现类层
/*
*导入
*/
public Result userImportExcel(MultipartFile file){
try {
InputStream inputStream = file.getInputStream();
XSSFWorkbook sheets = new XSSFWorkbook(inputStream);
//获取表单sheet 第一个
XSSFSheet sheetAt = sheets.getSheetAt(0);
//获取第一行
int firstRowNum = sheetAt.getFirstRowNum();
//最后一行
int lastRowNum = sheetAt.getLastRowNum();
//存入数据集合
List users=new ArrayList<>();
//遍历数据
for(int i=firstRowNum+1;i list = list();
//遍历设置值
for(int i=0;i 第二种:
controller
//导出用户信息到表格
@ApiOperation(value="导出用户信息到表格", notes="导出用户信息到表格")
@GetMapping("/out/xls")
public ResConfig outXls(){
return ResConfig.success(userService.outXls());
}
//导入表格信息到用户
@ApiOperation(value="导入表格信息到用户", notes="导入表格信息到用户")
@PostMapping("/put/xls")
public ResConfig putXls(MultipartFile file){
try {
return ResConfig.success(userService.putXls(file));
}catch (Exception e){
return ResConfig.error(e.getMessage());
}
}业务逻辑层
//导出用户信息到表格
@Override
public Object outXls() {
List resultList = baseMapper.outXls();
ExcelUtils.buildExcelFile("D:/srv/abbot.xlsx",resultList, OutXlsVO.class);
return resultList.size();
}
//导入表格信息到用户
@Override
@Transactional(rollbackFor = Exception.class)
public int putXls(MultipartFile file)throws Exception{
List list = ExcelUtils.readExcel("", PutXlsDTO.class, file);
int res = 0;
if (list.size()>0){
for(PutXlsDTO item:list){
if(item.getName()==null || item.getName().equals("")){
throw new Exception("姓名-不能为空");
}
if(item.getGender()==null || item.getGender().equals("")){
throw new Exception("性别-不能为空");
}
if(item.getPhoneNumber()==null || item.getPhoneNumber().equals("")){
throw new Exception("手机号码-不能为空");
}
if(item.getLoginAccount()==null || item.getLoginAccount().equals("")){
throw new Exception("账号-不能为空");
}
if(item.getLoginPassword()==null || item.getLoginPassword().equals("")){
throw new Exception("密码-不能为空");
}
if(item.getNick()==null || item.getNick().equals("")){
throw new Exception("昵称-不能为空");
}
CreateUserDTO dto = new CreateUserDTO(item);
int find = baseMapper.findByAccountOrPhone(dto.getLoginAccount(),dto.getPhoneNumber());
if(find!=0){
throw new Exception("账号或手机号已存在！");
}
dto.setLoginPassword(StaticUitls.getSHA256(dto.getLoginPassword()));
res = res + baseMapper.createUser(dto);
}
}
return res;
}