EasyExcel设置单元格样式及批注&隐藏行

工作中由于有用到excel导出的功能,在设置单元格样式的时候呢也是网上各种找资料,既然问题已经解决了呢! 自然要做一个记录,便于日后翻阅。也供各位同学做参考啦!

首先我们添加easyExcel依赖,我们这里选用的版本是2.1.6

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

废话不多说,直接上代码吧

package com.xchaset.excelexample.excel.service;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.xchaset.excelexample.excel.model.SimpleCustomerModel;

import java.util.List;

public class ExcelWriteService {

    public static void main(String[] args) {
        new ExcelWriteService().writeExcel();
    }

    public void writeExcel(){

        // 读取的excel路径,此处主要是为获取数据源。
        String readPathName = "C:\\Users\\customer.XLS";
        List rows = new ExcelReadService().readExcel(readPathName);

        // 写入的文件路径
        String writePathName = "C:\\Users\\write.xlsx";

        ExcelWriterBuilder writerBuilder = EasyExcel.write(writePathName, SimpleCustomerModel.class);
        writerBuilder.excelType(ExcelTypeEnum.XLSX);
        // 注册写入处理器
        writerBuilder.registerWriteHandler(new CellCommentWriteHandler());
        writerBuilder.registerWriteHandler(new CellStyleWriteHandler());


        ExcelWriter writer = writerBuilder.build();
        WriteSheet writeSheet = new WriteSheet();
        writeSheet.setSheetName("客户信息");
        writer.write(rows, writeSheet);

        //可以写入多个sheet页
        WriteSheet writeSheet2 = new WriteSheet();
        writeSheet2.setSheetName("客户信息2");
        writer.write(rows,writeSheet2);
        
        // finish才会写入到文件中
        writer.finish();

    }

/**
     * 多个sheet页写入
     * @param filePath 写出文件路径
     * @param dataMap sheetName:数据集  的Map 集合
     * @param writeHandlers 写入处理器
     */
    public static void writeToExcel(String filePath, Map<String, List> dataMap, List<WriteHandler> writeHandlers){
        if (!FileUtil.exist(filePath)) {
            FileUtil.mkParentDirs(filePath);
        }
        ExcelWriterBuilder writerBuilder = EasyExcel.write(filePath);
        writerBuilder.excelType(ExcelTypeEnum.XLSX);
        for (WriteHandler writeHandler : writeHandlers) {
            writerBuilder.registerWriteHandler(writeHandler);
        }
        ExcelWriter writer = writerBuilder.build();

        for(Map.Entry<String,List> entry :dataMap.entrySet()){
            String sheetName = entry.getKey();
            List rows = entry.getValue();
            WriteSheet writeSheet = new WriteSheet();
            writeSheet.setNeedHead(true);
            writeSheet.setClazz(rows.get(0).getClass());
            writeSheet.setSheetName(sheetName);
            writer.write(rows,writeSheet);
        }
        writer.finish();
    }

上面代码有提到我们的注册写入处理器

package com.xchaset.excelexample.excel.service;

import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.write.style.AbstractCellStyleStrategy;
import org.apache.poi.ss.usermodel.*;

/**
 * 单元格样式写入处理器
 */
public class CellStyleWriteHandler extends AbstractCellStyleStrategy {
    @Override
    protected void initCellStyle(Workbook workbook) {
    }

    @Override
    protected void setHeadCellStyle(Cell cell, Head head, Integer relativeRowIndex) {
        Workbook workbook = cell.getSheet().getWorkbook();
        CellStyle cellStyle = workbook.createCellStyle();
        cellStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
        cellStyle.setFillForegroundColor(IndexedColors.CORAL.getIndex());
        cell.setCellStyle(cellStyle);
    }


    @Override
    protected void setContentCellStyle(Cell cell, Head head, Integer relativeRowIndex) {
        Workbook workbook = cell.getSheet().getWorkbook();
        CellStyle cellStyle = workbook.createCellStyle();
        cellStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
        cellStyle.setFillForegroundColor(IndexedColors.LIGHT_BLUE.getIndex());
        if ("*".equals(cell.getStringCellValue())) {
            //隐藏行
            cell.getRow().setZeroHeight(true);
        }
        cell.setCellStyle(cellStyle);

    }
}

注意上面的代码CellStyleWriteHandler类是继承自AbstractCellStyleStrategy 类,而不是直接实现CellWriteHandler。通过实现AbstractCellStyleStrategy 的setHeadCellStyle可以对头部的样式进行设置,实现setContentCellStyle方法可以对内容进行样式设置。我这里只是简单对单元格的颜色做了设置。

另外还有一点需要注意的就是由于AbstractCellStyleStrategy 实现了NotRepeatExecutor接口,这个接口只有一个方法uniqueValue(),就是返回一个唯一的值,AbstractCellStyleStrategy 本身已经实现了这个方法。
所以如果同时有多个类实现了AbstractCellStyleStrategy ,而没有重写uniqueValue()方法,那只会有其中一个会生效。

我们可以设置多个单元格的处理器。针对需要设置单元格批注的,我们添加了一个CellCommentWriteHandler。这次我们直接实现CellWriteHandler接口。

package com.xchaset.excelexample.excel.service;

import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.write.handler.CellWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
import com.xchaset.excelexample.excel.constant.CellCommentEnum;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;

import java.util.List;

/**
 * 批注写入处理器
 */
public class CellCommentWriteHandler implements CellWriteHandler {

    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {

    }

    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        addCellComment(cell);

    }

