Java中EasyExcel使用自定义Converter处理方法详解_Java

需求背景

类型处理报错

系统使用easyexcel作为导入导出，有些类型操作会报转换异常:

com.alibaba.excel.exception.excelwritedataconvertexception: can not find 'converter' support class xxx.

这个问题的原因是因为找不到指定的converter去处理当前类型，默认的各种converter去com.alibaba.excel.converters包下查看，或者直接查看converter的各个实现类。作者主要是需要实现localdate的导出，其他类型同理。

枚举字段转换

还有一个场景是，如果这个字段的值本身是固定的枚举code，但是导出时要导出成文字。也可以使用。

其他说明

作者当前使用的easyexcel的版本为3.0.5。某些版本内置类名称不太一致，api有些调整，不过都大同小异。

查看官方文档时发现其对自定义converter的描述不太完整，特此记录

代码编写

重写converter

首先要重写converter来完成数据的数据准换

public class specclassconverter implements converter<specclass> {}
// 以下为实现方法
class<?> supportjavatypekey();
// 支持数据转换的java类型， 例如: return localdate.class/integer.class/boolean.class/customclass.class;
celldatatypeenum supportexceltypekey();
// 支持数据转换的单元格类型, 例如: return celldatatypeenum.string;
t converttojavadata(readcelldata<?> celldata, excelcontentproperty contentproperty,globalconfiguration globalconfiguration);
// 将单元格内容转换成java对象;导入时使用 例如: return localdate.parse(celldata.getstringvalue(), datetimeformatter.ofpattern("yyyy-mm-dd"));/return celldata.getstringvalue().equals("是") ? 1 : 0; 注意自己处理空指针/空数据问题
t converttojavadata(readconvertercontext<?> context);
//  return converttojavadata(context.getreadcelldata(), context.getcontentproperty(),context.getanalysiscontext().currentreadholder().globalconfiguration());
// 估计是旧版本api，默认实现调用上面方法，所以只重写上面方法就可以了 
writecelldata<?> converttoexceldata(t value, excelcontentproperty contentproperty,globalconfiguration globalconfiguration);
// 将java对象导出为指定单元格内容 例如: return new writecelldata<>((localdate)value.format(dateutil.formatter1));/return new writecelldata<>((integer)value == 1 ? "是" : "否"); 更多单元格样式设置请参照官方文档
writecelldata<?> converttoexceldata(writeconvertercontext<t> context);
//  return converttoexceldata(context.getvalue(), context.getcontentproperty(),context.getwritecontext().currentwriteholder().globalconfiguration());
// 估计是旧版本api，默认实现调用上面方法，所以只重写上面方法就可以了

使用converter

上述代码只是创建了一个自定义的converter，如果要使用这个converter需要指定使用，有两种使用方法:

加在指定字段上，指定该字段使用该converter，注意类型不要搞错,如果该实体内有该类型字段需要指定多次

    @jsonformat(pattern = "yyyy-mm-dd")
	@excelproperty(value = "开始时间",converter = specclassconverter .class)
	private localdate starttime;
	
    @jsonformat(pattern = "yyyy-mm-dd")
	@excelproperty(value = "结束时间",converter = specclassconverter .class)
	private localdate endtime;

也可以在写入excel时将该converter注册到excelwriterbuilder中，该实体内所有支持类型都会被specconverter转换。

easyexcel.write(out, specclass.class).registerconverter(new specclassconverter());
// 只是简单的完成数据转换，如果需要记录日志等功能，可以将converter托管给spring成为一个bean再引入使用，converter作为默认bean时注意单例的多线程问题

注意：如果字段上指定了converter，excelwriterbuilder中也注册了converter且类型支持，字段上的converter优先级最高，excelwriterbuilder中的converter在该字段不执行

进阶使用

在数据转换时可以对单元格格式做操作，比如设置不同的单元格颜色、设置不同的字体、设置不同的字号

对于旧实体的处理 (例如: 数字脱敏)

实体类内字段指定使用converter

// 代码很简单，重写converter的时候指定处理规则，然后将要脱敏的字段指定使用该converter
@override
    public writecelldata<string> converttoexceldata(string value, excelcontentproperty contentproperty,
                                               globalconfiguration globalconfiguration) throws ioexception {
                string s = value.replaceall("[0123456789]", "*");
        writecelldata<string> res = new writecelldata<>(s);
        return res;
    }

旧有实体类改造，实体类太多，原字段没有指定converter，固定了要处理的字段名或者指定了 @excelproperty 内的value

// 代码思路是在类上注册这个转换器，因为我们有个系统是提数系统，所有的导出最后统一由一个excelwriterbuilder处理，所以这个方式很省力
@override
    public writecelldata<string> converttoexceldata(string value, excelcontentproperty contentproperty,
                                               globalconfiguration globalconfiguration) throws ioexception {
        writecelldata<string> res;
        field field = contentproperty.getfield();
        // 固定字段值 为了判断当前字段是否处理，获取当前字段的名称,进行判断
      	if(field.getname().equals("handler")){
            string s = value.replaceall("[0123456789]", "*");
            res = new writecelldata<>(s);
        }else{
            res = new writecelldata<>(value);
        }
		// 字段值不固定，指定了 @excelproperty 注解中的value，固定导出列头，利用反射拿到注解
		excelproperty annotation = contentproperty.getfield().getannotation(excelproperty.class);
        string resvalue = value;
        if (annotation != null) {
            string[] value1 = annotation.value();
            string name = value1[value1.length-1];
            if(name.contains("handler")){
                resvalue = value.replaceall("[0123456789]", "*");
            }
        }
        writecelldata<string> res = new writecelldata<>(resvalue);
		
        
        return res;
    }

旧有实体类改造，没使用 @excelproperty 注解，header是list<list<string>>格式，不确定字段名称，只确定导出header

思路是获取到设置的head列表，根据当前列的索引值获取当前header，判断是否处理，在converter中无法获取当前columnindex,所以放到了cellwritehandler中。

// 查看registerwritehandler方法，发现这个writehandler 的调用更像是一个链路，所以不用担心覆盖，可以注册多个customwritehandler 
   public t registerwritehandler(writehandler writehandler) {
        if (parameter().getcustomwritehandlerlist() == null) {
            parameter().setcustomwritehandlerlist(new arraylist<writehandler>());
        }
        parameter().getcustomwritehandlerlist().add(writehandler);
        return self();
    }


public class customwriterhandler implements cellwritehandler {
// 重写aftercelldataconverted方法，在数据转换处理后对单元格做操作
    @override
    public void aftercelldataconverted(writesheetholder writesheetholder, writetableholder writetableholder,writecelldata<?> celldata, cell cell, head head, integer relativerowindex, boolean ishead) {
    
        if(!ishead){
            int columnindex = cell.getcolumnindex();
            list<string> strings = writesheetholder.gethead().get(columnindex);
            string s = strings.get(strings.size() - 1);
            if(s.equals("handler")){
                    string stringvalue = celldata.getstringvalue();
                    string res = stringvalue.replaceall("[0123456789]", "*");
                    celldata.setstringvalue(res);
            }
            
            // 下面这种写法如果碰到自定义head会空指针，而且这种对数据的处理可以的话尽量放到converter更好
            
            // if(head.getfieldname().equals("handler")){
            //     string stringvalue = celldata.getstringvalue();
            //     string s = stringvalue.replaceall("[0123456789]", "*");
            //     celldata.setstringvalue(s);
            // }
        }
    }
}