创建Excel：基于POI+注解实现

目标

其实网上已经有很多excel相关的导出了，但大多数都是不够灵活的，代码也不一定适用于自己的业务，所以我想写一份通用的excel，你只需要引入，剩下的交给注解和配置即可。

所以我要实现以下几个目标：

• 灵活性，表头可配置化，增删表头只需调整模版
• 扩展性，可增对不同数据类型做不同处理
• 复用性，支持所有已存在的数据结构体
• 无入侵性，无需改动已有业务代码

思路

一个数据结构体，对应Excel一行数据，有了数据结构体，用反射填充数据即可
Excel的表头位置与属性字段需要配置，由程序员在注解上配置，当然，最好放在配置中心，你只需要copy代码改动就行。

所以，Excel生成只需要对应一个注解即可。
我这边用注解是 @ExcelFile

结构体生成Excel效果图

只需引入注解标记结构体即可实现

annotation

注释都在代码里，文件全名可以根据业务改

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author ximu
 * @date 2021/8/29
 * @description 标记类为一个Excel文件
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({
   
   ElementType.TYPE})
public @interface ExcelFile {
   
   

    /**
     * 文件全名
     */
    String fileName() default "excel.xlsx";

    /**
     * excel使用的属性排列格式模板 格式: 字段名1{fileTemplateSplit}字段名2{fileTemplateSplit}字段名3
     * <p>
     * 示例:id|name
     * <p>
     * 说明表头index0=id，index1=name
     */
    String fileHeadTemplate() default "";

    /**
     * excel属性与表头映射模版 格式: 字段1{fileMappingSplit}映射名称1{fileTemplateSplit}字段1{fileMappingSplit}映射名称1
     * <p>
     * 示例:id=学号|name=学生姓名
     * <p>
     * 说明id属性映射表头为学号，name属性映射表头为学生姓名
     */
    String fileMappingTemplate() default "";

    /**
     * 模版字段分隔符，默认无需调整
     */
    String fileTemplateSplit() default "\\|";

    /**
     * 属性名称映射分隔符，默认无需调整
     */
    String fileMappingSplit() default "\\=";

}

Domain

结构体，根据实际的业务来吧，这里只是一个demo
fileHeadTemplate与fileMappingTemplate要配置正确，最好是放在配置中心

import com.apache.poi.annotation.ExcelFile;
import lombok.Data;

/**
 * @author ximu
 * @date 2021/8/29
 * @description 学生信息
 */
@ExcelFile(fileHeadTemplate = "id|name", fileMappingTemplate = "id=学号|name=学生姓名")
@Data
public class StudentDTO {
   
   

    /**
     * 学号
     */
    private Long id;

    /**
     * 学生姓名
     */
    private String name;

}

exception（非必需）

统一异常处理，如果你的项目有了异常管理，可以忽略，非必需

/**
 * @author ximu
 * @date 2021/8/29
 * @description
 */
@Data
public class PoiException extends RuntimeException {
   
   

    private int errCode;

    private String msg;

    public PoiException(String msg) {
   
   
        this.errCode = 500;
        this.msg = msg;
    }
}

util

生成Excel的全局方法，其中AssertUtil相关的不是必须，可以排除
e.printStackTrace(); 可用log.err替换
FileOutputStream也可以根据实际情况替换

import com.apache.poi.annotation.ExcelFile;
import org.apache.poi.ss.usermodel