话不多说，直接撸代码吧
首先已引入相关依赖
javax.validation
validation-api
org.hibernate
hibernate-validator
org.apache.poi
poi
3.13
compile
org.apache.poi
poi-ooxml
3.13
compile
一、实现自定义注解
自定义注解定义列名和列号，因为解析Excel我们需要定义与表字段对应的实体类。此处自定义注解用于标记实体类的属性字段
/**
* Excel字段注解
*
* @author frank.xiong
* @version 2020/2/24. 21:37
*/
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelColumn {
String value() default "";
int col() default 0;
}
二、实现实体类
创建与Excel列相对赢的实体类
import lombok.Data;
/**
* 设计师导入模板
* @author frank.xiong
* @version 2020/2/24. 22:05
*/
@Data
public class DesignerImportTemplate {
@ExcelColumn(value = "*姓名", col = 1)
private String designerName;
@ExcelColumn(value = "*所属门店", col = 2)
private String shopName;
@ExcelColumn(value = "*电话", col = 3)
private String phone;
@ExcelColumn(value = "*简介", col = 4)
private String introduce;
@ExcelColumn(value = "备注", col = 5)
private String remark;
}
三、实现Excel解析工具类
import com.mklinfo.starhome.server.common.excel.ExcelColumn;
import lombok.extern.slf4j.Slf4j;
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.*;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.springframework.http.MediaType;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.net.URLEncoder;
import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* Excel工具类
*
* @author fank.xiong
* @version 2020/2/24. 21:37
*/
@Slf4j
public class ExcelUtils {
private final static String EXCEL2003 = "xls";
private final static String EXCEL2007 = "xlsx";
public static List readExcel(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)) {
workbook = new XSSFWorkbook(is);
}
if (fileName.endsWith(EXCEL2003)) {
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;
}
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;
}
/**
* 字段处理
* @param t
* @param value
* @param field
* @param
* @throws Exception
*/
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 (DateUtil.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();
}
}
/**
* 写入excel数据
*
* @param response
* @param dataList
* @param cls
* @param fileName
* @param needExtended 是否需要扩展的sheet
* @param extendContent 扩展sheet的内容
* @param
*/
public static void writeExcel(HttpServletResponse response, List dataList, Class cls, String fileName, Boolean needExtended, List extendContent) {
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");
int tempSize = fieldList.size();
for (int i = 0; i < tempSize; i++) {
sheet.setColumnWidth(i, 4000);
}
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 = getCellStyle(wb);
Font font = wb.createFont();
font.setBoldweight(Font.BOLDWEIGHT_BOLD);
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) {
log.error("excel error", e);
}
Cell cell = row1.createCell(aj.getAndIncrement());
CellStyle cellStyle = getCellStyle(wb);
cell.setCellStyle(cellStyle);
if (value != null) {
if (type == Date.class) {
cell.setCellValue(value.toString());
} else {
cell.setCellValue(value.toString());
}
cell.setCellValue(value.toString());
}
});
});
}
//扩展的sheet写入
if (needExtended) {
if (CollectionUtils.isNotEmpty(extendContent)) {
int size = extendContent.size();
String writeContent = StringUtils.join(extendContent, "\n");
Sheet extSheet = wb.createSheet("说明");
Row row = extSheet.createRow(0);
Cell cell = row.createCell(0);
CellStyle cellStyle = wb.createCellStyle();
cellStyle.setWrapText(true);
Font font = wb.createFont();
font.setBoldweight(Font.BOLDWEIGHT_BOLD);
cellStyle.setFont(font);
cell.setCellStyle(cellStyle);
cell.setCellValue(writeContent);
// 合并日期占两行(4个参数，分别为起始行，结束行，起始列，结束列)
// 行和列都是从0开始计数，且起始结束都会合并
CellRangeAddress region = new CellRangeAddress(0, size, 0, 8);
extSheet.addMergedRegion(region);
}
}
//浏览器下载excel
buildExcelDocument(fileName, wb, response);
}
private static CellStyle getCellStyle(Workbook wb) {
CellStyle cellStyle = wb.createCellStyle();
cellStyle.setFillForegroundColor(IndexedColors.WHITE.getIndex());
cellStyle.setFillPattern(CellStyle.SOLID_FOREGROUND);
cellStyle.setAlignment(CellStyle.ALIGN_CENTER);
cellStyle.setBorderBottom(CellStyle.BORDER_THIN);
cellStyle.setBorderLeft(CellStyle.BORDER_THIN);
cellStyle.setBorderTop(CellStyle.BORDER_THIN);
cellStyle.setBorderRight(CellStyle.BORDER_THIN);
return cellStyle;
}
/**
* 浏览器下载excel
*
* @param fileName
* @param wb
* @param response
*/
private static void buildExcelDocument(String fileName, Workbook wb, HttpServletResponse response) {
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) {
log.error("excel error, fileName:{}", fileName, e);
}
}
/**
* 生成excel文件
*
* @param path 生成excel路径
* @param wb
*/
private static void buildExcelFile(String path, Workbook wb) {
File file = new File(path);
if (file.exists()) {
file.delete();
}
try {
wb.write(new FileOutputStream(file));
} catch (Exception e) {
log.error("excel error, path:{}", path, e);
}
}
}
四、实现controller
实现导入
/**
* 导入设计师数据
*
* @param file
* @param user
*/
@Transactional(propagation = Propagation.REQUIRED, isolation = Isolation.DEFAULT, rollbackFor = Exception.class)
public void importDesignerInfo(MultipartFile file, CurrentUser user) {
//解析Excel
List excelColumns = ExcelUtils.readExcel(DesignerImportTemplate.class, file);
//以下是业务逻辑，根据自己的业务逻辑修改
if (CollectionUtils.isNotEmpty(excelColumns)) {
List designers = checkImportDesignerInfo(excelColumns);
Set returnIds = Sets.newHashSet();
designers.forEach(it -> {
Long returnId = saveDesigner(it, user);
returnIds.add(returnId);
});
} else {
throw new ServiceException(ExceptionDef.DATA_ERROR);
}
}
实现导出
创建导出实体类
import com.mklinfo.hrpro.server.common.excel.ExcelColumn;
import lombok.Data;
import java.time.LocalDateTime;
@Data
public class ValueExportVO {
@ExcelColumn(value = "员工号", col=1 )
private String employeeCode;
@ExcelColumn(value = "姓名", col=2 )
private String employeeName;
@ExcelColumn(value = "单位", col=3 )
private String companyName;
@ExcelColumn(value = "部门", col=4 )
private String deptName;
@ExcelColumn(value = "职位", col=5 )
private String jobName;
@ExcelColumn(value = "期间名称", col=6 )
private String period;
@ExcelColumn(value = "自评总分", col=7 )
private Integer selfScore;
@ExcelColumn(value = "上级总评分", col=8 )
private Integer superiorScore;
@ExcelColumn(value = "最终评级", col=9 )
private String grade;
@ExcelColumn(value = "更新时间", col=10 )
private LocalDateTime updateTime;
@ExcelColumn(value = "更新人名", col=11 )
private String editor;
}
实现业务逻辑
/**
* 导出员工价值观
* @param valueQueryDTO
* @param response
*/
public void exportValues(ValueQueryDTO valueQueryDTO, HttpServletResponse response){
String fileName = "员工价值观" ;
//查询导出数据
List valueVOList = bizValuesMapper.queryValueList(valueQueryDTO);
List valueExportVOList = BeanUtils.copyProperties(valueVOList,ValueExportVO.class);
ExcelUtils.writeExcel(response, valueExportVOList, ValueExportVO.class, fileName, false, null);
}
实现controller
@ApiOperation(value = "导出员工价值观", notes = "导出员工价值观")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "请求成功"),
@ApiResponse(code = 500, message = "系统内部错误")
})
@GetMapping(value = "/export", produces = "application/json;charset=utf-8")
public void exportValues(@Validated @ModelAttribute ValueQueryDTO dto, HttpServletResponse response) {
valueService.exportValues(dto, response);
}
就这么简单的实现啦