[[344016]]

本文轉(zhuǎn)載自微信公眾號「小菜良記」，作者蔡不菜丶 。轉(zhuǎn)載本文請聯(lián)系小菜良記公眾號。   

初識(shí)

“「注解」 也稱為 元數(shù)據(jù)。為我們在代碼中添加信息提供了一種形式化的方法，使我們可以在稍后某個(gè)時(shí)刻非常方便地使用這些數(shù)據(jù)。

注解是在 Java 1.5 之后引入的，它可以提供用來完整地描述程序中所需的信息，可以由編譯器來測試和驗(yàn)證的格式，存儲(chǔ)有關(guān)程序的額外信息。

注解的使用很簡單，只需要和 @ 符號搭配。有些 Java 初學(xué)者常常會(huì)把 「注解」 和「注釋」 混淆，但是兩者的作用卻大同小異，都是用來描述信息，不同的是 「注解」 描述的信息是給應(yīng)用程序看的，而 「注釋」 描述的信息是給開發(fā)人員看的。

初學(xué)者對「注解」的印象可能不深，「注解」也許不起眼但是處處可見。

最常見到的便是 @Override，表示當(dāng)前的方法定義將覆蓋父類的方法，如果拼寫錯(cuò)誤，或者方法簽名對不上被覆蓋的方法，編譯器就會(huì)發(fā)出錯(cuò)誤提示。

既然都說到@Override注解了，那仔細(xì)回憶下，腦子里估計(jì)就浮現(xiàn)出@SuppressWarnnings注解。還記得我最早見到這個(gè)注解的時(shí)候，還是Myeclipse提示我使用的，我也不管三七二十一，就給標(biāo)注上了。后來才知道這個(gè)注解是用來關(guān)閉編譯器對類、方法、成員變量、變量初始化的警告。

上面兩個(gè)都說完了，那不妨再來一個(gè)，這個(gè)可能是最不常見的。那就是@Deprecated

不要因?yàn)檫@個(gè)類加了橫線感到奇怪，那是因?yàn)锧Deprecated的效果。它的具體功能就是用于標(biāo)識(shí)方法或類，標(biāo)識(shí)該類或方法已過時(shí)，建議不要使用。如果開發(fā)人員使用了注解為它的元素，那么編譯器就會(huì)發(fā)出警告信息。

剛剛開局不久，我們就已經(jīng)學(xué)到了三個(gè)注解的使用，雖然只是基本的，但接下來我們就通過這三個(gè)注解為導(dǎo)線通關(guān)打怪吧。

首關(guān)之程媧造注

注解一旦構(gòu)造出來，就享有編譯器的類型檢查保護(hù)。讓我們先看下一組代碼熱熱身：

public class TestService { 
 
    @MyAnnotation 
    public void runTset() { 
        System.out.println("annotation test"); 
    } 
 
} 

不要納悶，Java 中確實(shí)沒有一個(gè)注解名為MyAnnotation，但這個(gè)怎么來的呢，就是我們自己造的。

那么關(guān)子賣完了，接下來就來揭秘注解的制造：

@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface MyAnnotation { 
} 

這樣子，一個(gè)簡單的注解就新鮮出爐了。需要注意的是這可不是一個(gè)接口，需要留言interface前面還有一個(gè)@，這個(gè)標(biāo)識(shí)要是漏掉了，那可以天差地別。

細(xì)心的小伙伴可能注意到了，定義的注解頭上怎么還有注解。

這就是接下來要講到，敲黑板，注意看!

元注解來幫忙

在定義注解時(shí)，會(huì)需要一些元注解。上面出現(xiàn)了兩個(gè)，分別是@Target和@Retention.

其中@Target用來定義你的注解將應(yīng)用于什么地方(例如一個(gè)方法或一個(gè)域)，@Retention用來定義該注解在哪一個(gè)級別可用，在源代碼中(「SOURCE」)，類文件中(「CLASS」)或者運(yùn)行時(shí)(「RUNTIME」)。Java 提供了四種元注解，如下：

注解也分類

我們在上面示例中創(chuàng)建了一個(gè) @MyAnnotation 注解?？雌饋砗芎唵?，沒什么內(nèi)容，因此這種注解我們也稱為 「標(biāo)記注解」，注解也分幾類：

