Java基础--注解

[TOC]

概念

注解（Annotation）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据

每当创建描述符性质的类和接口时，一旦其中包含了重复性的工作，就可以考虑使用注解来简化与自动化该过程。
注解可用来进行一些提示性、安全检查的作用（如标记注解，@Override等），也可用来在运行时进行逻辑上的操作，简化模板式代码的创建，使代码更加简洁，编写更加高效。注解常见于各种框架当中，学会注解可以对框架理解的更加深入。

注解的类型

注解的分类

按来源可以分为JDK自带注解、第三方框架注解、自定义注解。
JDK自带注解

注解名称	功能
@Override	表示当前的方法定义将覆盖超类中的方法
@Deprecated	使用了这个注解, 表示不建议使用
@SuppressWarnings	关闭不当的编译器警告（JDK>=1.5）

按声明周期可以分为源码注解、编译时注解、运行时注解（下述祥）

元注解

元注解是用来注解其他注解的注解

注解名称	功能
@Target	表示该注解可以用于什么地方
@Retention	需要在什么级别保存该注解信息
@Documented	将此注解包含在Javadoc中
@Inherited	允许子类继承（extends）父类中的注解

@Target的参数ElementType包括以下几种：

ElementType类型	解释
CONSTRUCTOR	构造器的声明
FIELD	域声明,包括enum实例（即，字段）
LOCAL_VARIABLE	局部变量声明
METHOD	方法声明
PACKAGE	包声明
PARAMETER	参数声明
TYPE	类、接口（包括注解类型）或enum声明

@Retention可选的RetentionPolicy参数包括：

RetentionPolicy	解释
SOURCE	注解将被编译器丢弃
CLASS	注解在class文件中可用，但会被VM丢弃（注解在源码和class文件中存在）
RUNTIME	VM将在运行期间也保留注解，因此可以通过反射机制读取注解的信息

自定义注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
    int id();
    String description() default "no description"
}

public class PasswordUtils {
    @UseCase(id = 47, description = "must contain at least one numeric")
    public void validatePassword(String password) {
        // TODO: 2016/12/21  
    }
}

注解可用的元素类型如下：所有基本类型（int，float等），String，Class，enum，Annotation，以上类型的数组
如果注解只有一个类型一般用value()命名，用value()命名的时候，使用注解不需要以价值对的形式给出值

注解解释器

使用Java的反射机制编写注解解释器读取注解的信息。
实例如下需求如下：使用注解创建数据库查询的过滤器。

// Table.java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    String value();
}

// Column.java
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    String value();
}

// Filter.java
@Table("users")
public class Filter {

    @Column("name")
    private String name;

    @Column("email")
    private String email;

    @Column("phone")
    private String phone;

    @Column("age")
    private int age;

    @Column("sex")
    private int sex;

    public String getName() {
        return name;
    }
    // 省略了其余的getter和setter方法
}

// Test.java
public class Test {

    public static void main(String[] args) {
        Filter f1 = new Filter();
        f1.setName("Akis");
        f1.setAge(22);

        Filter f2 = new Filter();
        f2.setName("xcc");
        f2.setSex(1);
        f2.setPhone("******");

        String sql1 = query(f1);
        String sql2 = query(f2);

        System.out.println(sql1);
        System.out.println(sql2);
    }


    public static String query(Filter filter) {
        StringBuilder sb = new StringBuilder();
        sb.append("SELECT * FROM ");

        Class c = filter.getClass();
        Table table = (Table) c.getAnnotation(Table.class);
        String tableName = table.value();
        sb.append(tableName).append(" WHERE 1 = 1");

        Field[] fields = c.getDeclaredFields();
        for (Field field : fields) {
            Column column = field.getDeclaredAnnotation(Column.class);
            String columnName = column.value();
            String methodName = "get" + field.getName().substring(0, 1).toUpperCase() + field.getName().substring(1);
            Object columnValue = null;
            try {
                Method method = c.getDeclaredMethod(methodName);
                columnValue = method.invoke(filter);
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
            if (columnValue instanceof String) {
                sb.append(" AND ").append(columnName).append("=").append("'").append(columnValue).append("'");
            } else if (columnValue instanceof Integer && (Integer)columnValue != 0) {
                sb.append(" AND ").append(columnName).append("=").append(columnValue);
            }
        }
        sb.append(";");
        return sb.toString();
    }
}

// output
SELECT * FROM users WHERE 1 = 1 AND name='Akis' AND age=22;
SELECT * FROM users WHERE 1 = 1 AND name='xcc' AND phone='******' AND sex=1;