Java高级特性-注解:注解实现Excel导出功能

开发 后端
注解是 Java 的一个高级特性,Spring 更是以注解为基础,发展出一套“注解驱动编程”。

[[355260]]

 注解是 Java 的一个高级特性,Spring 更是以注解为基础,发展出一套“注解驱动编程”。

这听起来高大上,但毕竟是框架的事,我们也能用好注解吗?

的确,我们很少有机会自己写注解,导致我们搞不清楚注解是怎么回事,更别提用好注解了。

既然这样,我们就从具体的工作出发,开发一个 Excel 导出功能。我相信,你在搞懂这个例子后,就能明白注解是怎么个用法。

Excel 导出-需求拆解

在后台管理系统中,常常需要把数据导出 Excel 表。

比如,在双十一过后,销售部要把商品订单录入到 Excel 表,财务部要把支付订单录入到 Excel 表,然后各部门汇总分析,最后找个时间讨论怎么改善公司的服务。

你想呀,双十一的订单成千上万,靠人工录入,少说也要花三四天,而且还特别容易出错。所以,你必须开发 Excel 导出功能。

那么,具体怎么做呢?

上次我们提到,注解想发挥作用,有三个要素:定义、使用、读取。这次,我们就利用注解的三个特性,来实现 Excel 导出功能,设计过程是这样的。

第一步,我们要创建不同的 Excel 模型。双十一过后,销售部要订单数据,财务部要支付数据,两个部门要的 Excel 表肯定也不一样,这就得帮每个部门创建不同的 Excel 模型,他们拿到想要的数据。

第二步,我们要根据 Excel 模型,来导出 Excel 表。

看到这,你应该明白 Excel 导出的设计过程了。接下来,我们就来一步步实现这个功能。

创建 Excel 模型

创建 Excel 模型,涉及到注解三要素中的定义、使用。

