2018-02-28Java注解

参考:《java编程思想》

一。注解分为3类:

1.标准注解(3个):

  • @Override:标识该方法继承自超类。
  • @Deprecated:表示该类或者方法已经不推荐使用。
  • @SuppressWarnings:用于忽略的编译器警告信息。

2.元注解(4个):

  • @Documented:将此注解包含在javadoc中。

  • @Inherited:允许子类继承父类中的注解。

  • @Target:描述注解的使用范围。
    ElementType取值:

              1.CONSTRUCTOR:用于描述构造器
    
              2.FIELD:用于描述域
    
              3.LOCAL_VARIABLE:用于描述局部变量
    
              4.METHOD:用于描述方法
    
              5.PACKAGE:用于描述包
    
              6.PARAMETER:用于描述参数
    
              7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
    
  • Retention:表示需要在什么级别保存该注解信息。
    RetentionPolicy参数取值:

              1.SOURCE:注解将被编译器丢弃。
    
              2.CLASS:注解在class文件中可用,但会被VM丢弃。
    
              3.RUNTIME:VM将在运行期保留注解,因此可以通过反射机制来读取注解的信息。
    

3.自定义注解:

元注解专职负责注解其他的注解,因此举例以下自定义注解:
TestAnnotation.java注解类

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();    //这个就是注解元素

    String desc() default "no description";
}

值得注意:
1、注解元素的类型为:

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

2、注解元素默认值的限制:
注解元素的默认值不能为null,需要定义表示空时,可以自己定义特殊的值如:int id() default -1;String desc() default "";

二.自定义注解实战:

想象数据库的各种元素:数据库名称,约束关系,字段属性等。
看以下关系:


类关系.png

先定义DBTable注解,用于定义数据库的名称:

package db;

import java.lang.annotation.*;

@Documented
@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
    String value() default "";//默认为空,不能写null
}

再看Constants,用于定义约束关系:

package db;

import java.lang.annotation.*;

@Documented //生成javadoc
@Inherited  //让子类继承父类的注解
@Target(ElementType.FIELD)  //修饰字段
@Retention(RetentionPolicy.RUNTIME) //运行时保留注解
public @interface Constants {
    boolean primaryKey() default false;

    boolean allowNull() default true;
}

再看ColumnString,定义字段属性:

package db;

import java.lang.annotation.*;

@Documented
@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ColumnString {
    String value() default "";

    Constants constants() default @Constants;
}

再看ColumnInteger,定义字段属性:

package db;

import java.lang.annotation.*;

@Documented
@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ColumnInteger {
    int value() default -1;

    Constants constants() default @Constants;
}

所有注解都准备好了,现在定义Person类:

package db;

@DBTable("Person")
public class Person {
    @ColumnInteger(value = 1, constants = @Constants(primaryKey = true, allowNull = false))
    private int id;
    @ColumnInteger(value = 24)
    private int age;
    @ColumnString(value = "dxj")
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

现在要编写注解解析器:

public class AnonotationTest {
    public static void main(String[] args) {
        getPersonAnnotation(Person.class);
    }

    public static void getPersonAnnotation(Class<?> cl) {
        //获取类的注解
        Annotation[] declaredAnnotations = cl.getDeclaredAnnotations();
        for (Annotation annotation : declaredAnnotations) {
            if (annotation instanceof DBTable) {
                System.out.println("数据库名称:" + ((DBTable) annotation).value());
            }
        }
        //获取类的字段
        Field[] declaredFields = cl.getDeclaredFields();
        for (Field f : declaredFields) {
            //获取字段的注解
            Annotation[] fDeclaredAnnotations = f.getDeclaredAnnotations();
            for (Annotation annotation : fDeclaredAnnotations) {
                if (annotation instanceof ColumnString) {
                    System.out.println("字段名:" + f.getName() + ",字段长度:" + ((ColumnString) annotation).value() +
                            ",是否主键:" + ((ColumnString) annotation).constants().primaryKey() +
                            ",是否允许为空:" + ((ColumnString) annotation).constants().allowNull());
                }
                if (annotation instanceof ColumnInteger) {
                    System.out.println("字段名:" + f.getName() + ",字段长度:" + ((ColumnInteger) annotation).value() +
                            ",是否主键:" + ((ColumnInteger) annotation).constants().primaryKey() +
                            ",是否允许为空:" + ((ColumnInteger) annotation).constants().allowNull());
                }
            }
        }
    }
}

最后输出的结果为:


注解输出结果.png

注解解析器通过反射获取注解上的值。

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

推荐阅读更多精彩内容