Java注解（2）-运行时框架

转载请注明本文出自远古大钟的博客（http://blog.csdn.net/duo2005duo），谢谢支持！

本文主要介绍如何使用Java运行时级别的注解配合反射来搭建框架，以下是构建sql表的简单例子虽然不能运用到实际中，但是阐明了搭建运行时框架的方法。源码已经上传至github，链接
如果你对注解的相关基础不了解，可以先阅读 Java注解（1）-基础

---

实现功能

先看一下要实现的效果，通过给数据类Bean添加相应的注解@Table ，@Column，就可以获取到创建表的sql语句

@Table(name="BeanTable") //注解@Table 具体实现接下来会讲
class Bean{
    @Column(name="field") //注解@Colomn 具体实现接下来会讲
    int field;
    @Column(name="description")
    String description;
}

public class Test{
    public static void main(String... args){
        //Utils类是我们需要定义的框架工具，接下来会讲
        System.out.println(Utils.createTable(Bean.class));
    }
}

执行输出

create table BeanTable(field interger,description text)

---

自定义注解

由于我们搭建的是运行时框架，需要再运行时通过反射来进行，所以注解的级别必须设置成Runtime级别，这样运行时才能反射到相应的注解
通过下面的定义，我们就能在运行时动态获取@Table与@Column两个注解与其对应的名称

• 定义对应表的注解

@Retention(RetentionPolicy.RUNTIME)
@interface Table{
    String name(); //name用来设置表名
}

• 定义对应字段的注解

@Retention(RetentionPolicy.RUNTIME)
@interface Column{
    String name(); //name用来设置字段名
}

---

运行时获取注解并转化

基础API

AnnotatedElement代表能够被注解的元素，如方法，成员变量，方法参数，包，类都是这个接口的实现，AnnotatedElement有方法如下表：

 T getAnnotation(Class annotationType) //获取注解在其上的annotationType
Annotation[] getAnnotations() //获取所有注解|
boolean isAnnotationPresent(Class annotationType) //判断当前元素是否被annotationType注解|
Annotation[] getDeclareAnnotations()// 与getAnnotations() 类似，但是不包括父类中被Inherited修饰的注解

getAnnotation返回的Annotation是注解的实例（例如上述Column与Table），从而我们可以获取到@Column或者@Table中name的值。

框架工具的实现

我们通过反射技术，运行时获取注解，从而得到Bean类对应的数据库的表的建表sql语句

获取表名

如下代码，先判断Bean类是否有注解@Table，如果有则获取@Table对象并得到name方法的值

    private static String getTableName(Class bean) {
        String name = null;
        //判断是否有Table注解
        if (bean.isAnnotationPresent(Table.class)) {
            //获取注解对象
            Table table = bean.getAnnotation(Table.class);
            name =table.name();
        }
        return name;
    }

获取字段名与类型

逐个分析Bean的成员变量是否有被@Column注解，有则获取其对应的字段名与类型

private static List getColumns(Class bean) {
        List columns = new ArrayList();
        Field[] fields = bean.getDeclaredFields();
        if (fields != null) {
            //分析Bean中的变量是否需要生成sql字段
            for (int i = 0; i < fields.length; i++) {
                Field field = fields[i];
                if (field.isAnnotationPresent(Column.class)) {
                    //生成sql字段的名
                    Column column = field.getAnnotation(Column.class);
                    String name=column.name();
                    //生成sql字段的类型
                    String type = null;
                    if (int.class.isAssignableFrom(field.getType())) {
                        type = "integer";
                    } else if (String.class.isAssignableFrom(field.getType())) {
                        type = "text";
                    } else {
                        throw new RuntimeException("unspported type=" + field.getType().getSimpleName());
                    }
                    columns.add(new NameAndType(type, name));

                }

            }
        }
        return columns;
    }

生成建表sql语句

生成sql表语句比较简单，主要是把前两部份获取的表名与字段结合起来组合成sql语句

public static String createTable(Class bean) {
    String tableName = getTableName(bean);
    List columns = getColumns(bean);
    if (tableName != null && !tableName.equals("") && !columns.isEmpty()) {
        StringBuilder createTableSql = new StringBuilder("create table ");
        //加表名
        createTableSql.append(tableName);
        createTableSql.append("(");

        //加表中字段
        for (int i = 0; i < columns.size(); i++) {
            NameAndType column = columns.get(i);
            createTableSql.append(column.name);
            createTableSql.append(" ");
            createTableSql.append(column.type);
            // 追加下一个字段定义前需要添加逗号
            if (i != columns.size() - 1) {
                createTableSql.append(",");
            }
        }
        createTableSql.append(")");
        return createTableSql.toString();
    }

    return null;
}

---

优势与缺点

用运行时注解来搭建框架相对容易而且适用性也比较广，搭建的框架使用起来也比较简单。对象关系映射（英语：Object Relational Mapping，简称ORM，或O/RM，或O/R mapping）框架通常使用运行时注解来搭建，但是在此基础上的框架因为需要用到反射，其效率相对与不高。所以因为效率考虑，许多框架不使用运行时注解来搭建而是用源码级别注解来搭建，当然，使用源码级别框架也是有代价的，由于它只能在预编译期间生成额外代码而无法运行时反射操作，复杂度相对较高而且灵活性也相对较低。如何使用源码级别注解框架来搭建会在下一节Java注解（3）-源码级框架 介绍。