• 標(biāo)記注解：注解內(nèi)部沒有屬性。使用方式：「@注解名」

//定義 
@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface MyAnnotation { 
} 

• 單值注解：注解內(nèi)部只有一個(gè)屬性。使用方式：「@注解名(key = value)」

//定義 
@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface SingleValueAnnotation { 
    String name(); 
} 
//使用 
@SingleValueAnnotation(name = "test") 
public void singleTest() {} 

• 多值注解：注解內(nèi)部有過個(gè)屬性。使用方式：「@注解名(key = value, key = value, ...)」

//定義 
@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface MultiValueAnnotation { 
    String name(); 
    int num(); 
} 
//使用 
@MultiValueAnnotation(name = "test", num = 1) 
public void multiTest() {} 

值也有默認(rèn)

當(dāng)我們使用的不是標(biāo)記注解時(shí)，如果在使用注解的時(shí)候不給注解中的屬性賦上值，那么編譯器就會(huì)報(bào)錯(cuò)，提示我們需要賦值。

這樣子是很不方便，有時(shí)候我們并沒有使用到或值是固定的不想重復(fù)寫，那么這個(gè)時(shí)候就需要借助「default」關(guān)鍵字來幫忙我們解決這種問題。

@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface MultiValueAnnotation { 
     
    String name(); 
     
    int num() default 0; 
} 

我們在屬性上使用了 default 關(guān)鍵字來聲明 num 屬性的默認(rèn)值為 0 ，這樣子我們在使用上述那個(gè)注解的時(shí)候就可以不用手動(dòng)給num賦值了。

次關(guān)之造器解注

注解具有讓編譯器進(jìn)行編譯檢查的作用，但是如果沒有用來讀取注解的工具，那注解也不會(huì)比注釋更有用，起碼注釋可以讓開發(fā)人員更直觀的看到此段代碼的用處。

重回反射想要?jiǎng)?chuàng)建與使用 「注解處理器」，我們還需要借助反射機(jī)制來構(gòu)造這類工具。以下是簡單的例子：

public class AnnotationHandle { 
 
    public static void track(Class<?> c) { 
        for (Method m : c.getDeclaredMethods()) { 
            MultiValueAnnotation annotation = m.getAnnotation(MultiValueAnnotation.class); 
            if (annotation != null) { 
                System.out.println("name:" + annotation.name() + 
                        "\n num:" + annotation.num()); 
            } 
        } 
    } 
 
    public static void main(String[] args) { 
        track(TestService.class); 
    } 
} 
 
/*  OUTPUT: 
  name:test 
   num:0 
*/ 

在上述例子中我們用到了兩個(gè)反射的方法：getDeclaredMethods()和getAnnotation()。

其中g(shù)etDeclaredMethods() 用來返回該類的所有方法，getAnnotation()用來獲取指定類型的注解對象。如果方法上沒有該注解則會(huì)返回 「null」 值。

注解元素可用類型

上述@MultiValueAnnotation注解中我們定義了 String類型的 「name」 和 int類型的 「num」，除此之外我們還可以使用其他類型如下：

• 「基本類型」(「int、float、boolean等」)
• 「String」
• 「Class」
• 「enum」
• 「Annotation」
• 「以上類型的數(shù)組」

如果使用了上面以外的其他類型，那么編譯器就會(huì)報(bào)錯(cuò)。而且要注意的是，「也不能使用基本類型的包裝類型」

默認(rèn)值的限制

上述例子中我們也看到了，我們可以在使用注解的時(shí)候給注解屬性賦值，也可以在定義注解的時(shí)候給注解一個(gè)默認(rèn)值，但是這兩者都說明了一件事：「那就是，注解元素不能有不確定的值，要么具有默認(rèn)值，要么在使用注解時(shí)提供元素的值」

基本元素不存在null值，因此對于非基本類型的元素，無論是在使用中聲明，還是在定義時(shí)聲明， 「都不能將 null 值作為其值」。因此在實(shí)際開發(fā)中，我們往往會(huì)定義一些特殊值作為不存在的標(biāo)識(shí)，例如 「負(fù)數(shù)」 或 「空字符串」

