Java註解全面總結

阿新 • • 發佈：2019-01-28

1. 簡介

註解在Java開發中扮演很重要的角色，特別在一些框架或開源庫中可以看到大量註解的運用，如果對註解不夠熟悉，那麼閱讀這些框架或開源庫的程式碼也是十分艱難的。本篇文章將從基本概念、常用註解及自定義註解三個方面來對註解進行一次全面總結，其實也是自己在深入學習註解過程中的一些心得，希望對想了解Java註解的學者有所幫助。

2. 基本概念

2.1 什麼是註解

官方給予的解釋是：

Annotations were introduced into Java in Java SE 5, providing a form of syntactic metadata that can be added to program constructs. Annotations can be processed at compile time, and they have no direct effect on the operation of the code.

翻譯成中文大概意思就是：註解在Java SE5就被引入到Java中，提供一種以元資料的形式新增到程式程式碼中。註解可以在編譯時存在，並且對程式碼的執行沒有直接的影響。

相信初學者看了這段話還是處於一種懵逼狀態，簡單的說就是通過註解可以標註一個類、方法、變數具有某種特殊含義，例如使用@deprecation，作用在方法上表示該方法過時了等，這僅僅只是某一方面，通過註解借用反射可以實現非常強大的功能，下面在自定義註解的時候會講解到，如果對反射還不夠了解，建議先看看有關Java反射的使用看這一篇就夠了這篇文章。

2.2 註解分類

按照執行機制來分

原始碼註解：註解只在原始碼中存在，編譯成.class檔案就不存在了。

編譯時註解：註解在原始碼和.class檔案中都存在。

執行時註解：在執行階段還起作用，甚至會影響執行邏輯。

按照來源來分

JDK自帶的註解。

第三方提供的註解。

我們自定義的註解。

2.3 元註解

所謂元註解即給註解進行註解的註解，主要用來自定義註解。看概念依然難以理解，下面我們具體來講解。元註解主要有以下幾種型別：

元註解說明引數
@Target Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、列舉、Annotation型別）、型別成員（方法、構造方法、成員變數、列舉值）、方法引數和本地變數（如迴圈變數、catch引數）
1.CONSTRUCTOR:用於描述構造器

2.FIELD:用於描述域

3.LOCAL_VARIABLE:用於描述區域性變數

4.METHOD:用於描述方法

5.PACKAGE:用於描述包

6.PARAMETER:用於描述引數

7.TYPE:用於描述類、介面(包括註解型別) 或enum宣告

@Retention 定義了該Annotation被保留的時間長短
1.SOURCE:在原始檔中有效（即原始檔保留）

2.CLASS:在class檔案中有效（即class保留）

3.RUNTIME:在執行時有效（即執行時保留）

@Inherited 執行子註解繼承，也就是說某個父類添加了註解，對於其子類，該註解仍然有效，在自定義註解處會再次說明。
@Documented 生成文件資訊，平常比較少用。

3. Java常用註解

@Override

該註解表示的意思是覆寫，一般出現在繼承關係中，子類某個方法覆寫父類中的方法。

@deprecation

表示這個方法過時了，一般在父類或介面中標註，當然是可以在任何類中的方法上標註的。

@Suppvisewarnings

它表示忽視警告，例如當某個類中用了過時的方法，則編譯器會提示警告，要去除警告這可以新增該註解。

下面看如下Demo:

class Person {
public String getName() {
return "name";
}
@Deprecated // 標註該方法已過時，其他地方呼叫會劃橫線，並給予警告
public int getAge() {
return 0;
}
}
public class Student extends Person{
@Override // 覆寫父類的方法
public String getName() {
return super.getName();
}
@SuppressWarnings("deprecation") // 忽視警告，如果沒有該註解，則下面的呼叫會出現警告
public void printAge(){
System.out.println(getAge());
}
}

4. 自定義註解

我們在自定義註解的時候，有以下幾點需要注意：

第一,只能用public或預設(default)這兩個訪問權修飾.例如,String value();這裡把方法設為defaul預設型別；　　

第二,引數成員只能用基本型別byte,short,char,int,long,float,double,boolean八種基本資料型別和String,Enum,Class,annotations 等資料型別,以及這一些型別的陣列.例如,String value();這裡的引數成員就為String;　　

第三,如果只有一個引數成員,最好把引數名稱設為"value",後加小括號。

如果是初學者，看到這幾個注意點，估計處於完全懵逼狀態，不知所云，下面用一個例項來說明，一定能讓你恍然大悟。

