EasyExcel 实现设置水印（只支持07版Excel文档）

左手的ㄟ右手 2023-09-29 11:37 13阅读 0赞

**目录**

1 Maven依赖

2 WaterMarkModel

3 CustomWaterMarkHandler

4 调试代码

5 调试结果

注：

--------------------

## 1 Maven依赖 ##

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>2.2.8</version>
            </dependency>
            
            <dependency>
                <groupId>cn.afterturn</groupId>
                <artifactId>easypoi-base</artifactId>
                <version>4.4.0</version>
            </dependency>
            <dependency>
                <groupId>org.apache.poi</groupId>
                <artifactId>ooxml-schemas</artifactId>
                <version>1.4</version>
            </dependency>

## 2 WaterMarkModel ##

水印信息类。

package com.xudongbase.easyexcel.model;
    
    import com.xudongbase.easyexcel.model.common.SheetModel;
    import lombok.Getter;
    
    /**
     * 水印信息类
     *
     * @author xudongmaster
     */
    @Getter
    public class WaterMarkModel extends SheetModel {
        /**
         * 水印数据
         */
        private byte[] waterMarkBytes;
    
        private WaterMarkModel() {
        }
    
        /**
         * 生成水印信息
         *
         * @param sheetName      sheet页名称
         * @param waterMarkBytes 水印数据
         * @return
         */
        public static WaterMarkModel createWaterMarkModel(String sheetName, byte[] waterMarkBytes) {
            WaterMarkModel waterMarkModel = new WaterMarkModel();
            //sheet页名称
            waterMarkModel.sheetName = sheetName;
            //水印数据
            waterMarkModel.waterMarkBytes = waterMarkBytes;
            return waterMarkModel;
        }
    }

## 3 CustomWaterMarkHandler ##

自定义水印处理器。

package com.xudongbase.easyexcel.handler;
    
    import cn.hutool.core.collection.CollUtil;
    import cn.hutool.core.util.StrUtil;
    import com.alibaba.excel.write.handler.SheetWriteHandler;
    import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
    import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
    import com.xudongbase.common.poi.util.POIExcelUtil;
    import com.xudongbase.easyexcel.model.WaterMarkModel;
    import org.apache.poi.xssf.usermodel.XSSFSheet;
    
    import java.util.ArrayList;
    import java.util.List;
    import java.util.stream.Collectors;
    
    /**
     * 自定义水印处理器
     *
     * @author xudongmaster
     */
    public class CustomWaterMarkHandler implements SheetWriteHandler {
    
        /**
         * sheet页名称列表
         */
        private List<String> sheetNameList;
        /**
         * 水印信息
         */
        private List<WaterMarkModel> waterMarkList = new ArrayList<>();
    
    
        public CustomWaterMarkHandler(List<WaterMarkModel> waterMarkList) {
            if (CollUtil.isEmpty(waterMarkList)) {
                return;
            }
            this.waterMarkList = waterMarkList.stream().filter(x ->
                    StrUtil.isNotBlank(x.getSheetName()) && x.getWaterMarkBytes() != null && x.getWaterMarkBytes().length > 0)
                    .collect(Collectors.toList());
            sheetNameList = this.waterMarkList.stream().map(x -> x.getSheetName()).distinct().collect(Collectors.toList());
        }
    
        @Override
        public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
    
        }
    
        /**
         * sheet页创建之后调用
         *
         * @param writeWorkbookHolder
         * @param writeSheetHolder
         */
        @Override
        public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
            XSSFSheet sheet = (XSSFSheet) writeSheetHolder.getSheet();
            //不需要添加水印，或者当前sheet页不需要添加水印
            if (CollUtil.isEmpty(waterMarkList) || sheetNameList.contains(sheet.getSheetName()) == false) {
                return;
            }
            //获取当前sheet的水印
            List<WaterMarkModel> sheetWaterMarkList = waterMarkList.stream().filter(x ->
                    StrUtil.equals(x.getSheetName(), sheet.getSheetName())
            ).collect(Collectors.toList());
            //当前sheet页不需要水印
            if (CollUtil.isEmpty(sheetWaterMarkList)) {
                return;
            }
            for (WaterMarkModel waterMarkModel : sheetWaterMarkList) {
                //水印数据
                byte[] waterMarkBytes = waterMarkModel.getWaterMarkBytes();
                //插入水印
                POIExcelUtil.insertWaterRemark(sheet, waterMarkBytes);
            }
            //删除冻结行列信息
            waterMarkList.removeAll(sheetWaterMarkList);
            sheetNameList = waterMarkList.stream().map(x -> x.getSheetName()).distinct().collect(Collectors.toList());
        }
    }

## 4 调试代码 ##

/**
         * 测试添加水印
         */
        @Test
        public void testWaterMark() {
            try {
                File file = new File("D:/easyexcel/testWaterMark.xlsx");
                FileUtil.createNewFile(file);
                //生成表格数据
                List<List<Object>> dataList = new ArrayList<>();
                dataList.add(new ArrayList<>(Arrays.asList(new Object[]{"表头11", "表头2", "表头3", "表头4"})));
                dataList.add(new ArrayList<>(Arrays.asList(new Object[]{"表头1", "表头2", "表头3", "表头4"})));
                dataList.add(new ArrayList<>(Arrays.asList(new Object[]{"表头31", "表头2", "表头3", "表头4"})));
                //导出文件
                String sheetName = "模板";
                List<WaterMarkModel> waterMarkList = new ArrayList<>();
                //水印数据
                byte[] waterMarkBytes = POICommonUtil.createWaterMark("旭东怪YYDS", 200, 150, new Color(255, 0, 0, 100)
                        , new Font("微软雅黑", Font.BOLD, 20));
                waterMarkList.add(WaterMarkModel.createWaterMarkModel(sheetName, waterMarkBytes));
                FileOutputStream fileOutputStream = new FileOutputStream(file);
                ExcelWriter excelWriter = EasyExcel.write(fileOutputStream)
                        .inMemory(Boolean.TRUE).registerWriteHandler(new CustomWaterMarkHandler(waterMarkList)).build();
                WriteSheet writeSheet = EasyExcel.writerSheet(sheetName).build();
                excelWriter.write(dataList, writeSheet);
                //千万别忘记finish 会帮忙关闭流
                excelWriter.finish();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

## 5 调试结果 ##

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16][]

## 注： ##

1、 注册自定义处理器之前必须调用inMemory(Boolean.TRUE)方法。

2、觉得这篇博客写的不错的可以前往Gitee点个Star，源码请查看Gitee的xudongbase项目easyexcel分支。

[xudongbase: 主要是项目中可以用到的共通方法，现有easyexcel分支在持续更新中。欢迎大家Star和提交Issues。easyexcel分支：批量设置样式，批量添加批注，批量合并单元格，设置冻结行和列，设置行高列宽，隐藏行和列，绑定下拉框数据，设置水印 - Gitee.com][xudongbase_ _easyexcel_Star_Issues_easyexcel_ - Gitee.com]

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/7a8f218690814a93bb99f491ecdd37ff.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5pet5Lic5oCq,size_20,color_FFFFFF,t_70,g_se,x_16
[xudongbase_ _easyexcel_Star_Issues_easyexcel_ - Gitee.com]: https://gitee.com/xudong_master/xudongbase/tree/easyexcel/