注解是 Java 的一个高级个性,Spring 更是以注解为根底,倒退出一套“注解驱动编程”。
这听起来高大上,但毕竟是框架的事,咱们也能用好注解吗?
确实,咱们很少有机会本人写注解,导致咱们搞不清楚注解是怎么回事,更别提用好注解了。
既然这样,咱们就从具体的工作登程,开发一个 Excel 导出性能。我置信,你在搞懂这个例子后,就能明确注解是怎么个用法。
Excel 导出 - 需要拆解
在后盾管理系统中,经常须要把数据导出 Excel 表。
比方,在双十一过后,销售部要把商品订单录入到 Excel 表,财务部要把领取订单录入到 Excel 表,而后各部门汇总剖析,最初找个工夫探讨怎么改善公司的服务。
你想呀,双十一的订单成千上万,靠人工录入,少说也要花三四天,而且还特地容易出错。所以,你必须开发 Excel 导出性能。
那么,具体怎么做呢?
上次咱们提到,注解想发挥作用,有三个因素:定义、应用、读取。这次,咱们就利用注解的三个个性,来实现 Excel 导出性能,设计过程是这样的。
第一步,咱们要创立不同的 Excel 模型。双十一过后,销售部要订单数据,财务部要领取数据,两个部门要的 Excel 表必定也不一样,这就得帮每个部门创立不同的 Excel 模型,他们拿到想要的数据。
第二步,咱们要依据 Excel 模型,来导出 Excel 表。
看到这,你应该明确 Excel 导出的设计过程了。接下来,咱们就来一步步实现这个性能。
创立 Excel 模型
创立 Excel 模型,波及到注解三要素中的定义、应用。
首先,定义 Excel 注解,咱们间接看要害代码。
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelField {
/**
* 导出字段题目
*/
String title();
/**
* 导出字段排序(升序)*/
int sort() default 0;
/**
* 对齐形式(0:主动;1:靠左;2:居中;3:靠右)*/
int align() default 0;}
这里用到了两个元注解 @Retention
和@target
。@target
代表这个注解只能放在成员变量上;@Retention
代表这个注解要加载到 JVM 内存,咱们能够用反射来读取注解。
此外,注解还有 3 个成员变量,别离对应:Excel 的字段题目、字段排序、对齐形式,不便大家微调表格。到了这,定义 Excel 注解就实现了。
接下来,应用注解,咱们还是间接看代码。
public class OrderModel {@ExcelField(title = "订单号", align = 2, sort = 20)
private String orderNo;
@ExcelField(title = "金额", align = 2, sort = 20)
private String amount;
// 创立工夫
private Date createTime;
// 省略 getter/setter 办法
}
订单模型有 3 个字段:订单号、金额、创立工夫,但这里注解只加到订单号、金额上,示意这两个字段会导出 Excel 表,而创立工夫会疏忽,你能够看看这副图片。
至此,咱们实现了定义注解、应用注解,失去了一个 Excel 模型。但要想实现导出性能,还必须依据这个模型,生成出 Excel 表。
读取 Excel 模型
读取 Excel 模型,波及到注解三要素中的读取。 咱们须要读取注解,生成 Excel 表,这次要分成 3 个步骤:初始化 Excel 表对象—> 写入数据到 Excel 表对象—> 输入文件。
第一步,初始化 Excel 表对象。在这一步中,咱们要依据 Excel 模型,生成一个 Excel 表对象,要创立这几个货色:题目、表头、款式等等。咱们来看代码。
public class ExcelExporter {
// ... 省略有数代码
/***************************** 初始化 Excel 表对象 ****************************/
/**
* 构造函数
* @param title 表格题目,传“空值”,示意无标题
* @param cls excel 模型对象
*/
public ExcelExporter(String title, Class<?> cls) {
// 获取注解 list
Field[] fs = cls.getDeclaredFields();
for (Field f : fs) {ExcelField ef = f.getAnnotation(ExcelField.class);
if (ef != null) {annotationList.add(new Object[]{ef, f});
}
}
annotationList.sort(comparing(o -> ((ExcelField) o[0]).sort()));
// 通过注解获取表头
List<String> headerList = new ArrayList<>();
for (Object[] os : annotationList) {String t = ((ExcelField) os[0]).title();
headerList.add(t);
}
// 初始化 excel 表:创立 excel 表、增加表题目、创立表头等等
initialize(title, headerList);
}
}
在初始化的时候,咱们先从 Excel 模型对象中读取注解,取得一个注解列表;而后,再从注解列表中,读取 title- 字段题目;最初,再初始化 Excel 表对象,包含:创立 Excel 表对象、增加表题目、创立表头、增加款式。
第二步,写入数据到 Excel 表对象。在这一步中,咱们要把 Java 的列表数据写到 Excel 表对象里,让这些数据能变成 Excel 表的一行行信息。还是来看代码。
public class ExcelExporter {
/***************************** 初始化 Excel 表对象 ****************************/
// ... 省略有数代码
/***************************** 写入数据到 Excel 表对象 ****************************/
/**
* 写入数据
* @return list 数据列表
*/
public <E> ExcelExporter setDataList(List<E> list) {for (E dataObj : list) {
// 增加行
Row row = this.addRow();
// 获取数据,并写入单元格
int cellNo = 0;
for (Object[] os : annotationList) {
// 获取成员变量的值
Object value = null;
try {value = Reflections.invokeGetter(dataObj, ((Field) os[1]).getName());
} catch (Exception ex) {log.info(ex.toString());
value = "";
}
if (value == null) {value = "";}
// 写入单元格
ExcelField ef = (ExcelField) os[0];
this.addCell(row, cellNo++, value, ef.align());
}
}
return this;
}
}
咱们先传入一个数据列表 dataList,而后用循环来遍历 dataList,在这个循环中,咱们一直把数据写进 Excel 表对象里,具体操作是:创立了一个空白行,利用注解获取成员变量里的值,最初写进 Excel 表的单元格里。
第三步,输入文件。在这一步中,就是 Excel 表对象变成一个文件,来看下最初的代码吧。
public class ExcelExporter {
/***************************** 初始化 Excel 表对象 ****************************/
// ... 省略有数代码
/***************************** 写入数据到 Excel 表对象 ****************************/
// ... 省略有数代码
/***************************** 输入相干 ****************************/
/**
* 输入到文件
* @param fileName 输入文件名,加上绝对路径
*/
public ExcelExporter writeFile(String fileName) throws IOException {FileOutputStream os = new FileOutputStream(fileName);
this.write(os);
return this;
}
}
输入文件就没什么好说的了,就是指定文件名,而后把文件输入到指定的中央。
到了这,读取 Excel 模型就实现了。
当然,读取 Excel 模型波及到注解的读取,这是注解最难了解的中央,因为读取注解要用到 Java 另一个高级个性—反射。而且,注解个别是用来简化业务,你对业务没有粗浅的理解,是很难用好注解的。
限于篇幅,我只讲了最外围的代码,我的项目的残缺代码放在文末的链接上,大家能够好好看看。
写在最初
注解想发挥作用,有三个因素:定义、应用、读取。这篇文章利用了注解的三要素,实现了 Excel 导出性能。
这分成两步。第一步,创立 Excel 模型,这波及到注解三要素中的定义、应用;第二步,读取 Excel 模型,这波及到注解三要素中的读取。
总之,注解个别用来简化业务,你要想用好注解,岂但得熟练掌握 Java 的高级用法,还得对业务有粗浅的了解。
文章演示代码:点击跳转