Java导出Excel

怼烎@ 2023-06-13 11:29 21阅读 0赞

## 一、详解写入Excel ##

本文使用的技术是Alibaba集团开源的EasyExcel技术，该技术是针对Apache POI技术的封装和优化，主要解决了POI技术的耗内存问题，并且提供了较好的API使用。不需要大量的代码就可以实现excel的操作功能。

### 文章目录 ###

*   *  一、详解写入Excel
     *   *  简单写入
         *  导出指定的列
         *  指定写入的列
         *  复杂头写入
         *  自定义格式转换
         *  图片导出
         *  列宽、行高
         *  合并单元格
         *  动态表头
         *  web数据写出

**数据写入公用方法**

private List<DemoData> data() { 
        List<DemoData> list = new ArrayList<DemoData>();
        for (int i = 0; i < 10; i++) { 
            DemoData data = new DemoData();
            data.setString("字符串" + i);
            data.setDate(new Date());
            data.setDoubleData(0.56);
            list.add(data);
        }
        return list;
    }

### 简单写入 ###

**对象**

public class DemoData { 
        @ExcelProperty("字符串标题")
        private String string;
        @ExcelProperty("日期标题")
        private Date date;
        @ExcelProperty("数字标题")
        private Double doubleData;
        // getting setting
    }

**代码**

@Test
    public void simpleWrite() { 
        // 写法1
        String System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write(fileName, DemoData.class).sheet("写入方法一").doWrite(data());
    
        // 写法2，方法二需要手动关闭流
        fileName = System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写
        ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build();
        WriteSheet writeSheet = EasyExcel.writerSheet("写入方法二").build();
        excelWriter.write(data(), writeSheet);
        /// 千万别忘记finish 会帮忙关闭流
        excelWriter.finish();
    }

### 导出指定的列 ###

**代码**

@Test
    public void excludeOrIncludeWrite() { 
        String fileName = "excludeOrIncludeWrite" + System.currentTimeMillis() + ".xlsx";
    
        // 忽略 date 不导出
        Set<String> excludeColumnFiledNames = new HashSet<String>();
        excludeColumnFiledNames.add("date");
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, DemoData.class).excludeColumnFiledNames(excludeColumnFiledNames).sheet("忽略date")
            .doWrite(data());
    
        fileName = "excludeOrIncludeWrite" + System.currentTimeMillis() + ".xlsx";
        // 根据用户传入字段 假设我们只要导出 date
        Set<String> includeColumnFiledNames = new HashSet<String>();
        includeColumnFiledNames.add("date");
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, DemoData.class).includeColumnFiledNames(includeColumnFiledNames).sheet("导出date")
            .doWrite(data());
    }

### 指定写入的列 ###

**对象**

public class IndexData { 
        /** * 导出的excel第二列和第四列将空置 */
        @ExcelProperty(value = "字符串标题", index = 0)
        private String string;
        @ExcelProperty(value = "日期标题", index = 2)
        private Date date;
        @ExcelProperty(value = "数字标题", index = 4)
        private Double doubleData;
    }

**代码**

@Test
    public void indexWrite() { 
        String fileName = "indexWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, IndexData.class).sheet("模板").doWrite(data());
    }

### 复杂头写入 ###

**对象**

public class ComplexHeadData { 
        /** * 主标题 将整合为一个单元格效果如下： * ————————————————————————— * | 主标题 | * ————————————————————————— * |字符串标题|日期标题|数字标题| * ————————————————————————— */
        @ExcelProperty({ "主标题", "字符串标题"})
        private String string;
        @ExcelProperty({ "主标题", "日期标题"})
        private Date date;
        @ExcelProperty({ "主标题", "数字标题"})
        private Double doubleData;
    }

**代码**

@Test
    public void complexHeadWrite() { 
        String fileName = "complexHeadWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, ComplexHeadData.class).sheet("模板").doWrite(data());
    }

### 自定义格式转换 ###

public class ConverterData { 
        /** * 自定义的转换 */
        @ExcelProperty(value = "字符串标题", converter = CustomStringConverter.class)
        private String string;
        /** * 我想写到excel 用年月日的格式 */
        @DateTimeFormat("yyyy年MM月dd日 HH时mm分ss秒")
        @ExcelProperty("日期标题")
        private Date date;
        /** * 我想写到excel 用百分比表示 */
        @NumberFormat("#.##%")
        @ExcelProperty(value = "数字标题")
        private Double doubleData;
        // getting setting
    }

