詳解Java如何實(shí)現(xiàn)自定義注解
概念
概念:說明程序的。給計(jì)算機(jī)看的
注釋:用文字描述程序的。給程序員看的
定義:注解(Annotation),也叫元數(shù)據(jù)。一種代碼級(jí)別的說明。它是JDK1.5及以后版本引入的一個(gè)特性,與類、接口、枚舉是在同一個(gè)層次。它可以聲明在包、類、字段、方法、局部變量、方法參數(shù)等的前面,用來對(duì)這些元素進(jìn)行說明,注釋。
作用
作用分類:
- 編寫文檔:通過代碼里標(biāo)識(shí)的注解生成文檔【生成文檔doc文檔】
- 代碼分析:通過代碼里標(biāo)識(shí)的注解對(duì)代碼進(jìn)行分析【使用反射】
- 編譯檢查:通過代碼里標(biāo)識(shí)的注解讓編譯器能夠?qū)崿F(xiàn)基本的編譯檢查【Override】
JDK中預(yù)定義的一些注解
@Override:檢測(cè)被該注解標(biāo)注的方法是否是繼承自父類(接口)的
@Deprecated:該注解標(biāo)注的內(nèi)容,表示已過時(shí)
@SuppressWarnings:壓制警告
一般傳遞參數(shù)all @SuppressWarnings("all")
注解生成文檔案例
要生成doc文檔的api類案例:
/**
* 注解javadoc演示
*
* @author zjq
* @version 1.0
* @since 1.5
*/
public class AnnoDoc {
/**
* 計(jì)算兩數(shù)的和
* @param a 整數(shù)
* @param b 整數(shù)
* @return 兩數(shù)的和
*/
public int add(int a, int b ){
return a + b;
}
}
在對(duì)應(yīng)的類目錄進(jìn)入cmd,執(zhí)行如下命令
javadoc AnnoDoc.java
執(zhí)行完成后可以看到生成了很多html和js等前端文件,點(diǎn)擊index.html??梢钥吹饺缦滦Ч?/p>