@Target({ElementType.METHOD, ElementType.TYPE}) // 可以作用在方法（METHOD）和類、介面(包括註解型別) 或enum（TYPE）上
@Retention(RetentionPolicy.RUNTIME) // 定義註解的型別；SOURCE,CLASS,RUNTIME
@Inherited // 執行子註解繼承
@Documented // 生成文件資訊；
public @interface Description { // 使用@interface關鍵字定義註解；
/**
* 成員的型別是受限的，合法的型別包括基本型別及String，Class，Annotation，Enumeration
* 如果註解只有一個成員，則成員名必須取名為value(),在使用時可以忽略成員名和賦值號（=）
* 註解類可以沒有成員，沒有成員的註解稱為標識註解
*/
String desc(); // 只能用public或預設(default)這兩個訪問權修飾
public String author();
int age() default 18; // 可以用default為成員指定一個預設值；
}

這裡我們自定義了一個Description 型別註解，定義一個註解使用關鍵字@interface，上面的註釋非常詳細，這裡我在說說這個註解的意思，該註解可以作用在方法、類和介面上，在程式執行時有效，父類添加了此註解同樣對子類也有效，同時還可以根據javadoc命令對類生成文件資訊，接下來我們定義了三個註解的成員，分別為desc、author和age，其中age設定了預設值。

至此，相信大家都對自定義註解有一個全面的瞭解了，此時相信大家還是有一個疑惑，我已經知道怎麼自定義註解了，可是這有什麼用呢？哪些地方需要用到註解？

彆著急，我們繼續。。。

我們使用定義的註解新增到建立的Person類中，如下：

@Description(author = "lvjie", desc = "2016.8.13")
public class Person {
@Description(author = "jack", desc = "2016.04.10", age=20)
public String getName() {
return "name";
}
public int getAge() {
return 0;
}
}

下面再實現一個測試類：

