Java注解 学习总结

注解可以理解为是一套必须带有默认值的接口方法,相比接口,注解在代码中更像是一种描述或者标记。
Java里有三种标准注解:
@Override -- 标记为覆盖超类方法。
@Deprecated -- 标记为过期。
@SuppressWarnings -- 标记为不提示编译警告。

四种元注解(负责注解其他注解):
@Target -- 标记注解使用范围。(FIELD-域,METHOD-方法,TYPE-类型,CONSTRUCTOR-构造器,等等)
@Retention -- 标记为保存该注解信息的级别。(RUNTIME-VM在运行期也保留注解,因此可以通过反射机制读取注解信息,SOURCE-注解会被编译器丢弃,CLASS-注解正在class文件中可用,但会被VM丢弃)
@Documented --标记此注解包含在Javadoc中。
@Inherited -- 允许子类继承父类中的注解。

模拟数据库字段约束示例

所有注解的RetentionPolicy都是RUNTIME,这样才可以在注解处理器中用反射获取注解信息。

//Target约束注解为TYPE,注解用于‘类’
//注解数据库表,name()为表名
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
    String name() default "";
}
//Target约束注解为FIELD,注解用于‘域’
//此注解为约束,设置字段是否主键,是否允许为空,是否为唯一索引等
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Constraints {
    boolean primaryKey() default false;
    boolean allowNull() default true;
    boolean unique() default false;
}
//整数字段类型的注解,表示某个域为整型
//同时嵌套了Constraints约束注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLInteger {
    String name() default "";
    Constraints constraints() default @Constraints;
}
//同SQLInteger注解,这是一个VARCHAR类型的域注解
//length为设定长度
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLString {
    //字段长度
    int length() default 0;
    String name() default "";
    Constraints constrants() default @Constraints;
}
//Decimal类型
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLDecimal {
    //字段名称
    String name() default "";
    //长度为10
    int length() default 10;
    //精度为2
    int precision() default 2;
    Constraints constraints() default @Constraints;
}
创建一张表,用注解描述表名和字段类型
//表名为MemberName
@DBTable(name = "MemberName")
public class Member {

    //默认赋值到int
    @SQLString(length = 30)
    private String firstName;

    @SQLString(length = 50)
    private String lastName;

    @SQLInteger
    private Integer age;

    @SQLString(length = 30, constrants = @Constraints(primaryKey = true))
    private String handle;

    @SQLDecimal
    private BigDecimal salary;

    getters() and setters ..
}
读取创建信息的注解处理器(反射)
public class TableCreator {

    public static void main(String[] args) throws ClassNotFoundException {
           String[] tables = new String[]{"chapter20_annotation.generatingExternalFiles.Member"};
        for (String className : tables ) {
            //反射得到类型信息
            Class<?> cl = Class.forName(className);
            //获取类上指定的注解
            DBTable dbTable = cl.getAnnotation(DBTable.class);
            //如果参数列表的类中不存在DBTable注解,跳过
            if (dbTable == null) {
                System.out.println("No Table annotation in class " + className);
                continue;
            }
            String tableName = dbTable.name();
            if (tableName.length() < 1) {
                tableName = cl.getName().toUpperCase();
            }
            //类型注解名称
            System.out.println("tableName: " + tableName);
            List<String> columnDefs = new ArrayList<>();
            //获取类中的成员
            for (Field field : cl.getDeclaredFields()) {
                //字段名称
                String columnName = null;
                //获取成员上的注解列表
                Annotation[] anns = field.getDeclaredAnnotations();
                if (anns.length < 1)
                    continue;
                //数据库表中每个字段只会有一种数据类型,数据类型注解中嵌套了约束注解,所以只需用anns[0]
                if (anns[0] instanceof SQLInteger) {
                    SQLInteger sInt = (SQLInteger) anns[0];
                    if (sInt.name().length() < 1) {
                        columnName = field.getName().toUpperCase();
                    } else {
                        columnName = sInt.name();
                    }
                    columnDefs.add(columnName + " INT" + getConstraints(sInt.constraints()));
                }
                if (anns[0] instanceof SQLString) {
                    SQLString sString = (SQLString) anns[0];
                    if (sString.name().length() < 1) {
                        columnName = field.getName().toUpperCase();
                    } else {
                        columnName = sString.name();
                    }
                    columnDefs.add(columnName + " VARCHAR(" + sString.length() + ")" + getConstraints(sString.constrants()));
                }
                if (anns[0] instanceof SQLDecimal) {
                    SQLDecimal sDecimal = (SQLDecimal) anns[0];
                    if (sDecimal.name().length() < 1) {
                        columnName = field.getName().toUpperCase();
                    } else {
                        columnName = sDecimal.name();
                    }
                    columnDefs.add(columnName + " Decimal(" + sDecimal.length() + ", " + sDecimal.precision() + ")" + getConstraints(sDecimal.constraints()));
                }
            }
            StringBuilder createCommand = new StringBuilder("CREATE TABLE " + tableName + "(");
            for (String columnDef : columnDefs)
                createCommand.append("\n    ").append(columnDef).append(".");
            String tableCreate = createCommand.substring(0, createCommand.length() - 1) + ");";
            System.out.println("Table Creation SQL for " + className + " is :\n" + tableCreate);
        }
    }
打印结果
tableName: MemberName
Table Creation SQL for chapter20_annotation.generatingExternalFiles.Member is :
CREATE TABLE MemberName(
    FIRSTNAME VARCHAR(30).
    LASTNAME VARCHAR(50).
    AGE INT.
    HANDLE VARCHAR(30) PRIMARY KEY.
    SALARY Decimal(10, 2));

注解处理器解析出代码中的注解,并根据数据库语法规则打印出创建MemberName表的SQL语句。以上自定义注解的RetentionPolicy.RUNTIME设定,可以在运行时期通过Java反射机制获取注解在内存模型中的信息。
下面的图是我根据自己的理解画的,比较简单。


Java通过反射进入内存模型中的方法区,方法区里包含类型信息,getAnnotation()方法可以获得类上指定的注解,示例中是检查了DBTable注解是否存在在这个类中,获取DBTable注解后通过 dbTable.name()就获取到设定的表名(注解可以理解成是带有默认值的接口,所以这个操作就是获取了方法的返回值)。同样在域值上,field.getDeclaredAnnotations()方法可以获取某个域上的注解列表,然后遍历注解列表逐个解析。理解了内存模型,这一点就不难了。

Remark

Spring里有很多在类型上的注解,比如@Service,@Controller,等都可以自定义一个类名,当然在真实框架中不可能用这么暴力的注解处理器,每次都去做全局的遍历,《Thinking In Java》中提到了观察者模式下的注解处理器,还没怎么看明白,先在此记录一下注解本身的原理和用法吧~ 再接再厉~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容