注解是在JDK1.5中引入的，它的定義如下：java提供了一種原程序中的元素關(guān)聯(lián)任何信息和任何元數(shù)據(jù)的途徑。 這個(gè)定義比較抽象。但并不妨礙我們的學(xué)習(xí)。注解一向被看做是高手才掌握的技能，其實(shí)，只要去研究每個(gè)人都可以學(xué)會(huì)。而且注解現(xiàn)在已經(jīng)在各大框架中被廣泛應(yīng)用，例如我們很熟悉的Spring框架中就大量使用了注解。下面是我學(xué)習(xí)注解過程中的一些新的體會(huì)，紀(jì)錄再此，分享給大家。
一、java中的常見注解:
1 . jdk自帶的注解。
@Override ------ 必須被覆蓋的方法
@Deprecated ------ 被廢棄的方法
@SuppressWarnings ------ 忽略警告
上面這些都是我們在java中常見的注解
2 . 第三方的常見注解
在Spring等框架中都使用了第三方的注解。
二、注解的分類
按照運(yùn)行機(jī)制分類
1 . 源碼注解。注解只存在于源碼中，在.class文件中不存在。
2 . 編譯時(shí)注解。注解在源碼和.class文件中都存在。
3 . 運(yùn)行時(shí)注解。注解在運(yùn)行階段還會(huì)起作用，甚至?xí)绊戇\(yùn)行邏輯。
按照來源分類
1 . 來自JDK的注解
2 . 來自第三方的注解
3 . 我們自定義的注解
這里再補(bǔ)充一個(gè)概念：
元注解, 即給注解注解，是注解的注解
三、自定義注解的語法要求
1 . 使用@interface關(guān)鍵字定義注解.
2 . 成員以無參數(shù)無異常的方式聲明.
3 . 可以用default為成員指定默認(rèn)值.
4 . 成員的類型是受限制的.
合法的類型包括java的基本數(shù)據(jù)類型以及
String，Class，Annotation，Enumeration
5 . 如果注解只有一個(gè)成員,則成員名必須取為value(),在使用時(shí)可以忽略成員名和=.
6 . 注解類可以沒有成員,沒有成員的注解類叫做標(biāo)識(shí)注解.
package com.codekong.test;
//使用@interface關(guān)鍵字定義注解
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface AnnTest1 {
//成員以無參數(shù)無異常的方式聲明
String desc();
String author();
//可以用default為成員指定默認(rèn)值
int age() default 18;
}
上面的代碼中我們可以看到
元注解,就是下面的這一段:
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
1 . Target是表示注解的作用域
該作用域的列表有
構(gòu)造方法聲明(CONSTRUCTOR)、字段的聲明(FIELD)、局部變量聲明(LOCAL_VARIABLE)、方法聲明(METHOD)、包聲明(PACKAGE)、參數(shù)聲明(PARAMETER)、類接口(TYPE)。上面的例子中就是聲明了方法聲明和類接口。
2 . Retention是表示注解的生命周期
此處的生命周期我們可以看前面的
注解按運(yùn)行機(jī)制分類。包括SOURCE(只在源碼顯示,編譯時(shí)會(huì)丟棄)、CLASS(編譯時(shí)會(huì)記錄到class中,運(yùn)行時(shí)會(huì)丟棄)、RUNTIME(運(yùn)行時(shí)存在,可以通過反射讀取)上面的例子給出的是運(yùn)行時(shí)注解。
3 . Inherited是標(biāo)識(shí)型的元注解.例子中的注解表示允許子類繼承
4 . Documented表示生成javadoc時(shí)會(huì)包含注解信息.
四、使用自定義注解
使用注解的語法如下:
@<注解名>(<成員名1>=<成員值1>,<成員名2>=<成員值2>,...)
下面的代碼就是在一個(gè)方法上使用我們上面定義的注解
@AnnTest1(desc="yes class",author="moer class",age=20)
public class AnnTestDemo {
@AnnTest1(desc="yes method",author="moer method",age=20)
public String bing() {
return "mo";
}
}
五、解析注解
我們在前面定義了注解,也使用了注解,那我們?nèi)绾文玫绞褂米⒔鈺r(shí)傳入的值呢,這里我們就需要解析注解,下面我們在前面程序的基礎(chǔ)上解析注解,主要分為以下幾個(gè)步驟.
1 . 使用類加載器加載類
2 . 判斷類上面是否有我們自定義的注解
3 . 拿到類上面我們自定義的注解的實(shí)例
4 . 拿到給定類所包含的方法
5 . 遍歷所有的方法,拿到方法上的注解
下面是具體的代碼
public class ParseAnn {
public static void main(String[] args) {
try {
//1.使用類加載器加載類
Class c = Class.forName("com.codekong.test.AnnTestDemo");
//2.找到類上面的注解
//先判斷AnnTestDemo類上面有沒有AnnTest1這樣的注解
boolean isExist = c.isAnnotationPresent(AnnTest1.class);
if(isExist){
//3.拿到類上的注解實(shí)例
AnnTest1 ann = (AnnTest1) c.getAnnotation(AnnTest1.class);
System.out.println(ann.author());
}
//4.找到方法上的注解
//拿到給定類所包含的方法
Method []methods = c.getMethods();
//遍歷方法
for(Method m : methods){
boolean isMExist = m.isAnnotationPresent(AnnTest1.class);
if(isMExist){
//拿到每一個(gè)方法上的注解
AnnTest1 annm = m.getAnnotation(AnnTest1.class);
System.out.println(annm.author());
}
}
//另外一種解析方法
//遍歷所有的方法
for(Method m : methods){
//拿到每個(gè)方法上的注解
Annotation[] as = m.getAnnotations();
for (Annotation a : as) {
if(a instanceof AnnTest1){
AnnTest1 ann = (AnnTest1) a;
System.out.println(ann.author());
}
}
}
} catch (ClassNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
運(yùn)行結(jié)果
moer class
moer method
moer method
注:如果我們在第三步定義自己的注解的時(shí)候,將
@Retention(RetentionPolicy.RUNTIME)改為@Retention(RetentionPolicy.SOURCE)或者@Retention(RetentionPolicy.CLASS),運(yùn)行上面的程序是不會(huì)出現(xiàn)任何結(jié)果.因?yàn)橹挥羞\(yùn)行時(shí)注解可以通過反射獲取,其他兩種注解在運(yùn)行時(shí)已經(jīng)被丟棄了.
六、注解實(shí)戰(zhàn)
上面說了那么多,下面我們通過一個(gè)實(shí)際的例子來練習(xí)一下直接的使用
這個(gè)例子中我們要求利用注解,我們傳入要查詢的bean對(duì)象,最終輸出對(duì)應(yīng)的拼接好的sql語句。
例如:我們定義一個(gè)User類,其中有字段username和password,我們new一個(gè)對(duì)象User user = new User("sss", "123aaa");
傳入user對(duì)象，最終輸出select * from user where 1=1 and user_name='sss' and password='123aaa'
下面我們開始一步步做
1 . 新建Filter.java類.其中的代碼如下
package com.codekong.test;
@Table("user")
public class Filter {
@Columns("user_name")
private String username;
@Columns("password")
private String password;
public void setUsername(String username) {
this.username = username;
}
public void setPassword(String password) {
this.password = password;
}
public String getUsername() {
return username;
}
public String getPassword() {
return password;
}
}
其實(shí)就是一個(gè)bean,定義兩個(gè)字段
username和password,我們利用注解把數(shù)據(jù)表的表名user和表中的對(duì)應(yīng)的字段的名稱加上去.
2 . 我們定義Table.java和Columns兩個(gè)注解類.代碼如下
package com.codekong.test;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE}) //類注解
@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)注解
@Inherited //允許類或接口繼承
@Documented //生成javadoc是包含注解
public @interface Table {
//如果注解只有一個(gè)成員,則成員名必須取為value(),在使用時(shí)可以忽略成員名和=
String value();
}
package com.codekong.test;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.FIELD}) //字段名注解
@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)注解
@Inherited //允許類或接口繼承
@Documented //生成javadoc是包含注解
public @interface Columns {
//如果注解只有一個(gè)成員,則成員名必須取為value(),在使用時(shí)可以忽略成員名和=
String value();
}
上面最主要的要注意,
@Target注解是根據(jù)注解的作用域定義,Table是類的注解,Columns是字段的注解,并且由于我們要在后面利用反射取到定義的值,所以生命周期為運(yùn)行時(shí)注解.
3 . 定義TestDemo.java這個(gè)測試類,并且其中最主要的是query()方法.代碼如下
package com.codekong.test;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
public class TestDemo {
public static void main(String[] args) {
Filter f1 = new Filter();
f1.setUsername("moer");
Filter f2 = new Filter();
f2.setUsername("bing");
f2.setPassword("123a");
System.out.println(query(f1));
System.out.println(query(f2));
}
/**
* 傳入Filter對(duì)象,返回對(duì)應(yīng)的sql查詢語句
* @param f
* @return
*/
private static String query(Filter f) {
//用來拼接字符串
StringBuilder sb = new StringBuilder();
sb.append("select * from ");
String tableName = null;
//獲得Filter類的類類型(加載類)
Class<? extends Filter> filter = f.getClass();
//是否存在我們需要找的注解
boolean isExist = filter.isAnnotationPresent(Table.class);
if(!isExist){
return null;
}else{
//拿到注解的實(shí)例
Table t = (Table) filter.getAnnotation(Table.class);
//拿到表名
tableName = t.value();
}
sb.append(tableName).append(" where 1=1");
//取出所有的字段
Field[] fields = filter.getDeclaredFields();
for (Field field : fields) {
//處理每個(gè)字段對(duì)應(yīng)的sql
//先拿到字段名和字段值再拼裝
boolean ismExist = field.isAnnotationPresent(Columns.class);
if(!ismExist){
continue;
}
//拿到字段注解的實(shí)例
Columns col = (Columns) field.getAnnotation(Columns.class);
//拿到sql的列名
String columnValue = col.value();
//拿到字段名
String fieldName = field.getName();
//拼接出每個(gè)字段的get方法(例如: getUsername)
String getMethodName = "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
String fieldValue = null;
try {
//通過反射獲得get方法
Method getMethod = filter.getMethod(getMethodName);
//通過反射執(zhí)行g(shù)et方法拿到字段的值
fieldValue = (String) getMethod.invoke(f);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
if(fieldValue != null){
//拼裝sql
sb.append(" and ").append(columnValue).append("='").append(fieldValue).append("'");
}
}
return sb.toString();
}
}
最終的運(yùn)行結(jié)果:
select * from user where 1=1 and user_name='moer'
select * from user where 1=1 and user_name='bing' and password='123a'
好了,以上就是有關(guān)注解的介紹,希望可以通過本篇文章幫助到需要的人。