public class MainTest {
public static void main(String[] args) {
try {
Class c = Class.forName("annotation.demo1.Person");
boolean isExist = c.isAnnotationPresent(Description.class);
if(isExist){
Description d = (Description) c.getAnnotation(Description.class); // 找到類上的註解；
System.out.println(d.author()+" "+d.desc()+" "+d.age());
}
// 找到方法上的註解；
Method[]ms = c.getMethods();
for (Method method : ms) {
boolean isMExit = method.isAnnotationPresent(Description.class);
if(isMExit){
Description md = method.getAnnotation(Description.class);
System.out.println(md.author()+" "+md.desc()+" "+md.age());
}
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}

執行之後，可以看到如下輸出：

lvjie 2016.8.13 18
jack 2016.04.10 20

這時候是否有那麼一點茅塞頓開的感覺，我們通過反射可以獲取哪些類哪些方法添加了此註解（這裡再次說明一下，對反射不理解的建議去看看有關Java反射的使用看這一篇就夠了這篇文章），到這裡我們是否可以聯想到Android中的一些開源庫例如EventBus、DBFlow等用到註解的意圖了，如果沒有明白，沒關係，接下來我們使用一個具體例子來說明註解給我們帶來的好處。

使用過DBFlow的開發者，相信大家都為DBFlow如此簡單的使用而驚歎，例如建立表只需要在JavaBean的類及欄位新增相關注解即可，其實DBFlow使用註解在編譯的時候為我們建立相關資料庫表，下面我們就通過註解來實現sql查詢語句的生成。

首先我們定義好兩個註解分別為Table和Column，具體如下：

@Target(ElementType.TYPE) // 只作用於類或介面
@Retention(RetentionPolicy.RUNTIME) // 執行時
public @interface Table {
String value();
}
@Target(ElementType.FIELD) // 只作用於欄位上
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
String value();
}

下面再定一個JavaBean即TUserInfo類

@Table("UserInfo")
public class TUserInfo {
@Column("id")
private int id;
@Column("userName")
private String userName;
@Column("age")
private int age;
@Column("email")
private String email;
@Column("mobile")
private String mobile;
// 省略 get set 函式
}

限於篇幅，此處省略相關get 和 set 函式。

再定義一個工具類，主要通過註解及結合反射來實現查詢sql語句的實現，具體如下：

public class SqlUtils {
public static String querySql(Object object){
StringBuilder sb = new StringBuilder();
// 獲得class
Class<? extends Object> c = object.getClass();
// 獲得table的名字
boolean exists = c.isAnnotationPresent(Table.class); // 獲取該類是否具有Table註解
if(!exists){
return null;
}
Table t = c.getAnnotation(Table.class);
String tableName = t.value(); // 獲取對應註解的值
sb.append("select * from ").append(tableName).append(" where 1=1");
// 遍歷所有欄位
Field[] f = c.getDeclaredFields();
for (Field field : f) {
//4 處理每個欄位對應的sql
// 4.1 拿到欄位名；
boolean fExists = field.isAnnotationPresent(Column.class);
if(!fExists){
continue;
}
Column colum = field.getAnnotation(Column.class);
String columName = colum.value();
// 4.2 拿到欄位值
String fieldName = field.getName();
String getMethodName = "get"+fieldName.substring(0, 1).toUpperCase()+fieldName.substring(1);
Object fieldValue = null;
try {
Method getMethod = c.getMethod(getMethodName);
fieldValue = getMethod.invoke(object);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
// 4.3 拼接sql
if(fieldValue==null || (fieldValue instanceof Integer && (Integer)fieldValue==0)){
continue;
}
sb.append(" and ").append(columName);
if(fieldValue instanceof String){
if(((String) fieldValue).contains(",")){
String[] values = ((String) fieldValue).split(",");
sb.append(" in(");
for (String string : values) {
sb.append("'").append(string).append("'").append(",");
}
sb.deleteCharAt(sb.length()-1);
sb.append(")");
}else{
sb.append("='").append(fieldValue).append("'");
}
}else if(fieldValue instanceof Integer){
sb.append("=").append(fieldValue);
}
}
return sb.toString();
}
}

下面編寫測試類：

public class MainTest {
public static void main(String[] args) {
TUserInfo userInfo = new TUserInfo();
userInfo.setAge(20);
userInfo.setUserName("lvjie");
userInfo.setEmail("[email protected], [email protected], [email protected]");
String sql = SqlUtils.querySql(userInfo);
System.out.println(sql);
}
}

執行，列印資料如下：

select * from UserInfo where 1=1 and userName='lvjie' and age=20 and email in('[email protected]',' [email protected]',' [email protected]')

是不是很簡單，針對這個demo，如果此時我們有增加了一個部門表，例如下：

@Table("TDepartment")
public class TDepartment {
@Column("id")
private int id;
@Column("departmentName")
private String departmentName;
@Column("departmentLeader")
private String departmentLeader;
// 省略set get 函式
}

TDepartment department = new TDepartment();
department.setId(10001);
department.setDepartmentLeader("lvjie");
System.out.println(SqlUtils.querySql(department));

輸出入下：

select * from TDepartment where 1=1 and id=10001 and departmentLeader='lvjie'

此時，相信大家已經對註解刮目相看了吧，盡然能做到如此通用性，結合反射的使用，簡直就是雙劍合璧。

總結

本篇文章對註解做了一個全面解析，從基本概念出發到最後的例項運用，只有在例項中才能體會註解的真諦，希望對大家有所幫助，同時也讓自己對註解的理解更加深刻。

Java註解全面總結

1. 簡介

2. 基本概念

3. Java常用註解

4. 自定義註解

總結

參考文獻

Java註解全面總結

java註解使用總結

【iMooc】全面解析java註解

java 註解總結

分享知識-快樂自己：全面解析 java註解實戰指南

java註解（Annotation）總結

JAVA類的全面總結

Java註解基礎概念總結

Java註解（Annotation）學習總結

2018全面總結阿里巴巴Java開發手冊

Java反射和註解一些總結

Java位操作全面總結

【框架基礎】：全面解析Java註解(一)

Hibernate基於註解方式的各種對映全面總結

框架的基礎--全面解析java註解

全面總結阿里巴巴Java開發手冊

java web 解決中文亂碼問題（全面總結）

Java復習總結——註解

seall的Java IO流總結

java線程總結--synchronized關鍵字，原理以及相關的鎖

元註解	說明	引數
@Target	Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、列舉、Annotation型別）、型別成員（方法、構造方法、成員變數、列舉值）、方法引數和本地變數（如迴圈變數、catch引數）	1.CONSTRUCTOR:用於描述構造器 2.FIELD:用於描述域 3.LOCAL_VARIABLE:用於描述區域性變數 4.METHOD:用於描述方法 5.PACKAGE:用於描述包 6.PARAMETER:用於描述引數 7.TYPE:用於描述類、介面(包括註解型別) 或enum宣告
@Retention	定義了該Annotation被保留的時間長短	1.SOURCE:在原始檔中有效（即原始檔保留） 2.CLASS:在class檔案中有效（即class保留） 3.RUNTIME:在執行時有效（即執行時保留）
@Inherited	執行子註解繼承，也就是說某個父類添加了註解，對於其子類，該註解仍然有效，在自定義註解處會再次說明。
@Documented	生成文件資訊，平常比較少用。

Java註解全面總結

1. 簡介

2. 基本概念

3. Java常用註解

4. 自定義註解

總結

參考文獻

相關推薦