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

時間 2019-11-06

標籤朝花夕拾 java 註解 php 欄目 Java 简体版

原文原文鏈接

1、Java註解概述

註解，也被稱爲元數據，爲咱們在代碼中添加信息提供了一種形式化的方法，是咱們能夠在稍後某個時刻很是方便地使用這些數據。php

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

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

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

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

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

2、定義註解

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用來定義你的註解將用在什麼地方，是方法前仍是域前，或者類前。ide

@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註解

容許子類繼承父類中的註解。

3、編寫註解處理器

使用註解的過程當中，很重要的一個部分就是建立與使用註解處理器。下面經過一個完整的例子來講明怎麼定義與使用註解處理器。
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);
    }
}