Java注解詳解及實(shí)現(xiàn)自定義注解的方法
??概念
概念：說(shuō)明程序的。給計(jì)算機(jī)看的 注釋?zhuān)河梦淖置枋龀绦虻?。給程序員看的 定義：注解（Annotation），也叫元數(shù)據(jù)。一種代碼級(jí)別的說(shuō)明。它是JDK1.5及以后版本引入的一個(gè)特性，與類(lèi)、接口、枚舉是在同一個(gè)層次。它可以聲明在包、類(lèi)、字段、方法、局部變量、方法參數(shù)等的前面，用來(lái)對(duì)這些元素進(jìn)行說(shuō)明，注釋。 概念描述： JDK1.5之后的新特性 說(shuō)明程序的 使用注解：@注解名稱(chēng)
??♀?作用
作用分類(lèi)：
- 編寫(xiě)文檔：通過(guò)代碼里標(biāo)識(shí)的注解生成文檔【生成文檔doc文檔】
- 代碼分析：通過(guò)代碼里標(biāo)識(shí)的注解對(duì)代碼進(jìn)行分析【使用反射】
- 編譯檢查：通過(guò)代碼里標(biāo)識(shí)的注解讓編譯器能夠?qū)崿F(xiàn)基本的編譯檢查【Override】
?JDK中預(yù)定義的一些注解
@Override：檢測(cè)被該注解標(biāo)注的方法是否是繼承自父類(lèi)(接口)的 @Deprecated：該注解標(biāo)注的內(nèi)容，表示已過(guò)時(shí) @SuppressWarnings：壓制警告 一般傳遞參數(shù)all @SuppressWarnings("all")
??注解生成文檔案例
要生成doc文檔的api類(lèi)案例：
/**
* 注解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)的類(lèi)目錄進(jìn)入cmd，執(zhí)行如下命令
javadoc AnnoDoc.java
執(zhí)行完成后可以看到生成了很多html和js等前端文件，點(diǎn)擊index.html?？梢钥吹饺缦滦Ч?/p>
??自定義注解
??格式
元注解 public @interface 注解名稱(chēng){ 屬性列表; }
??本質(zhì)
注解本質(zhì)上就是一個(gè)接口，該接口默認(rèn)繼承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {}??屬性：接口中的抽象方法
要求：
- 屬性的返回值類(lèi)型有下列取值
基本數(shù)據(jù)類(lèi)型 String 枚舉 注解 以上類(lèi)型的數(shù)組
- 定義了屬性，在使用時(shí)需要給屬性賦值
- 如果定義屬性時(shí)，使用default關(guān)鍵字給屬性默認(rèn)初始化值，則使用注解時(shí)，可以不進(jìn)行屬性的賦值。
- 如果只有一個(gè)屬性需要賦值，并且屬性的名稱(chēng)是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：可以作用于類(lèi)上 METHOD：可以作用于方法上 FIELD：可以作用于成員變量上 @Retention：描述注解被保留的階段 @Retention(RetentionPolicy.RUNTIME)：當(dāng)前被描述的注解，會(huì)保留到class字節(jié)碼文件中，并被JVM讀取到，自定義注解一般用這個(gè)。 @Documented：描述注解是否被抽取到api文檔中 @Inherited：描述注解是否被子類(lèi)繼承
??♂?在程序使用(解析)注解：獲取注解中定義的屬性值
之前我們?cè)诜瓷渲杏型ㄟ^(guò)讀取配置文件來(lái)創(chuàng)建任意類(lèi)的對(duì)象，執(zhí)行任意方法。具體反射內(nèi)容可以看我的這篇文章：Java反射：框架設(shè)計(jì)的靈魂 之前反射中我們通過(guò)讀取對(duì)應(yīng)的配置文件然后創(chuàng)建類(lèi)和執(zhí)行方法，代碼如下：
/**
前提：不能改變?cè)擃?lèi)的任何代碼?？梢詣?chuàng)建任意類(lèi)的對(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.加載該類(lèi)進(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ò)注解替換上述讀取配置文件相關(guān)操作。具體代碼如下： 注解定義如下：
/**
* 描述需要執(zhí)行的類(lèi)名，和方法名
* @author zjq
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();
String methodName();
}通過(guò)解析注解配置，執(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è)擃?lèi)的任何代碼?？梢詣?chuàng)建任意類(lèi)的對(duì)象，可以執(zhí)行任意方法
*/
//1.解析注解
//1.1獲取該類(lèi)的字節(jié)碼文件對(duì)象
Class<ReflectTest> reflectTestClass = ReflectTest.class;
//2.獲取上邊的注解對(duì)象
//其實(shí)就是在內(nèi)存中生成了一個(gè)該注解接口的子類(lèi)實(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.加載該類(lèi)進(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);
}
}
??案例：通過(guò)自定義注解定義一個(gè)簡(jiǎn)單的測(cè)試框架
定義一個(gè)檢測(cè)注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}定義一個(gè)計(jì)算器工具類(lèi)，并在方法上使用@Check注解
/**
* 小明定義的計(jì)算器類(lèi)
* @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("永無(wú)bug...");
}
}定義測(cè)試框架類(lèi)并執(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("異常的名稱(chēng):" + 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 方法出異常了 異常的名稱(chēng):NullPointerException 異常的原因:null
div 方法出異常了 異常的名稱(chēng):ArithmeticException 異常的原因:/ by zero
本次測(cè)試一共出現(xiàn) 2 次異常
??♂?總結(jié)
- 大多數(shù)時(shí)候，我們只是使用注解，而不是自定義注解。
- 注解給誰(shuí)用？
- 編譯器
- 給解析程序用
- 注解不是程序的一部分，可以理解為注解就是一個(gè)標(biāo)簽。
到此這篇關(guān)于Java注解詳解及實(shí)現(xiàn)自定義注解的方法的文章就介紹到這了,更多相關(guān)Java自定義注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了詳解Java的Spring框架中bean的注入集合,Spring是Java的SSH三大web開(kāi)發(fā)框架之一,需要的朋友可以參考下2015-12-12
java線程池ThreadPoolExecutor類(lèi)使用小結(jié)
這篇文章主要介紹了java線程池ThreadPoolExecutor類(lèi)使用,本文主要對(duì)ThreadPoolExecutor的使用方法進(jìn)行一個(gè)詳細(xì)的概述，示例代碼介紹了ThreadPoolExecutor的構(gòu)造函數(shù)的相關(guān)知識(shí)，感興趣的朋友一起看看吧2022-03-03
java可變參數(shù)（不定向參數(shù)）的作用與實(shí)例
這篇文章主要給大家介紹了關(guān)于java可變參數(shù)（不定向參數(shù)）的作用與實(shí)例，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
Elasticsearch聚合查詢概念及字段類(lèi)型示例
這篇文章主要為大家介紹了Elasticsearch聚合查詢概念及字段類(lèi)型示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08
今天小編就為大家分享一篇Java中讀取文件轉(zhuǎn)換為字符串的方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-07-07
這篇文章主要介紹了解決springCache配置中踩的坑，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-12-12
這篇文章主要介紹了logback-spring.xml詳解,本文介紹了logback-spring.xml相關(guān)的知識(shí)與概念，結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2023-07-07
這篇文章主要介紹了Springboot多種情況yml配置代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
這篇文章主要介紹了如何用Java編寫(xiě)一個(gè)英文猜詞游戲，可以用來(lái)背英語(yǔ)單詞。文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以了解一下2022-02-02
java+mysql實(shí)現(xiàn)商品搶購(gòu)功能
這篇文章主要為大家詳細(xì)介紹了java+mysql實(shí)現(xiàn)商品搶購(gòu)功能，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-02-02