0
0

EasyExcel导入和导出数据

pom

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>easyexcel</artifactId>
        <version>3.1.1</version>
    </dependency>


# 实体类

```java
/**
 * @author:lzp
 * @create: 2022-08-01 15:06
 * @Description: 员工表excel增强
 */

/**
 * @author:lzp
 * @create: 2022-07-03 15:57
 * @Description: excel
 */

@Data
public class EmpExcelVo {
    /**
     * 员工编号
     */
    @ExcelProperty(value = "编号" ,index = 0)
    private Integer id;

    /**
     * 员工姓名
     */
    @ExcelProperty(value = "姓名" ,index = 1)
    private String name;

    /**
     * 工号
     */
    @ExcelProperty(value = "工号" ,index = 2)
    private String workId;

    /**
     * 性别
     */
    @ExcelProperty(value = "性别" ,index = 3)
    private String gender;

    /**
     * 出生日期
     */
    @ExcelProperty(value = "出生日期" ,index =4 )
    @DateTimeFormat("yyyy-MM-dd")
    private java.util.Date birthday;

    /**
     * 身份证号
     */
    @ExcelProperty(value = "身份证号码" ,index = 5)
    private String idCard;

    /**
     * 婚姻状况
     */
    @ExcelProperty(value = "婚姻状况" ,index = 6)
    private String wedlock;

    /**
     * 民族
     */
    @ExcelProperty(value = "民族" ,index = 7)
    private String nationName;

    /**
     * 籍贯
     */
    @ExcelProperty(value = "籍贯" ,index = 8)
    private String nativePlace;

    /**
     * 政治面貌
     */
    @ExcelProperty(value = "政治面貌" ,index = 9)
    private String politicName;

    /**
     * 邮箱
     */
    @ExcelProperty(value = "邮箱" ,index = 10)
    private String email;

    /**
     * 电话号码
     */
    @ExcelProperty(value = "电话号码" ,index = 11)
    private String phone;

    /**
     * 联系地址
     */
    @ExcelProperty(value = "联系地址" ,index = 12)
    private String address;

    /**
     * 所属部门
     */
    @ExcelProperty(value = "所属部门" ,index = 13)
    private String departmentName;

    /**
     * 职称ID
     */
    @ExcelProperty(value = "职称" ,index = 14)
    private String jobLevelName;

    /**
     * 职位ID
     */
    @ExcelProperty(value = "职位" ,index = 15)
    private String posName;

    /**
     * 聘用形式
     */
    @ExcelProperty(value = "聘用形式" ,index = 16)
    private String engageForm;

    /**
     * 最高学历
     */
    @ExcelProperty(value = "最高学历" ,index = 17)
    private String tiptopDegree;

    /**
     * 所属专业
     */
    @ExcelProperty(value = "专业" ,index = 18)
    private String specialty;

    /**
     * 毕业院校
     */
    @ExcelProperty(value = "毕业院校" ,index = 19)
    private String school;

    /**
     * 入职日期
     */
    @ExcelProperty(value = "入职日期" ,index = 20)
    @DateTimeFormat("yyyy-MM-dd")
    private Date beginDate;

    /**
     * 在职状态
     */
    @ExcelProperty(value = "在职状态" ,index = 21)
    private String workState;

    /**
     * 合同期限
     */
    @ExcelProperty(value = "合同期限" ,index = 22)
    private Double contractTerm;

    /**
     * 转正日期
     */
    @ExcelProperty(value = "转正日期" ,index = 23)
    @DateTimeFormat("yyyy-MM-dd")
    private java.util.Date conversionTime;

    /**
     * 离职日期
     */
    @ExcelProperty(value = "离职日期" ,index = 24)
    @DateTimeFormat("yyyy-MM-dd")
    private java.util.Date notWorkDate;

    /**
     * 合同起始日期
     */
    @ExcelProperty(value = "合同起始日期" ,index = 25)
    @DateTimeFormat("yyyy-MM-dd")
    private java.util.Date beginContract;

    /**
     * 合同终止日期
     */
    @ExcelProperty(value = "合同终止日期" ,index = 26)
    @DateTimeFormat("yyyy-MM-dd")
    private java.util.Date endContract;

    /**
     * 工龄
     */
    @ExcelProperty(value = "工龄" ,index = 27)
    private Integer workAge;
}

1.导出

1.cmtroller

调用service方法，完成导出

/**
     * @Author lzp
     * @Description:  导出员工数据
     * @Date: 16:09 2022/7/3
     * @Param: []
     * @return: com.lzp.vhrserver.utils.R
     */@GetMapping("/exportEmpData")publicvoidexportEmpData(HttpServletResponse response)throwsIOException{
        employeeEntityService.exportEmpData(response);}

2.service
调用工具类的方法完成导出
传入response，标题控制类(标题名称，合并的列数)，员工列表，文件名称，excel的标题名称，要导出的数据类

/**
     * 导出
     * @param response
     * @throws IOException
     */publicvoidexportEmpData(HttpServletResponse response)throwsIOException{List<EmpExcelVo> employeeEntities =this.getAllEmp();ExportExcelUtil.exportExcel(response,newMonthSheetWriteHandler("员工表",9),
                employeeEntities,"员工表",EmpExcelVo.class);}

3.工具类中的方法

/**
 * @author:lzp
 * @create: 2022-08-02 13:28
 * @Description: excel导出工具类
 */publicclassExportExcelUtil{/**
     * @Author lzp
     * @Description:
     * @Date: 13:32 2022/8/2
     * @Param: [response 响应, sheetWriteHandler 控制标题样式, list 要导出的数据, fileName 文件名,实体类 表头使用]
     * @return: void
     */publicstaticvoidexportExcel(HttpServletResponse response,@NullableSheetWriteHandler sheetWriteHandler,List<?> list,String fileName,Class baseEntity)throwsIOException{
        response.setContentType("application/vnd.ms-excel");//格式excel
        response.setCharacterEncoding("utf-8");//这里URLEncoder.encode可以防止中文乱码
        fileName =URLEncoder.encode(fileName,"UTF-8");//Content-disposition：以下载的方式执行此操作
        response.setHeader("Content-Disposition","attachment;filename="+ fileName +".xlsx");//内容样式策略WriteCellStyle writeCellStyle =newWriteCellStyle();//垂直居中 水平居中
        writeCellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        writeCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
        writeCellStyle.setBorderLeft(BorderStyle.THIN);
        writeCellStyle.setBorderTop(BorderStyle.THIN);
        writeCellStyle.setBorderRight(BorderStyle.THIN);
        writeCellStyle.setBorderBottom(BorderStyle.THIN);//设置自动换行 这里不设置 采用自适应宽度//writeCellStyle.setWrapped(true);//字体策略WriteFont writeFont =newWriteFont();
        writeFont.setFontHeightInPoints((short)12);
        writeCellStyle.setWriteFont(writeFont);//头策略WriteCellStyle headWriteStyle =newWriteCellStyle();ExcelWriter excelWriter =EasyExcel.write(response.getOutputStream(),baseEntity)//设置输出excel，不设置默认为xlsx//.excelType(ExcelTypeEnum.XLS)//设置拦截器自定义样式//宽度自适应 自定义handler.registerWriteHandler(newCustomCellWriteWeightConfig())//设置标题（小标题）行高和内容行高.registerWriteHandler(newSimpleRowHeightStyleStrategy((short)40,(short)30))//自定义文件的标题（大标题） 在调用方法时传入的参数 MonthSheetWriteHandler类型.registerWriteHandler(sheetWriteHandler).registerWriteHandler(newHorizontalCellStyleStrategy(headWriteStyle,writeCellStyle))//.sheet(fileName)//设置默认样式及写入头信息开始的行数 第一行为大标题 这里1代表从第二行开始.useDefaultStyle(true).relativeHeadRowIndex(1).build();
                excelWriter.write(list,EasyExcel.writerSheet(fileName).build());
                excelWriter.finish();//EasyExcel.write(response.getOutputStream(),baseEntity)//        //设置输出excel，不设置默认为xlsx//        //.excelType(ExcelTypeEnum.XLS)//        //设置拦截器自定义样式//        //宽度自适应//        .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())//        //设置标题（小标题）行高和内容行高//        .registerWriteHandler(new SimpleRowHeightStyleStrategy((short)40,(short)30))//        //自定义文件的标题（大标题）//        .registerWriteHandler(sheetWriteHandler)//        .registerWriteHandler(new HorizontalCellStyleStrategy(headWriteStyle,writeCellStyle))//        .sheet(fileName)//        //设置默认样式及写入头信息开始的行数//        .useDefaultStyle(true).relativeHeadRowIndex(3)//        .doWrite(list);}

4.控制标题类
这个类控制数据之前的显示内容

/**
 * @author:lzp
 * @create: 2022-08-01 10:51
 * @Description: excel拦截器 定义内容中的大标题
 */publicclassMonthSheetWriteHandlerimplementsSheetWriteHandler{//excel的标题内容privateString title;//对应参数 标题合并单元格使用 实际参数数量减1privateInteger params;publicMonthSheetWriteHandler(String title,Integer params){this.title=title;this.params=params;}@OverridepublicvoidbeforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder,WriteSheetHolder writeSheetHolder){}@OverridepublicvoidafterSheetCreate(WriteWorkbookHolder writeWorkbookHolder,WriteSheetHolder writeSheetHolder){Workbook workbook = writeWorkbookHolder.getWorkbook();Sheet sheet = workbook.getSheetAt(0);//第一行// 设置标题Row row2 = sheet.createRow(0);
        row2.setHeight((short)800);Cell cell1 = row2.createCell(0);
        cell1.setCellValue(this.title);CellStyle cellStyle = workbook.createCellStyle();
        cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        cellStyle.setAlignment(HorizontalAlignment.CENTER);Font font = workbook.createFont();
        font.setBold(true);
        font.setFontHeight((short)400);
        cellStyle.setFont(font);
        cell1.setCellStyle(cellStyle);//调整标题的居中显示位置 0 0 代表第几行 这里是只用第0行，后面两个参数是合并的列 0开始，结束根据参数数量决定
        sheet.addMergedRegionUnsafe(newCellRangeAddress(0,0,0,this.params));}}

效果
在这里插入图片描述
2022-10-28 乱码解决
因为文件名经过了 “URLEncoder.encode(fileName, “UTF-8”)”转换，可以保证excel文件名中文正常，但是sheet名就会变成转换的格式。
解决办法是 将文件名单独定义，使用URLEncoder.encode方法转换格式，sheet名用方法传递的参数即可
在这里插入图片描述
在这里插入图片描述

2.导入

创建一个listener，逐条插入数据
1.controller

@PostMapping("/importEmpData")publicRimportEmpData(MultipartFile file){this.employeeEntityService.importEmpData(file);returnR.ok("导入成功！");}

service

publicvoidimportEmpData(MultipartFile file){try{//headRowNumber 2 代表从第3行开始导入 第一行为大标题 第二行为表头EasyExcel.read(file.getInputStream(),EmpExcelVo.class,newMyExcelListener(this)).headRowNumber(2).sheet().doRead();}catch(IOException e){
            e.printStackTrace();}}

2.通用listener

调用invoke方法，实现数据导入，这里定义通用类型，避免每有一个导入任务就创建一个listener。
定义一个包含添加的接口，业务实现类实现这个接口，重写添加方法，保证数据准确的添加进数据库。
创建listener时，传入对应的业务实现类。

/**
 * @author:lzp
 * @create: 2022-08-02 14:05
 * @Description: 导入数据通用监听器
 */@Slf4jpublicclassMyExcelListener<T>extendsAnalysisEventListener<T>{privateMap<String,Object> param;//3000条保存一次数据privatestaticfinalint BATCH_COUNT=3000;//数据缓存privateList<T> list =newArrayList<>(BATCH_COUNT);//mapperprivateSaveInterface<T> saveInterface;//public MyExcelListener(SaveInterface<T> saveInterface, Map<String, Object> param) {//    this.saveInterface = saveInterface;//    this.param = param;//}//构造器publicMyExcelListener(SaveInterface<T> saveInterface){this.saveInterface = saveInterface;}@Overridepublicvoidinvoke(T data,AnalysisContext analysisContext){try{//通用方法数据校验ExcelImportValid.valid(data);}catch(ExceptionCustom e){// System.out.println(e.getMessage());//在easyExcel监听器中抛出业务异常thrownewExcelAnalysisException(e.getMessage());}
        log.info("解析到一条数据：{}",data.toString());//先将数据加到list中
        list.add(data);// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOMif(list.size()>= BATCH_COUNT){saveData();// 存储完成清理 list
            list =newArrayList<>(BATCH_COUNT);}}//最后再存储一次数据@OverridepublicvoiddoAfterAllAnalysed(AnalysisContext analysisContext){// 这里也要保存数据，确保最后遗留的数据也存储到数据库saveData();//logger.info("所有数据解析完成！");}/**
     * 加上存储数据库
     */privatevoidsaveData(){//logger.info("{}条数据，开始存储数据库！", list.size());
        saveInterface.save(list,param);//logger.info("存储数据库成功！");}}

3.接口

publicinterfaceSaveInterface<T>{voidsave(List<T> list,Map<String,Object> param);}

4.业务实现类
实现第三步创建的接口
在这里插入图片描述

实现方法
将dto转为和数据库对应的实体类

@Overridepublicvoidsave(List<EmpExcelVo> list,Map<String,Object> param){//遍历list集合 逐条保存数据for(EmpExcelVo empExcelVo:list){EmployeeEntity employeeEntity =newEmployeeEntity();//对象拷贝BeanUtils.copyProperties(empExcelVo,employeeEntity);//时间相关的需要先获取java.util.Date类型的 然后转换为sql.date类型的java.util.Date beginContract = empExcelVo.getBeginContract();java.util.Date endContract = empExcelVo.getEndContract();java.util.Date birthday = empExcelVo.getBirthday();java.util.Date beginDate = empExcelVo.getBeginDate();java.util.Date conversionTime = empExcelVo.getConversionTime();//vo中存的为名称 需要转换为id 存到数据库Integer idByName = politicsstatusEntityService.getIdByName(empExcelVo.getPoliticName());
            employeeEntity.setBeginContract(newDate(beginContract.getTime()));
            employeeEntity.setEndContract(newDate(endContract.getTime()));
            employeeEntity.setBirthday(newDate(birthday.getTime()));
            employeeEntity.setBeginDate(newDate(beginDate.getTime()));
            employeeEntity.setConversionTime(newDate(conversionTime.getTime()));
            employeeEntity.setPoliticId(idByName);this.addEmp(employeeEntity);}}

3.导入时数据校验

1.自定义注解

@Target({ElementType.FIELD,ElementType.TYPE })@Retention(RetentionPolicy.RUNTIME)public@interfaceExcelValid{Stringmessage()default"导入有为空得字段";}

2.校验注解类

/**
 * @author:lzp
 * @create: 2022-08-02 10:30
 * @Description: excel字段校验类
 */publicclassExcelImportValid{/**
     * Excel导入字段校验
     *
     * @param object 校验的JavaBean 其属性须有自定义注解
     */publicstaticvoidvalid(Object object)throwsExceptionCustom{//获取当前类的所有属性Field[] fields = object.getClass().getDeclaredFields();for(Field field : fields){//设置可访问
            field.setAccessible(true);//属性的值Object fieldValue =null;try{//获取到字段的值
                fieldValue = field.get(object);}catch(IllegalAccessException e){thrownewExceptionCustom("IMPORT_PARAM_CHECK_FAIL","导入参数检查失败");}//是否包含必填校验注解boolean isExcelValid = field.isAnnotationPresent(ExcelValid.class);//如果包含这个注解，并且获取到的值为null，抛出异常if(isExcelValid &&Objects.isNull(fieldValue)){thrownewExceptionCustom("NULL", field.getAnnotation(ExcelValid.class).message());}}}}

3.使用方法
在需要校验的字段加上注解
在这里插入图片描述
在invoke中开启校验

try{//通用方法数据校验ExcelImportValid.valid(data);}catch(ExceptionCustom e){// System.out.println(e.getMessage());//在easyExcel监听器中抛出业务异常 这个异常会被controller捕获，将错误信息返回给前端thrownewExcelAnalysisException(e.getMessage());}

4.ExceptionCustom 类

/**
 * @author:lzp
 * @create: 2022-08-02 10:35
 * @Description: 自定义异常
 */@Data@EqualsAndHashCode(callSuper =true)publicclassExceptionCustomextendsRuntimeException{privatestaticfinallong serialVersionUID =1L;publicExceptionCustom(){}/**
     * 错误编码
     */privateString errorCode;/**
     * 消息是否为属性文件中的Key
     */privateboolean propertiesKey =true;/**
     * 构造一个基本异常.
     *
     * @param message
     *            信息描述
     */publicExceptionCustom(String message){super(message);}/**
     * 构造一个基本异常.
     *
     * @param errorCode
     *            错误编码
     * @param message
     *            信息描述
     */publicExceptionCustom(String errorCode,String message){this(errorCode, message,true);}/**
     * 构造一个基本异常.
     *
     * @param errorCode
     *            错误编码
     * @param message
     *            信息描述
     */publicExceptionCustom(String errorCode,String message,Throwable cause){this(errorCode, message, cause,true);}/**
     * 构造一个基本异常.
     *
     * @param errorCode
     *            错误编码
     * @param message
     *            信息描述
     * @param propertiesKey
     *            消息是否为属性文件中的Key
     */privateExceptionCustom(String errorCode,String message,boolean propertiesKey){super(message);this.setErrorCode(errorCode);this.setPropertiesKey(propertiesKey);}/**
     * 构造一个基本异常.
     *
     * @param errorCode
     *            错误编码
     * @param message
     *            信息描述
     */publicExceptionCustom(String errorCode,String message,Throwable cause,boolean propertiesKey){super(message, cause);this.setErrorCode(errorCode);this.setPropertiesKey(propertiesKey);}/**
     * 构造一个基本异常.
     *
     * @param message
     *            信息描述
     * @param cause
     *            根异常类（可以存入任何异常）
     */publicExceptionCustom(String message,Throwable cause){super(message, cause);}}
标签： java apache 大数据
本文转载自: https://blog.csdn.net/weixin_46666822/article/details/126122621
版权归原作者 执迷11 所有， 如有侵权，请联系我们删除。
登录后发布评论

“EasyExcel导入和导出数据”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

AI 2.0 时代的安全基础设施

LLVM——安装多版本LLVM和Clang并切换使用（Ubuntu）

Ubuntu 22.04远程桌面xrdp打开黑屏

IDEA使用Database连接达梦数据库

免费获取Windows7专业版ISO镜像！附上详细安装教程

Docker报错，求帮忙！

vue+element-ui的列表查询条件/筛选条件太多以下拉选择方式动态添加条件（支持全选、反选、清空）

文章导航