首先,定义 Excel 注解,我们直接看关键代码。 

  1. @Target({ElementType.FIELD})  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. public @interface ExcelField {  
  4.     /**  
  5.      * 导出字段标题  
  6.      */  
  7.     String title();     
  8.     /**  
  9.      * 导出字段排序(升序)  
  10.      */  
  11.     int sort() default 0;     
  12.     /**  
  13.      * 对齐方式(0:自动;1:靠左;2:居中;3:靠右)  
  14.      */  
  15.     int align() default 0;     

这里用到了两个元注解@Retention和@Target。@Target代表这个注解只能放在成员变量上;@Retention代表这个注解要加载到 JVM 内存,我们可以用反射来读取注解。

此外,注解还有 3 个成员变量,分别对应:Excel 的字段标题、字段排序、对齐方式,方便大家微调表格。到了这,定义 Excel 注解就完成了。

接下来,使用注解,我们还是直接看代码。 

  1. public class OrderModel {  
  2.     @ExcelField(title = "订单号"align = 2sort = 20 
  3.     private String orderNo;  
  4.     @ExcelField(title = "金额"align = 2sort = 20
  5.     private String amount;   
  6.      // 创建时间  
  7.     private Date createTime;    
  8.      // 省略 getter/setter 方法  

订单模型有 3 个字段:订单号、金额、创建时间,但这里注解只加到订单号、金额上,表示这两个字段会导出 Excel 表,而创建时间会忽略,你可以看看这副图片。

至此,我们完成了定义注解、使用注解,得到了一个 Excel 模型。但要想实现导出功能,还必须根据这个模型,生成出 Excel 表。

读取 Excel 模型

读取 Excel 模型,涉及到注解三要素中的读取。 我们需要读取注解,生成 Excel 表,这主要分成 3 个步骤:初始化 Excel 表对象—>写入数据到 Excel 表对象—>输出文件。

第一步,初始化 Excel 表对象。在这一步中,我们要根据 Excel 模型,生成一个 Excel 表对象,要创建这几个东西:标题、表头、样式等等。我们来看代码。 

  1. public class ExcelExporter {  
  2.     // ...省略无数代码  
  3.     /***************************** 初始化 Excel 表对象 ****************************/  
  4.     /**  
  5.      * 构造函数  
  6.      * @param title 表格标题,传“空值”,表示无标题  
  7.      * @param cls   excel模型对象  
  8.      */  
  9.     public ExcelExporter(String title, Class<?> cls) {  
  10.         // 获取注解list  
  11.         Field[] fs = cls.getDeclaredFields();  
  12.         for (Field f : fs) {  
  13.             ExcelField ef = f.getAnnotation(ExcelField.class); 
  14.             if (ef != null) {  
  15.                 annotationList.add(new Object[]{ef, f});  
  16.             }  
  17.         }  
  18.         annotationList.sort(comparing(o -> ((ExcelField) o[0]).sort()));  
  19.         // 通过注解获取表头  
  20.         List<String> headerList = new ArrayList<>();  
  21.         for (Object[] os : annotationList) {  
  22.             String t = ((ExcelField) os[0]).title();  
  23.             headerList.add(t);  
  24.         }  
  25.         // 初始化excel表:创建excel表、添加表标题、创建表头等等  
  26.         initialize(title, headerList);  
  27.     }  

在初始化的时候,我们先从 Excel 模型对象中读取注解,获得一个注解列表;然后,再从注解列表中,读取 title-字段标题;最后,再初始化 Excel 表对象,包括:创建 Excel 表对象、添加表标题、创建表头、添加样式。

第二步,写入数据到 Excel 表对象。在这一步中,我们要把 Java 的列表数据写到 Excel 表对象里,让这些数据能变成 Excel 表的一行行信息。还是来看代码。 

  1. public class ExcelExporter {  
  2.     /***************************** 初始化 Excel 表对象 ****************************/  
  3.     // ...省略无数代码  
  4.     /***************************** 写入数据到 Excel 表对象 ****************************/  
  5.     /**  
  6.      * 写入数据  
  7.      * @return list 数据列表  
  8.      */  
  9.     public <E> ExcelExporter setDataList(List<E> list) {  
  10.         for (E dataObj : list) {  
  11.             // 添加行  
  12.             Row row = this.addRow();  
  13.             // 获取数据,并写入单元格  
  14.             int cellNo = 0 
  15.             for (Object[] os : annotationList) {  
  16.                 // 获取成员变量的值  
  17.                 Object value = null 
  18.                 try {  
  19.                     value = Reflections.invokeGetter(dataObj, ((Field) os[1]).getName());  
  20.                 } catch (Exception ex) {  
  21.                     log.info(ex.toString());  
  22.                     value = "" 
  23.                 }  
  24.                 if (value == null) {  
  25.                     value = "" 
  26.                 }  
  27.                 // 写入单元格  
  28.                 ExcelField ef = (ExcelField) os[0];  
  29.                 this.addCell(row, cellNo++, value, ef.align());  
  30.             }  
  31.         }  
  32.         return this;  
  33.     }  

我们先传入一个数据列表 dataList,然后用循环来遍历 dataList,在这个循环中,我们不断把数据写进 Excel 表对象里,具体操作是:创建了一个空白行,利用注解获取成员变量里的值,最后写进 Excel 表的单元格里。

第三步,输出文件。在这一步中,就是 Excel 表对象变成一个文件,来看下最后的代码吧。 

  1. public class ExcelExporter {  
  2.     /***************************** 初始化 Excel 表对象 ****************************/  
  3.     // ...省略无数代码  
  4.     /***************************** 写入数据到 Excel 表对象 ****************************/  
  5.     // ...省略无数代码  
  6.     /***************************** 输出相关 ****************************/  
  7.     /**  
  8.      * 输出到文件  
  9.      * @param fileName 输出文件名,加上绝对路径  
  10.      */  
  11.     public ExcelExporter writeFile(String fileName) throws IOException {  
  12.         FileOutputStream os = new FileOutputStream(fileName);  
  13.         this.write(os);  
  14.         return this;  
  15.     }  

输出文件就没什么好说的了,就是指定文件名,然后把文件输出到指定的地方。

到了这,读取 Excel 模型就完成了。

当然,读取 Excel 模型涉及到注解的读取,这是最难理解的地方,因为读取注解要用到 Java 另一个高级特性—反射。而且,注解一般是用来简化业务,如果你对业务没有深刻的了解,是很难用好的。

限于篇幅,我只讲了最核心的代码,项目的完整代码放在文末的链接上,大家可以好好看看。

写在最后

注解想发挥作用,有三个要素:定义、使用、读取。这篇文章利用了注解的三要素,实现了 Excel 导出功能。

这分成两步。第一步,创建 Excel 模型,这涉及到注解三要素中的定义、使用;第二步,读取 Excel 模型,这涉及到注解三要素中的读取。

总之,注解一般用来简化业务,你要想用好注解,不但得熟练掌握 Java 的高级用法,还得对业务有深刻的理解。 

 

责任编辑:庞桂玉 来源: segmentfault
相关推荐

2021-12-30 12:30:01

Java注解编译器

2020-09-22 09:41:09

前端

2023-02-03 08:21:30

excelMySQL

2023-02-25 10:04:21

JavaExcel导出功能

2014-04-15 15:45:22

Java8Java8教程

2023-08-26 11:36:31

Java框架Spring

2014-04-15 09:53:54

Java8类型注解

2023-03-30 16:16:00

Java自定义注解开发

2024-04-28 08:20:52

Controller接口URL

2023-11-16 12:35:00

Java程序

2021-03-26 09:37:12

Java开发代码

2012-02-09 10:42:24

Java

2019-12-24 10:19:44

泛型反射注解

2023-02-07 09:17:19

Java注解原理

2021-03-01 07:55:41

Java annotation注解

2023-10-24 13:48:50

自定义注解举值验证

2014-12-24 10:24:55

Java

2011-07-19 09:38:41

一维数组Junit静态成员

2023-05-08 08:11:49

@Component使用场景时序图

2023-06-30 08:26:24

Java注解Java程序元素
点赞
收藏

51CTO技术栈公众号