Java 註解入門例項 && 註解傳參

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

概念：java提供了一種原程式中的元素關聯任何資訊和任何元資料的途徑和方法
JDK內建系統註解：
@Override 用於修飾此方法覆蓋了父類的方法;
@Deprecated 用於修飾已經過時的方法;
@Suppvisewarnings 用於通知java編譯器禁止特定的編譯警告。
常見註解
註解按照執行機制劃分
原始碼註解：註解只在原始碼中存在，編譯成.class檔案就不存在了；
編譯時註解：註解在原始碼和.class檔案中都存在（例：JDK自帶註解）；
執行時註解：在執行階段還起作用，甚至會影響執行邏輯的註解（Autowired）；
自定義註解的元註解：

@Target—作用域（constructor(構造方法宣告)，field（欄位宣告），local_variable（區域性變數宣告），method（方法宣告），package（包宣告），parameter（引數宣告），type（類，介面宣告））

@Retention—生命週期（source：只在原始碼顯示，編譯時會丟棄。class：編譯時會記錄到class中，執行時忽略。runtime：執行時存在，可以通過反射讀取）
Inherited—標識註解(允許子類繼承)
Documented—生成Javadoc
若成員只有一個，必須為value，這個引數賦值可以不寫value=XXX

自定義語法
使用自定義
成員以無參無異常方式宣告。成員型別是受限的，合法的型別包括原始型別及String，Class，Annotation, Enumeration.

上面用了註解，程式中獲得註解資訊的方法是反射。
Class cls = Class.forName(“”);//使用類載入器載入類
cls.isAnnotationPresent(xx.class);//判斷cls這個類上是否有xx的註解，找到類上註解
xx a = (xx)cls.getAnnotation(xx.class);//取得其上的註解

下面附一個例項，是框架如何使用註解描述引數。
結構圖
這裡寫圖片描述

A.java

package javaBasic;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER ,ElementType.METHOD 
})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface A {
    String value();
    String name() default "bingone";
    int age() default 20;
}

B.java

package javaBasic;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER ,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface B {
    String value();
    String name() default "bingone";

}

DataClass.java

package javaBasic;

public class DataClass {
    public String name;
    public int age;
    public DataClass(String name, int age) {
        super();
        this.name = name;
        this.age = age;
    }

}

RunClass.java

package javaBasic;

public class RunClass {
    public static void run(@A("str") String str,@B("age")int age){
        System.out.println("In run Method str:" + str + "age:" + age);
    }
}

TestClass.java

package javaBasic;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
/**
 * 通過註解傳引數
 * @author gg_gogoing
 *
 */
public class TestClass {
    public static void parseMethod(DataClass data,Object obj,String mthname){
        //驗證是否有註解
        //若有則兩種方法：
        //1. 在編譯時刻已經有了對應的表，查表即可
        //2. 如下的遍歷方式。
        if(obj instanceof RunClass){
            String str = null;
            int age = 0;
            Method [] methods = (Method[])obj.getClass().getMethods();
            for(Method method :methods){
                if(method.getName().equals(mthname)){
                    Annotation[][] annotations = method.getParameterAnnotations();
                    for(Annotation[] tt : annotations){
                        for(Annotation t:tt){
                            if(t instanceof A){
                                str = data.name;
                            }else if(t instanceof B){
                                age = data.age;
                            }
                        }
                    }
                    RunClass.run(str, age);
                }
            }
        }
    }

    public static void main(String[] args) throws Exception, RuntimeException { // 主方法
        //不直接傳引數，而是將一個類中的資料傳入
        DataClass dc = new DataClass("gg_gogoing", 20);
        parseMethod(dc, new RunClass(), "run");

    }

}

附一張大圖

========================================================

日誌記錄簡化，只需要在action或者controller的方法上加logging註解即可。註解：@Logging(description = "{username}登入")，description是註解內容，{}中為動態引數，是傳入該方法中的指定po的屬性。

註解類程式碼：

package cn.com.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 日誌註解
* @author ZhangShaobo
* @date 2017-09-04
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public@interface Logging {
String description();
}

具體的日誌實現類，該類中loginfo方法需要在攔截器中呼叫。

package cn.com.util;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.poi.ss.formula.functions.T;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import cn.com.annotation.Logging;
/**
* 日誌註解的具體實現類
* @author ZhangShaobo
* @date 2018-09-04
*/
publicclass LogAnnoUtil {
privatestatic Logger log = LoggerFactory.getLogger(LogAnnoUtil.class);
/**
* 根據註解記錄日誌
* @param t action物件
* @param methodName 呼叫的action方法名稱
* @param map 引數map
*/
publicstatic <T> void loginfo(T t, String methodName, Map map){
Method [] methods = t.getClass().getDeclaredMethods();
for (final Method m : methods) {
if (m.getName().equals(methodName)) {
if(m.isAnnotationPresent(Logging.class)){
String desc = m.getAnnotation(Logging.class).description();
List<String> list = descFormat(desc);
for (String s : list) {
String value = map.get(s).toString();
desc = desc.replace("{"+s+"}", value);
}
// 暫時只是輸出到了控制檯，具體需要存庫或者存快取，需要改這段程式碼
log.info(desc);
}
}
}
}
/**
* 獲取日誌資訊中的動態引數，然後替換
* @param desc
* @return
*/
privatestatic List<String> descFormat(String desc){
List<String> list = new ArrayList<>();
Pattern pattern = Pattern.compile("\\{([^\\}]+)\\}");
Matcher matcher = pattern.matcher(desc);
while(matcher.find()){
String t = matcher.group(1);
list.add(t);
}
return list;
}
}

攔截器中寫呼叫，以上程式碼實現的是在struts框架中用註解記錄日誌，springmvc或者springboot需要適當更改程式碼。有好的建議或者有不明白的地方歡迎評論溝通！

Java 註解入門例項 && 註解傳參

Java 註解入門例項 && 註解傳參

Mybatis入門例項(註解實現)(3)

Java 010 面向物件（傳參、鏈式程式設計、包、修飾符、內部類）

java POST請求兩種傳參方式JSON格式和表單格式

JAVA NIO入門例項

java基於HTTP協議post傳參，獲取引數

Java爬蟲入門例項

java 之方法呼叫方法傳參值傳遞還是引用傳遞位元組碼

《Java從入門到放棄》入門篇：使用註解的方式配置hibernate映射關系

JAVA - Annotation 註解入門

mybatis使用@param("xxx")註解傳參和不使用的區別

mybatis 詳解（三）------入門例項（基於註解）

Swagger註解傳參

使用Java、hibernate validator註解校驗入參，格式化出參（入參）

java 自定義註解應用例項

java/SpringBoot http post請求傳json資料格式（有詳細註解）

struts2使用註解配置Action傳參方式

深入理解Java：註解（Annotation）自定義註解入門

Java中常見的註解

傳參（java）

Java 註解入門例項 && 註解傳參

相關推薦