注解

注解(也被称为元数据)为我们在代码中添加信息提供了一些形式化的方法,是我们在稍后的某个时刻,可以非常方便的使用这些数据

注解的语法比较简单,除了@符号使用之外,他与java语法一致,javaSE5内置了三种,java.lang中的注解

  • @Override 表示当前的方法定义将覆盖超类中的方法
  • @Deprecated 如果程序员使用了注解为他的元素,那么编译器将发出警告信息
  • @SuppressWarnings 关闭不当的编译器警告信息
一. 基本语法
 import org.junit.Test;
public class TestTable {
    public void excute(){
        System.out.println("");
    }
    @Test
    public void testExecute(){
    }
}

可以看出被注解的方法与其他方法并无区别,注解@Test可以与任何修饰符作用于方法

二. 定义注解
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 Test{
}

可以看出注解的定义很像接口的定义,他与java接口一样会编译成class文件,定义注解时,会需要一些元注解,如:@Target,@Retention

  • @Target 用来定义你的注解应用在什么地方(例如是一个方法还是类)
  • @Rectetion 用来定义注解在哪一级别可用,在源代码中(SOURCE),类文件中(CLASS)或者运行时(RUNTIME)
三. 原注解

java 目前只内置了三种标准注解,四种原注解

注解 说明
@Target 表示该注解可用于什么地方。可能的ElementType的参数包括:CONSTRUCTOR:构造器的说明
FIELD:域说明(包括enum实例)
LOCAL_VARIABLE 局部变量声明
METHOD:方法声明
PACKAGET:包的说明
PARAMETER:参数的说明
TYPE:类或接口
@Retention 表示需要在什么级别保存该信息 。可选的RetentionPolicy:
SOURCE:注解将被编译器丢弃
CLASS:注解将在CLASS文件中可用,但在VM中将被丢弃
RUNTIME:VM将在运行期也保留注解,因此可用通过反射机制读取注解的信息
@Docemented 将此注解包含在javadoc中
@Inherited 表示子类允许继承父类的注解
四. 编写注解处理器

如果没有用来读取注解的工具,那么注解也不会比注释更有用。在javaSE5扩展了反射机制的API,以帮助程序员实现这类工具

 import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//@Retention 用来定义该注解在哪一级可以用
//@Target元注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UserCase {
    public int id();
    public String description() default "no description";
}


public class PasswordUtils {
    @UserCase(id=10,description="validatePassword")
    public boolean validatePassword(String password){
        return(password.matches("\\w*\\d\\w*"));
    }
    @UserCase(id=18)
    public String encryptPassword(String password){
        return new StringBuilder(password).reverse().toString();
    }
    @UserCase(id=108,description="checkForNewPassword")
    public boolean checkForNewPassword(String password){
        return true;
    }
}


import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class UserCaseTracker {
    public static void trackUserCases(List<Integer> userCase,Class<?> cl){
        for(Method m : cl.getDeclaredMethods()){
            UserCase u = m.getAnnotation(UserCase.class);
            if(u != null){
                System.out.println("Found Use UserCase:"+u.id()+"\t"+u.description());
                userCase.remove(new Integer(u.id()));
            }
        }
        for(int i : userCase){
            System.out.println("Miss user UserCase "+i);
        }
    }
    public static void main(String[] args) {
        List<Integer> list = new ArrayList<Integer>();
        Collections.addAll(list, 16,108,10,50);
        trackUserCases(list,PasswordUtils.class);
    }
}
五. 编写注解处理器

标签@UserCase由UserCase.java定义,其中包含int元素id,String元素description,注解的可用类型如下所示:

  • 所有的基本类型(int,float,boolean等)
  • String
  • Class
  • Annotation
  • 以上类型的数组

注意:元素不能有不确定的值,要么具有默认的值,要么给元素提供元素的值


注解
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容