自定義注解
格式
元注解
public @interface 注解名稱{
屬性列表;
}
本質(zhì)
注解本質(zhì)上就是一個(gè)接口,該接口默認(rèn)繼承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {}
屬性:接口中的抽象方法
要求:
1.屬性的返回值類型有下列取值
基本數(shù)據(jù)類型
String
枚舉
注解
以上類型的數(shù)組
2.定義了屬性,在使用時(shí)需要給屬性賦值
- 如果定義屬性時(shí),使用default關(guān)鍵字給屬性默認(rèn)初始化值,則使用注解時(shí),可以不進(jìn)行屬性的賦值。
- 如果只有一個(gè)屬性需要賦值,并且屬性的名稱是value,則value可以省略,直接定義值即可。
- 數(shù)組賦值時(shí),值使用{}包裹。如果數(shù)組中只有一個(gè)值,則{}可以省略
案例:
定義
public @interface MyAnno {
int value();
Person per();
MyAnno2 anno2();
String[] strs();
}
public enum Person {
P1,P2;
}
使用
@MyAnno(value=12,per = Person.P1,anno2 = @MyAnno2,strs="bbb")
public class Worker {
}
元注解:用于描述注解的注解
@Target:描述注解能夠作用的位置
- ElementType取值:
- TYPE:可以作用于類上
- METHOD:可以作用于方法上
- FIELD:可以作用于成員變量上
@Retention:描述注解被保留的階段
@Retention(RetentionPolicy.RUNTIME):當(dāng)前被描述的注解,會(huì)保留到class字節(jié)碼文件中,并被JVM讀取到,自定義注解一般用這個(gè)。
@Documented:描述注解是否被抽取到api文檔中
@Inherited:描述注解是否被子類繼承
在程序使用(解析)注解:獲取注解中定義的屬性值
之前我們?cè)诜瓷渲杏型ㄟ^讀取配置文件來創(chuàng)建任意類的對(duì)象,執(zhí)行任意方法。具體反射內(nèi)容可以看我的這篇文章:Java框架設(shè)計(jì)靈魂之反射的示例詳解
之前反射中我們通過讀取對(duì)應(yīng)的配置文件然后創(chuàng)建類和執(zhí)行方法,代碼如下:
/**
前提:不能改變?cè)擃惖娜魏未a。可以創(chuàng)建任意類的對(duì)象,可以執(zhí)行任意方法
*/
//1.加載配置文件
//1.1創(chuàng)建Properties對(duì)象
Properties pro = new Properties();
//1.2加載配置文件,轉(zhuǎn)換為一個(gè)集合
//1.2.1獲取class目錄下的配置文件
ClassLoader classLoader = ReflectTest.class.getClassLoader();
InputStream is = classLoader.getResourceAsStream("pro.properties");
pro.load(is);
//2.獲取配置文件中定義的數(shù)據(jù)
String className = pro.getProperty("className");
String methodName = pro.getProperty("methodName");
//3.加載該類進(jìn)內(nèi)存
Class cls = Class.forName(className);
//4.創(chuàng)建對(duì)象
Object obj = cls.newInstance();
//5.獲取方法對(duì)象
Method method = cls.getMethod(methodName);
//6.執(zhí)行方法
method.invoke(obj);
我們可以通過注解替換上述讀取配置文件相關(guān)操作。具體代碼如下:
注解定義如下:
/**
* 描述需要執(zhí)行的類名,和方法名
* @author zjq
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();
String methodName();
}
通過解析注解配置,執(zhí)行相關(guān)對(duì)象創(chuàng)建和執(zhí)行對(duì)象方法。
- 獲取注解定義的位置的對(duì)象 (Class,Method,Field)
- 獲取指定的注解
- 調(diào)用注解中的抽象方法獲取配置的屬性值
代碼如下:
@Pro(className = "com.zjq.javabase.base25.annotation.Demo1",methodName = "show")
public class ReflectTest {
public static void main(String[] args) throws Exception {
/**
* 前提:不能改變?cè)擃惖娜魏未a??梢詣?chuàng)建任意類的對(duì)象,可以執(zhí)行任意方法
*/
//1.解析注解
//1.1獲取該類的字節(jié)碼文件對(duì)象
Class<ReflectTest> reflectTestClass = ReflectTest.class;
//2.獲取上邊的注解對(duì)象
//其實(shí)就是在內(nèi)存中生成了一個(gè)該注解接口的子類實(shí)現(xiàn)對(duì)象
/*
public class ProImpl implements Pro{
public String className(){
return "com.zjq.javabase.base25.annotation.Demo1";
}
public String methodName(){
return "show";
}
}
*/
Pro an = reflectTestClass.getAnnotation(Pro.class);
//3.調(diào)用注解對(duì)象中定義的抽象方法,獲取返回值
String className = an.className();
String methodName = an.methodName();
System.out.println(className);
System.out.println(methodName);
//4.加載該類進(jìn)內(nèi)存
Class cls = Class.forName(className);
//5.創(chuàng)建對(duì)象
Object obj = cls.newInstance();
//6.獲取方法對(duì)象
Method method = cls.getMethod(methodName);
//7.執(zhí)行方法
method.invoke(obj);
}
}
案例:通過自定義注解定義一個(gè)簡(jiǎn)單的測(cè)試框架
定義一個(gè)測(cè)試注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}
定義一個(gè)計(jì)算器工具類,并在方法上使用@Check注解
/**
* 小明定義的計(jì)算器類
* @author zjq
*/
public class Calculator {
//加法
@Check
public void add(){
String str = null;
str.toString();
System.out.println("1 + 0 =" + (1 + 0));
}
//減法
@Check
public void sub(){
System.out.println("1 - 0 =" + (1 - 0));
}
//乘法
@Check
public void mul(){
System.out.println("1 * 0 =" + (1 * 0));
}
//除法
@Check
public void div(){
System.out.println("1 / 0 =" + (1 / 0));
}
public void show(){
System.out.println("永無bug...");
}
}
定義測(cè)試框架類并執(zhí)行測(cè)試,把測(cè)試異常記錄到bug.txt文件中,代碼如下:
/**
* 簡(jiǎn)單的測(cè)試框架
* 當(dāng)主方法執(zhí)行后,會(huì)自動(dòng)自行被檢測(cè)的所有方法(加了Check注解的方法),判斷方法是否有異常,
* 記錄到文件中
*
* @author zjq
*/
public class TestCheck {
public static void main(String[] args) throws IOException {
//1.創(chuàng)建計(jì)算器對(duì)象
Calculator c = new Calculator();
//2.獲取字節(jié)碼文件對(duì)象
Class cls = c.getClass();
//3.獲取所有方法
Method[] methods = cls.getMethods();
int number = 0;//出現(xiàn)異常的次數(shù)
BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
for (Method method : methods) {
//4.判斷方法上是否有Check注解
if (method.isAnnotationPresent(Check.class)) {
//5.有,執(zhí)行
try {
method.invoke(c);
} catch (Exception e) {
//6.捕獲異常
//記錄到文件中
number++;
bw.write(method.getName() + " 方法出異常了");
bw.newLine();
bw.write("異常的名稱:" + e.getCause().getClass().getSimpleName());
bw.newLine();
bw.write("異常的原因:" + e.getCause().getMessage());
bw.newLine();
bw.write("--------------------------");
bw.newLine();
}
}
}
bw.write("本次測(cè)試一共出現(xiàn) " + number + " 次異常");
bw.flush();
bw.close();
}
}
執(zhí)行測(cè)試后可以在src同級(jí)目錄查看到bug.txt文件內(nèi)容如下:
add 方法出異常了
異常的名稱:NullPointerException
異常的原因:null
--------------------------
div 方法出異常了
異常的名稱:ArithmeticException
異常的原因:/ by zero
--------------------------
本次測(cè)試一共出現(xiàn) 2 次異常
總結(jié)
1.大多數(shù)時(shí)候,我們只是使用注解,而不是自定義注解。
2.注解不是程序的一部分,可以理解為注解就是一個(gè)標(biāo)簽。
3.注解給誰用?
編譯器
給解析程序用
到此這篇關(guān)于詳解Java如何實(shí)現(xiàn)自定義注解的文章就介紹到這了,更多相關(guān)Java自定義注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
關(guān)于BeanUtils.copyProperties(source, target)的使用
這篇文章主要介紹了關(guān)于BeanUtils.copyProperties(source, target)的使用說明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
java+io+swing實(shí)現(xiàn)學(xué)生信息管理系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了java+io+swing實(shí)現(xiàn)學(xué)生信息管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-07-07
詳解spring cloud分布式整合zipkin的鏈路跟蹤
這篇文章主要介紹了詳解spring cloud分布式整合zipkin的鏈路跟蹤,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-07-07
Java異常處理中同時(shí)有finally和return語句的執(zhí)行問題
這篇文章主要介紹了Java異常處理中同時(shí)有finally和return語句的執(zhí)行問題,首先確定的是一般finally語句都會(huì)被執(zhí)行...然后,需要的朋友可以參考下2015-11-11
Spring實(shí)戰(zhàn)之使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)操作示例
這篇文章主要介紹了Spring實(shí)戰(zhàn)之使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)操作,結(jié)合實(shí)例形式分析了spring使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)相關(guān)配置、接口設(shè)置與使用技巧,需要的朋友可以參考下2020-01-01
SpringBoot如何優(yōu)雅實(shí)現(xiàn)接口參數(shù)驗(yàn)證
為了保證參數(shù)的正確性,我們需要使用參數(shù)驗(yàn)證機(jī)制,來檢測(cè)并處理傳入的參數(shù)格式是否符合規(guī)范,所以本文就來和大家聊聊如何優(yōu)雅實(shí)現(xiàn)接口參數(shù)驗(yàn)證吧2023-08-08