三關(guān)之運(yùn)注帷幄

在前面兩關(guān)中，我們學(xué)會(huì)了定義注解和創(chuàng)建注解處理器。接下來我們就要來更加深入掌握注解!

注解也能嵌套

在修飾注解元素的時(shí)候我們看到可以使用Annotation來修飾，估計(jì)看到那的時(shí)候會(huì)覺得有點(diǎn)奇怪。在這里就來為你來揭秘。

先來看一組注解：

@Constraints

@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface Constraints { 
    boolean primaryKey() default false; 
    boolean unique() default false; 
} 

@SQLString

@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface SQLString { 
    String name() default ""; 
    Constraints constraints() default @Constraints; 
} 

我們在@SQLString注解中使用Constraints注解元素，并將默認(rèn)值設(shè)為@Constraints。這個(gè)時(shí)候Constraints中的值都是@Constraints注解中定義的默認(rèn)值，如果我們要使用自定義的話，做法如下：

@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface SQLString { 
    String name() default ""; 
    Constraints constraints() default @Constraints(primaryKey = true); 
} 

這樣子我們就可以使用自己定義的「value」

注解不支持繼承

我們不能使用extends來繼承某個(gè)@interface，但是可以通過嵌套的方式來解決這一煩惱。

AOP與注解的搭配

「AOP」 在當(dāng)今開發(fā)中我們并不陌生，那么 「AOP」 和 「注解」 能產(chǎn)生什么化學(xué)反應(yīng)呢，請看以下代碼：

@ApiLog：

@Retention(RetentionPolicy.RUNTIME) 
@Target({ElementType.METHOD, ElementType.TYPE}) 
public @interface ApiLog { 
    /** 
     * 接口名稱 
     */ 
    String name(); 
} 

使用：

@GetMapping(value = "/getConfig") 
@ApiLog(name = "獲取系統(tǒng)相關(guān)配置") 
public Result getConfig() throws Exception { 
    return sendOK(SystemService.getConfig(type)); 
} 

Aop使用：

@Aspect 
@Component 
public class SysLogAspect { 
    @Autowired 
    private LogService logService; 
     
    @Pointcut("@annotation(cbuc.life.annotation.ApiLog)") 
    public void logPointCut() {         
    } 
 
    @Around("logPointCut()") 
    public Object around(ProceedingJoinPoint point) throws Throwable { 
        long beginTime = System.currentTimeMillis(); 
        //執(zhí)行方法 
        Object result = point.proceed(); 
        //執(zhí)行時(shí)長(毫秒) 
        long time = System.currentTimeMillis() - beginTime; 
        //保存日志 
        saveSysLog(point, time); 
        return result; 
    } 
 
    private void saveSysLog(ProceedingJoinPoint joinPoint, long time) { 
        MethodSignature signature = (MethodSignature) joinPoint.getSignature(); 
        Method method = signature.getMethod(); 
 
        LogEntity log = new LogEntity(); 
        ApiLog apiLog = method.getAnnotation(ApiLog.class); 
        if(apiLog != null){ 
            //注解上的描述 
            log.setMethodDescribe(syslog.value()); 
        } 
 
        //請求的方法名 
        String className = joinPoint.getTarget().getClass().getName(); 
        String methodName = signature.getName(); 
        log.setMethod(className + "." + methodName + "()"); 
 
        //請求的參數(shù) 
        Object[] args = joinPoint.getArgs(); 
        String params = JSON.toJSONString(args[0]); 
        log.setParams(params); 
 
        //獲取request 
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); 
 
        //設(shè)置IP地址 
        log.setIp(ServletUtil.getIpAddress(request)); 
 
        //用戶名 
        String username = LoginInfo.getUsername(); 
        log.setUsername(username); 
 
        //保存系統(tǒng)日志 
        logService.save(log); 
    } 
} 

通過以上代碼，我們可以在期望記錄日志的方法上增加@ApiLog注解，該方法的動(dòng)作就會(huì)被記錄進(jìn)日志表，不管方法叫什么名字，類在什么位置，都可以輕松的解決，而且沒有代碼入侵!