**代码**

@Test
    public void converterWrite() { 
        String "converterWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, ConverterData.class).sheet("模板").doWrite(data());
    }

### 图片导出 ###

**对象**

@Data
    @ContentRowHeight(200)
    @ColumnWidth(200 / 8)
    public class ImageData { 
        // 图片导出方式有5种
        private File file;
        private InputStream inputStream;
        /** * 如果string类型 必须指定转换器，string默认转换成string，该转换器是官方支持的 */
        @ExcelProperty(converter = StringImageConverter.class)
        private String string;
        private byte[] byteArray;
        /** * 根据url导出 版本2.1.1才支持该种模式 */
        private URL url;
    }

**代码**

@Test
    public void imageWrite() throws Exception { 
        String fileName = "imageWrite" + System.currentTimeMillis() + ".xlsx";
        // 如果使用流 记得关闭
        InputStream inputStream = null;
        try { 
            List<ImageData> list = new ArrayList<ImageData>();
            ImageData imageData = new ImageData();
            list.add(imageData);
            String imagePath = "converter" + File.separator + "img.jpg";
            // 放入五种类型的图片 根据实际使用只要选一种即可
            imageData.setByteArray(FileUtils.readFileToByteArray(new File(imagePath)));
            imageData.setFile(new File(imagePath));
            imageData.setString(imagePath);
            inputStream = FileUtils.openInputStream(new File(imagePath));
            imageData.setInputStream(inputStream);
            imageData.setUrl(new URL(
                "https://raw.githubusercontent.com/alibaba/easyexcel/master/src/test/resources/converter/img.jpg"));
            EasyExcel.write(fileName, ImageData.class).sheet().doWrite(list);
        } finally { 
            if (inputStream != null) { 
                inputStream.close();
            }
        }
    }

### 列宽、行高 ###

**对象**

@Data
    @ContentRowHeight(10)
    @HeadRowHeight(20)
    @ColumnWidth(25)
    public class WidthAndHeightData { 
        @ExcelProperty("字符串标题")
        private String string;
        @ExcelProperty("日期标题")
        private Date date;
        /** * 宽度为50,覆盖上面的宽度25 */
        @ColumnWidth(50)
        @ExcelProperty("数字标题")
        private Double doubleData;
    }

**代码**

@Test
    public void widthAndHeightWrite() { 
        String fileName = "widthAndHeightWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(fileName, WidthAndHeightData.class).sheet("模板").doWrite(data());
    }

### 合并单元格 ###

**代码**

@Test
     public void mergeWrite() { 
         String fileName = "mergeWrite" + System.currentTimeMillis() + ".xlsx";
         // 每隔2行会合并 把eachColumn 设置成 3 也就是我们数据的长度，所以就第一列会合并。当然其他合并策略也可以自己写
         LoopMergeStrategy loopMergeStrategy = new LoopMergeStrategy(2, 0);
         // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
         EasyExcel.write(fileName, DemoData.class).registerWriteHandler(loopMergeStrategy).sheet("合并单元格")
             .doWrite(data());
     }

### 动态表头 ###

**代码**

@Test
    public void dynamicHeadWrite() { 
        String fileName = "dynamicHeadWrite" + System.currentTimeMillis() + ".xlsx";
        EasyExcel.write(fileName)
            // 这里放入动态头
            .head(head()).sheet("模板")
            // 当然这里数据也可以用 List<List<String>> 去传入
            .doWrite(data());
    }
    
    // 动态表头的数据格式List<List<String>>
    private List<List<String>> head() { 
        List<List<String>> list = new ArrayList<List<String>>();
        List<String> head0 = new ArrayList<String>();
        head0.add("字符串" + System.currentTimeMillis());
        List<String> head1 = new ArrayList<String>();
        head1.add("数字" + System.currentTimeMillis());
        List<String> head2 = new ArrayList<String>();
        head2.add("日期" + System.currentTimeMillis());
        list.add(head0);
        list.add(head1);
        list.add(head2);
        return list;
    }

### web数据写出 ###

**代码**

@GetMapping("download")
    public void download(HttpServletResponse response) throws IOException { 
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("数据写出", "UTF-8");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
        EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());
    }