HuTool工具类使用之Excel文档的导入导出 | 极客IT

HuTool工具类使用之Excel文档的导入导出

前言

在日常的工作开发中，Excel的导入和导出是必不可少的，如果自己写相应的导入导出方法，会显得十分繁琐，本文采用Hutool工具类实现的Excel导入导出功能，可以大幅度减少今后开发中Excel的导入导出的相关操作。

提示：以下是本篇文章正文内容，下面案例可供参考

一、Hutool是什么？

Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。

Hutool中的工具方法来自于每个用户的精雕细琢，它涵盖了Java开发底层代码中的方方面面，它既是大型项目开发中解决小问题的利器，也是小型项目中的效率担当；

Hutool是项目中“util”包友好的替代，它节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。

二、导出Excel文件

   1.引入相关依赖

Java针对MS Office的操作的库屈指可数，比较有名的就是Apache的POI库。这个库异常强大，但是使用起来也并不容易。Hutool针对POI封装一些常用工具，使Java操作Excel等文件变得异常简单。Hutool-poi是针对Apache POI的封装，因此需要用户自行引入POI库,Hutool默认不引入。

需要注意的是，hutool-4.x的poi-ooxml 版本需高于 3.17，hutool-5.x的poi-ooxml 版本需高于 4.1.2；本文使用的依赖信息如下图所示：

<!-- hutool工具类依赖-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.4.3</version>
</dependency>

<!--POI依赖，对office进行操作-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>4.1.2</version>
</dependency>

   2.Excel导出功能的实现

Hutool将Excel写出封装为ExcelWriter，原理为包装了Workbook对象，每次调用merge（合并单元格）或者write（写出数据）方法后只是将数据写入到Workbook，并不写出文件，只有调用flush或者close方法后才会真正写出文件。由于机制原因，在写出结束后需要关闭ExcelWriter对象，调用close方法即可关闭，此时才会释放Workbook对象资源，否则带有数据的Workbook一直会常驻内存。代码如下所示：

@RequestMapping(EXCEL_DOWNLOAD)
public void excelExport(HttpServletResponse httpServletResponse) throws IOException {
UserDTO userDTO = new UserDTO();
List<UserDTO> userDTOS = userService.selectUserDOBatch(userDTO);
//通过hutool工具创建的excel的writer，默认为xls格式
ExcelWriter writer = ExcelUtil.getWriter();
//设置要导出到的sheet
writer.setSheet("表2");
writer.setSheet("表3");
//自定义excel标题和列名
writer.addHeaderAlias("id","用户ID");
writer.addHeaderAlias("userName","用户名");
writer.addHeaderAlias("loginPassword","密码");
writer.addHeaderAlias("email","邮箱");
writer.addHeaderAlias("createDate","数据创建日期");
//合并单元格后的标题行，使用默认标题样式
writer.merge(4,"用户基本信息表");
writer.renameSheet(0,"用户登录信息");
//一次性写出内容，使用默认样式，强制输出标题
writer.write(userDTOS,true);

httpServletResponse.setContentType("application/vnd.ms-excel;charset=utf-8");
//name是下载对话框的名称，不支持中文，想用中文名称需要进行utf8编码
String excelName = "用户基本信息表";
//excelName = new String(excelName.getBytes(),"utf-8");
excelName = URLEncoder.encode(excelName, "utf-8");
httpServletResponse.setHeader("Content-Disposition", "attachment;filename=" + excelName +".xls");

//将excel文件信息写入输出流，返回给调用者
ServletOutputStream excelOut = null;
try {
excelOut = httpServletResponse.getOutputStream();
writer.flush(excelOut,true);
} catch (IOException e) {
e.printStackTrace();
}finally {
writer.close();
}
IoUtil.close(excelOut);
}

以上导出的Excel格式为.xls，如果想要导出格式为.xlsx的excel文件，只需修改上图所示的相应位置代码即可，修改代码为：

//设置返回excel的格式为xlsx
httpServletResponse.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=utf-8");
httpServletResponse.setHeader("Content-Disposition","attachment;filename="+ URLEncoder.encode("用户信息表","utf-8") + ".xlsx");

生成的excel文件如下如所示：

二、导出Excel文件

   1.Excel读取-ExcelReader

Excel文件的导入分为三种情况：

1.读取Excel中所有行和列，都用列表表示

ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<List<Object>> readAll = reader.read();

2.读取为Map列表，默认第一行为标题行，Map中的key为标题，value为标题对应的单元格值。

ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<Map<String,Object>> readAll = reader.readAll();

3.读取为Bean列表，Bean中的字段名为标题，字段值为标题对应的单元格值。

ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<Person> all = reader.readAll(Person.class);

本文Excel导入读取示例采用的是第三种方法实现，相关代码如下所示：

 @RequestMapping(READ_EXCEL)
    public void readExcel(){
        ExcelReader reader = ExcelUtil.getReader("H:\\user.xlsx");
        List<UserDTO> userDTOS = reader.readAll(UserDTO.class);
        //日志输出读取到的信息
        log.info(userDTOS.toString());
    }

其中UserDTO类的代码如下所示：

@Data
public class UserDTO {
    @NotNull(message = "用户id不能为空")
    private Integer id;

    @NotNull(message = "用户名不能为空")
    @Size(min = 4, max = 16, message = "用户名长度错误")
    private String userName;

    @NotNull(message = "密码不能为空")
    @Size(min = 4, max = 16, message = "密码长度错误")
    private String loginPassword;

    @NotNull(message = "邮箱不能为空")
    @Email(message = "邮箱格式错误")
    private String email;

    @NotNull(message = "日期不能为空")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    private Date createDate;
}
赞 (0)

相关推荐