    /**
     * 添加批注信息
     * @param cell
     */
    private void addCellComment(Cell cell) {
        for (CellCommentEnum commentEnum : CellCommentEnum.values()) {
            int rowIndex = commentEnum.getRowIndex();
            int columnIndex = commentEnum.getColumnIndex();
            if (rowIndex == cell.getRowIndex() && columnIndex == cell.getColumnIndex()){
                Drawing<?> drawing = cell.getSheet().createDrawingPatriarch();
                Comment cellComment = drawing.createCellComment(new XSSFClientAnchor(0, 0, 0, 0, columnIndex, 1, columnIndex + 2, 6));
                cellComment.setString(new XSSFRichTextString(commentEnum.getCellCommentStr()));
                cell.setCellComment(cellComment);
            }
        }
    }
}

针对需要添加批注的单元格。新建了一个枚举类,这样我们可以把头部的一些需要添加批注的信息维护在枚举类中。

package com.xchaset.excelexample.excel.constant;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public enum CellCommentEnum {

    CUSTOMER_CODE_COMMENT(1,0,"客户代码"),
    CUSTOMER_NAME_COMMENT(1,1,"客户名称"),
    ADDRESS_COMMENT(1,5,"工作单位地址"),
    LIVING_ADDRESS_COMMENT(1,16,"住宅地址");


    private int rowIndex;

    private int columnIndex;

    private String cellCommentStr;

}

下面是model类,我们写入excel的头部信息可以通过注解进行设置。在之前的easyExcel中是需要继承com.alibaba.excel.metadata.BaseRowModel的,不过这个类已经废弃了。所以新版本的话就不在需要了。

package com.xchaset.excelexample.excel.model;

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class SimpleCustomerModel {

    @ExcelProperty(value = {"客户信息","客户代码"})
    private String customerCode;

    @ExcelProperty(value = {"客户信息","客户名称"})
    private String name;

    @ExcelProperty(value = {"客户信息","性别"})
    private String gender;

    @ExcelProperty(value = {"出生信息","年龄"})
    private String age;

    @ExcelProperty(value = {"出生信息","出生日期"})
    private String birthday;

    @ExcelProperty(value = {"地址信息","客户地址"})
    private String address;

    @ExcelProperty(value = {"联系方式","电话"})
    private String tel;

    @ExcelProperty(value = {"联系方式","移动电话"})
    private String mobile;

    @ExcelProperty(value = {"联系方式","邮编"})
    private String postcode;

    @ExcelProperty(value = {"联系方式","邮箱"})
    private String email;

    @ExcelProperty(value = {"工作信息","职业"})
    private String occupation;

    @ExcelProperty(value = {"工作信息","职务"})
    private String job;

    @ExcelProperty(value = {"地址信息","省区代码"})
    private String provinceCode;

    @ExcelProperty(value = {"地址信息","省区名称"})
    private String provinceName;

    @ExcelProperty(value = {"地址信息","市县代码"})
    private String cityCode;

    @ExcelProperty(value = {"地址信息","市县名称"})
    private String cityName;

    @ExcelProperty(value = {"地址信息","住宅区"})
    private String livingAddress;
}

就是这样了。具体的例子可以参考github上的源码。https://github.com/xchaset/example

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容

  • 转自链接 目录 1.认识NPOI 2.使用NPOI生成xls文件 2.1创建基本内容 2.1.1创建Workboo...
    腿毛裤阅读 10,529评论 1 3
  • 转自链接 2.3.5 IF函数 2.3.6 CountIf和SumIf函数 2.3.7 Lookup函数 2.3....
    腿毛裤阅读 12,870评论 0 0
  • 使用首先需要了解他的工作原理 1.POI结构与常用类 (1)创建Workbook和Sheet (2)创建单元格 (...
    长城ol阅读 8,417评论 2 25
  • 1.UITableView 在iOS中,要实现表格数据展示,最常用的做法就是使用UITableViewUITabl...
    solozyx阅读 372评论 0 0
  • 老师在课上开玩笑:“如果不是生活所迫,谁又愿意才华横溢呢?”,学生都哄堂大笑。 换言之,正是为了生活,我们不得不变...
    迈城阅读 489评论 0 1