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》中提到了观察者模式下的注解处理器，还没怎么看明白，先在此记录一下注解本身的原理和用法吧~ 再接再厉~