註解是 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 的高級用法,還得對業務有深刻的理解。