[2]朝花夕拾-JAVA注解、PHP注解?

本文轉載自查看原文 2017-12-13 15:43 2207 JAVA

一、Java注解概述

注解，也被稱為元數據，為我們在代碼中添加信息提供了一種形式化的方法，是我們可以在稍后某個時刻非常方便地使用這些數據。

注解在一定程度上是把元數據與源代碼文件結合在一起，而不是保存在外部的文檔中這一大的趨勢之下所催生的。同時，注解也是來仔像C#之類的其他語言對Java造成的語言特性壓力所做出的一種回應。

注解是眾多引入到Java SE5中的重要的語言變化之一。它們可以提供用來完整的描述程序所需的信息，而這些信息是無法用Java來表達的。因此，注解是得我們能夠以將由編譯器來測試和驗證的格式、存儲有關程序的額外信息。

---《Java編程思想-第4版》

注解的語法比較簡單，以“@”符號開始，Java SE5內置提供了三種，定義在java.lang中的注解：

@Override，表示當前方法定義覆蓋了父類中同名的方法，如果在這個注解下的方法在父類中沒有出現過，就證明是程序員不小心寫錯了代碼，這時由於有這個注解，編譯器就會提示此處的代碼有錯。
@Deprecated，如果程序員使用了注解為它的元素，那么編譯器會發出警告信息。比如在不斷更新的JDK中，有的類、方法會在將來的JDK版本中刪除，過渡版本的JDK就會在將要廢棄的方法上添加該注釋，告訴你最好是不要調用該類、方法，但是你強行要調用用的話還是能夠通過編譯。
@SuppressWarnings，關閉不當的編譯器警告信息。要注意的是SuppressWarnings和前兩個注釋不一樣。這個注釋有一個屬性。當然，還可以抑制其它警告，如:
@SuppressWarnings (value={"unchecked", "fallthrough"})

二、定義注解

Java還另外提供了四種注解，專門負責新注解的創建。注解的定義看起來很像接口發的定義，與其他任何Java接口一樣，注解也將會編譯成class文件：

package com.phpdragon.samples;
import java.lang.annotation;

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

除了@符號外，@Test的定義很像一個空的接口。定義注解時，需要一些元注解（meta-annotation），如@Target和@Retention，@Target用來定義你的注解將用在什么地方，是方法前還是域前，或者類前。

@Retention用來定義該注解在哪一個級別可用，在源代碼中（SOURCE)，類文件中（CLASS）或者運行時（RUNTIME)。

四種元注解分別是@Target，@Retention，@Documented，@Inherited。

@Target注解 ,表示注解可用於什么地方。可能的ElementType參數包括：

CONSTRUCTOR：構造器的聲明
FIELD：域聲明（包括enum的聲明）
LOCAL_VARIABLE：局部變量的聲明
METHOD：方法聲明
PACKAGE：包聲明
PARAMETER：參數聲明
TYPE：類、接口（包括注解類型）或enum聲明

@Retention注解 ,表示需要什么級別保存該注釋信息。可選的RetentionPolicy參數包括：

RetentionPolicy.SOURCE —— 這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略。
RetentionPolicy.CLASS —— 這種類型的Annotations編譯時被保留,在class文件中存在,但JVM將會忽略。
RetentionPolicy.RUNTIME —— 這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用。

@Documented注解

Documented 注解表明這個注解應該被 javadoc工具記錄。默認情況下,javadoc是不包括注解的，但如果聲明注解時指定了 @Documented，則它會被 javadoc 之類的工具處理,

所以注解類型信息也會被包括在生成的文檔中，標注此類接口、方法、字段已經被廢止。

@Inherited注解

允許子類繼承父類中的注解。

三、編寫注解處理器

使用注解的過程中，很重要的一個部分就是創建與使用注解處理器。下面通過一個完整的例子來說明怎么定義與使用注解處理器。
1.自定義注解類

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase{
     int id();
     String description() default "no description";
}

2.使用自定義注解

public class PasswordUtils {
    @UseCase(id=1,description = "Passwords must contain at least one numeric")
    public boolean validatePassword(String password){
        return (password.matches("\\w*\\d\\w*"));
    }
    @UseCase(id=2)
    public String encryptPassword(String password){
        return new StringBuilder(password).reverse().toString();
    }
    @UseCase(id=3,description = "New passwords can't equal previously used ones")
    public boolean checkForNewPassword(List<String> prevPasswords,String password){
        return !prevPasswords.contains(password);
    }
}

3.自定義注解處理器

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class UseCaseTracker {
    public static void trackUseCases(List<Integer> useCases,Class<?> cl){
        for(Method m:cl.getDeclaredMethods()){
            UseCase uc=m.getAnnotation(UseCase.class);
            if(uc != null){
                System.out.println("Found Use Case:"+uc.id()+" "+uc.description());
                useCases.remove(new Integer(uc.id()));
            }
        }
        for(int i:useCases){
            System.out.println("Warning: Missing use case-"+i);
        }
    }
    public static void main(String[] args){
        List<Integer> useCases=new ArrayList<Integer>();
        Collections.addAll(useCases,1,2,3,4);
        trackUseCases(useCases,PasswordUtils.class);
    }
}