最近学习在JAVA中读写Excel 。也学习了自定义注解的使用。
在若依框架中，如何导入导出数据呢？我们使用任意一个表格，自定义生成代码。可知。
- 生成的对象会添加自定义的
@Excel注解； - Controller包含导出方法；导出方法引用了自定义的工具类
ExcelUtils。
public class Student extends BaseEntity
{// ……/** 学生名称 */@Excel(name = "学生名称")private String studentName;// ……
}
@Controller
@RequestMapping("/base/student")
public class StudentController extends BaseController
{/*** 导出学生信息列表*/@RequiresPermissions("base:student:export")@Log(title = "学生信息", businessType = BusinessType.EXPORT)@PostMapping("/export")@ResponseBodypublic AjaxResult export(Student student){List<Student> list = studentService.selectStudentList(student);ExcelUtil<Student> util = new ExcelUtil<Student>(Student.class);return util.exportExcel(list, "学生信息数据");}
}
导出的Excel表格，每一列的名称与注解@Excel的name属性对应。
原理简析
若依框架中如何实现Excel导入、导出呢？
- 新建自定义注解
@Excel和@Excels,需要Excel导入或导出的对象，添加@Excel注解。 - 使用 Apache POI，创建Excel工具类
ExcelUtils，在工具类的方法中必要时读取@Excel属性，并读、写、填充，生成Excel表。 - 需要导入导出Excel时（通常接口方法），引用工具类。
可以看到主配置文件和依赖框架common中都引用了POI。
<!-- excel工具 -->
<dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>${poi.version}</version>
</dependency>
common框架集，com.ruoyi.commom.annotation，包含了Excel的注解。
查看自定义注解源码Excel.java。这里包含了导出到Excel的名字、排序、格式、单元格、字体样式、字段类型（导出导入、仅导出、仅导入）等各种属性。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Excel
{/*** 导出时在excel中排序*/public int sort() default Integer.MAX_VALUE;/*** 导出到Excel中的名字.*/public String name() default "";/*** 日期格式, 如: yyyy-MM-dd*/public String dateFormat() default "";/*** 如果是字典类型，请设置字典的type值 (如: sys_user_sex)*/public String dictType() default "";/*** 读取内容转表达式 (如: 0=男,1=女,2=未知)*/public String readConverterExp() default "";/*** 分隔符，读取字符串组内容*/public String separator() default ",";/*** BigDecimal 精度 默认:-1(默认不开启BigDecimal格式化)*/public int scale() default -1;/*** BigDecimal 舍入规则 默认:BigDecimal.ROUND_HALF_EVEN*/public int roundingMode() default BigDecimal.ROUND_HALF_EVEN;/*** 导出时在excel中每个列的高度*/public double height() default 14;/*** 导出时在excel中每个列的宽度*/public double width() default 16;/*** 文字后缀,如% 90 变成90%*/public String suffix() default "";/*** 当值为空时,字段的默认值*/public String defaultValue() default "";/*** 提示信息*/public String prompt() default "";/*** 设置只能选择不能输入的列内容.*/public String[] combo() default {};/*** 是否从字典读数据到combo,默认不读取,如读取需要设置dictType注解.*/public boolean comboReadDict() default false;/*** 是否需要纵向合并单元格,应对需求:含有list集合单元格)*/public boolean needMerge() default false;/*** 是否导出数据,应对需求:有时我们需要导出一份模板,这是标题需要但内容需要用户手工填写.*/public boolean isExport() default true;/*** 另一个类中的属性名称,支持多级获取,以小数点隔开*/public String targetAttr() default "";/*** 是否自动统计数据,在最后追加一行统计数据总和*/public boolean isStatistics() default false;/*** 导出类型（0数字 1字符串 2图片）*/public ColumnType cellType() default ColumnType.STRING;/*** 导出列头背景颜色*/public IndexedColors headerBackgroundColor() default IndexedColors.GREY_50_PERCENT;/*** 导出列头字体颜色*/public IndexedColors headerColor() default IndexedColors.WHITE;/*** 导出单元格背景颜色*/public IndexedColors backgroundColor() default IndexedColors.WHITE;/*** 导出单元格字体颜色*/public IndexedColors color() default IndexedColors.BLACK;/*** 导出字段对齐方式*/public HorizontalAlignment align() default HorizontalAlignment.CENTER;/*** 自定义数据处理器*/public Class<?> handler() default ExcelHandlerAdapter.class;/*** 自定义数据处理器参数*/public String[] args() default {};/*** 字段类型（0：导出导入；1：仅导出；2：仅导入）*/Type type() default Type.ALL;public enum Type{ALL(0), EXPORT(1), IMPORT(2);private final int value;Type(int value){this.value = value;}public int value(){return this.value;}}public enum ColumnType{NUMERIC(0), STRING(1), IMAGE(2), TEXT(3);private final int value;ColumnType(int value){this.value = value;}public int value(){return this.value;}}
}
common框架集，com.ruoyi.commom.utils.poi,包含Excel的工具类ExcelUtils和Excel数据格式处理适配器ExcelHandlerAdapter。
我们之前学过注解的使用。
@Test
public void testAnnotation() {try {Method method = MyAnnotationTest.class.getMethod("exampleMethod");if(method.isAnnotationPresent(MyAnnotation.class)){MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);System.out.println(annotation.value());System.out.println(annotation.number());System.out.println(annotation.isTrue());}} catch (NoSuchMethodException e) {throw new RuntimeException(e);}
}
我们可以根据getAnnotation获取到注解的值。然后根据得到的注解值。比如当前字段，private String studentName的@Excel属性name的取值为学生名称。然后用”学生名称“作为下一步导出的方法。
发现方法 getFields获取字段注解, writeSheet 创建写入数据到sheet,annotationDataStyles根据Excel注解创建表格列样式。这些方法，导入方法（inport）和导出方法export会间接引用。
