Excel生成-ExcelWriter

    Hutool将Excel写出封装为,原理为包装了Workbook对象,每次调用merge(合并单元格)或者write(写出数据)方法后只是将数据写入到Workbook,并不写出文件,只有调用flush或者close方法后才会真正写出文件。

    由于机制原因,在写出结束后需要关闭ExcelWriter对象,调用close方法即可关闭,此时才会释放Workbook对象资源,否则带有数据的Workbook一直会常驻内存。

    我们先定义一个嵌套的List,List的元素也是一个List,内层的一个List代表一行数据,每行都有4个单元格,最终list对象代表多行数据。

    然后我们创建ExcelWriter对象后写出数据:

    1. //通过工具类创建writer
    2. ExcelWriter writer = ExcelUtil.getWriter("d:/writeTest.xlsx");
    3. //通过构造方法创建writer
    4. //ExcelWriter writer = new ExcelWriter("d:/writeTest.xls");
    5. //跳过当前行,既第一行,非必须,在此演示用
    6. writer.passCurrentRow();
    7. //合并单元格后的标题行,使用默认标题样式
    8. writer.merge(list1.size() - 1, "测试标题");
    9. //一次性写出内容,强制输出标题
    10. writer.write(rows, true);
    11. //关闭writer,释放内存
    12. writer.close();

    效果:

    2. 写出Map数据

    1. Map<String, Object> row1 = new LinkedHashMap<>();
    2. row1.put("姓名", "张三");
    3. row1.put("年龄", 23);
    4. row1.put("成绩", 88.32);
    5. row1.put("是否合格", true);
    6. row1.put("考试日期", DateUtil.date());
    7. Map<String, Object> row2 = new LinkedHashMap<>();
    8. row2.put("姓名", "李四");
    9. row2.put("年龄", 33);
    10. row2.put("成绩", 59.50);
    11. row2.put("是否合格", false);
    12. row2.put("考试日期", DateUtil.date());

    写出数据:

    1. // 通过工具类创建writer
    2. ExcelWriter writer = ExcelUtil.getWriter("d:/writeMapTest.xlsx");
    3. // 合并单元格后的标题行,使用默认标题样式
    4. writer.merge(row1.size() - 1, "一班成绩单");
    5. // 一次性写出内容,使用默认样式,强制输出标题
    6. // 关闭writer,释放内存
    7. writer.close();

    效果:写出效果

    3. 写出Bean数据

    定义Bean:

    构造数据:

    1. TestBean bean1 = new TestBean();
    2. bean1.setName("张三");
    3. bean1.setAge(22);
    4. bean1.setPass(true);
    5. bean1.setScore(66.30);
    6. bean1.setExamDate(DateUtil.date());
    7. TestBean bean2 = new TestBean();
    8. bean2.setName("李四");
    9. bean2.setAge(28);
    10. bean2.setPass(false);
    11. bean2.setScore(38.50);
    12. bean2.setExamDate(DateUtil.date());
    13. List<TestBean> rows = CollUtil.newArrayList(bean1, bean2);

    写出数据:

    1. // 通过工具类创建writer
    2. ExcelWriter writer = ExcelUtil.getWriter("d:/writeBeanTest.xlsx");
    3. // 合并单元格后的标题行,使用默认标题样式
    4. writer.merge(4, "一班成绩单");
    5. // 一次性写出内容,使用默认样式,强制输出标题
    6. writer.write(rows, true);
    7. // 关闭writer,释放内存
    8. writer.close();

    在写出Bean的时候,我们可以调用ExcelWriter对象的addHeaderAlias方法自定义Bean中key的别名,这样就可以写出自定义标题了(例如中文)。

    写出数据:

    1. // 通过工具类创建writer
    2. ExcelWriter writer = ExcelUtil.getWriter("d:/writeBeanTest.xlsx");
    3. //自定义标题别名
    4. writer.addHeaderAlias("name", "姓名");
    5. writer.addHeaderAlias("age", "年龄");
    6. writer.addHeaderAlias("score", "分数");
    7. writer.addHeaderAlias("isPass", "是否通过");
    8. writer.addHeaderAlias("examDate", "考试时间");
    9. // 合并单元格后的标题行,使用默认标题样式
    10. // 一次性写出内容,使用默认样式,强制输出标题
    11. writer.write(rows, true);
    12. // 关闭writer,释放内存

    效果:

    5. 写出到流

    6. 写出到客户端下载(写出到Servlet)

    1. // 通过工具类创建writer,默认创建xls格式
    2. ExcelWriter writer = ExcelUtil.getWriter();
    3. // 一次性写出内容,使用默认样式,强制输出标题
    4. writer.write(rows, true);
    5. //out为OutputStream,需要写出到的目标流
    6. //response为HttpServletResponse对象
    7. response.setContentType("application/vnd.ms-excel;charset=utf-8");
    8. //test.xls是弹出下载对话框的文件名,不能为中文,中文请自行编码
    9. response.setHeader("Content-Disposition","attachment;filename=test.xls");
    10. ServletOutputStream out=response.getOutputStream();
    11. writer.flush(out, true);
    12. // 关闭writer,释放内存
    13. writer.close();
    14. //此处记得关闭输出Servlet流
    15. IoUtil.close(out);

    注意ExcelUtil.getWriter()默认创建xls格式的Excel,因此写出到客户端也需要自定义文件名为XXX.xls,否则会出现文件损坏的提示。若想生成xlsx格式,请使用ExcelUtil.getWriter(true)创建。

    1. ExcelWriter writer = ...;
    2. // 定义单元格背景色
    3. StyleSet style = writer.getStyleSet();
    4. // 第二个参数表示是否也设置头部单元格背景
    5. style.setBackgroundColor(IndexedColors.RED, false);

    2. 自定义字体

    1. ExcelWriter writer = ...;
    2. //设置内容字体
    3. Font font = writer.createFont();
    4. font.setBold(true);
    5. font.setColor(Font.COLOR_RED);
    6. font.setItalic(true);
    7. //第二个参数表示是否忽略头部样式
    8. writer.getStyleSet().setFont(font, true);

    3. 写出多个sheet

    • 头部样式 headCellStyle
    • 普通单元格样式 cellStyle
    • 数字单元格样式 cellStyleForNumber
    • 日期单元格样式 cellStyleForDate其中cellStyleForNumber cellStyleForDate用于控制数字和日期的显示方式。

    因此我们可以使用以下方式获取CellStyle对象自定义指定种类的样式:

    1. StyleSet style = writer.getStyleSet();
    2. CellStyle cellStyle = style.getHeadCellStyle();
    3. ...