Java - 注解使用示例（解析注解生成创建SQL表语句）

野性酷女 2022-05-31 10:58 481阅读 0赞

当你觉得你用反射的情况非常少的时候，通常就是因为注解接触的少。

--------------------

# 目的 #

使用注解来自动生成一个建数据库表的SQL命令。

# 注解 #

我们会创建如下的四个注解，用于进行数据库表，以及字段本身表述的注解。

1.  @DBTable 代表数据库表，注解元素name表示表名；
2.  @Constraints  
    代表对数据表每一列的条件补充，有primaryKey是不是主键，默认false，allowNull是否允许为空，默认true，unique数据是否唯一，默认false；
3.  @SQLString  
    代表表中的String列，注解元素value表示列长度，name表示列名，constraints表示对列的一些约束条件；
4.  @SQLInteger 代表表中的int列，name表示列名，constraints表示对列的一些约束条件；

## @DBTable ##

## @Constraints ##

package test1;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /** * Created by Joe on 2018/2/22. */
    
    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Constraints { 
        //主键约束
        boolean primaryKey() default false;
        //非空约束
        boolean allowNull() default false;
        //唯一约束
        boolean unique() default false;
    }

## @SQLString ##

package test1;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /** * Created by Joe on 2018/2/22. */
    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface SQLString { 
        int value() default 0;
    
        String name() default "";
        //@Constraints后没有括号表明使用默认值，可以加括号，在里面定义初始值，比如@Constraints（unique=true）
        Constraints constraints() default @Constraints;
    
    }

## @SQLInteger ##

package test1;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /** * Created by Joe on 2018/2/22. */
    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface SQLInteger { 
        String name() default "";
        Constraints constraints() default @Constraints;
    }

# 定义类，使用自定义注解进行标注 #

package test1;
    
    /** * Created by Joe on 2018/2/22. */
    @DBTable(name = "MEMBER")
    public class Member { 
        @SQLString(30) String firstName;
        @SQLString(50) String lastName;
        @SQLInteger int age;
        @SQLString(value = 30, constraints = @Constraints(primaryKey = true)) String handle;
        public String getFirstName() {
            return firstName;
        }
        public String getLastName() {
            return lastName;
        }
        public int getAge() {
            return age;
        }
        public String getHandle() {
            return handle;
        }
        public String toString() {
            return handle;
        }
    }

# 定义注解解析器，用于分析注解信息 #

package test1;
    
    import java.lang.annotation.Annotation;
    import java.lang.reflect.Field;
    import java.util.ArrayList;
    import java.util.List;
    
    /** * Created by Joe on 2018/2/22. */
    public class TableCreator { 
        public static void main(String[] args) throws Exception {
            //传入我们定义好的Bean类名，带上包名
            Class<?> cl = Class.forName("test1.Member");
            //检查我们传入的类是否带有@DBTable注解
            DBTable dbTable = cl.getAnnotation(DBTable.class);
            List<String> columnDefs = new ArrayList<String>();
            //得到类中的所有定义的属性
            for (Field filed : cl.getDeclaredFields()) {
                String columnName = null;
                //得到属性的注解，对一个目标可以使用多个注解
                Annotation[] anns = filed.getAnnotations();
                if (anns.length < 1) {
                    continue;
                }
                //SQLString注解走着
                if (anns[0] instanceof SQLString) {
                    SQLString sString = (SQLString) anns[0];
                    //name()使用的是默认值，所以这里取属性名
                    if (sString.name().length() < 1) {
                        columnName = filed.getName().toUpperCase();
                    } else {
                        columnName = sString.name();
                    }
                    //构建SQL语句
                    columnDefs.add(columnName + " VARCHAR(" + sString.value() + ")" + getConstraints(sString.constraints()));
                }
                //SQLInteger注解走着
                if (anns[0] instanceof SQLInteger) {
                    SQLInteger sInt = (SQLInteger) anns[0];
                    if (sInt.name().length() < 1) {
                        columnName = filed.getName().toUpperCase();
                    } else {
                        columnName = sInt.name();
                    }
                    columnDefs.add(columnName + " INT" + getConstraints(sInt.constraints()));
                }
            }
            StringBuilder creator = new StringBuilder("CREATE TABLE " + dbTable.name() + "( ");
            for (String c : columnDefs) {
                creator.append("\n" + c + ",");
            }
            creator.deleteCharAt(creator.length() - 1);
            creator.append(")");
            System.out.println(creator.toString());
        }
    
        private static String getConstraints(Constraints con) {
            String constraints = "";
            if (!con.allowNull()) {
                constraints += " NOT NULL";
            }
            if (con.primaryKey()) {
                constraints += " PRIMARY KEY";
            }
            if (con.unique()) {
                constraints += " UNIQUE";
            }
            return constraints;
        }
    }

# 运行结果 #

CREATE TABLE MEMBER( FIRSTNAME VARCHAR(30) NOT NULL, LASTNAME VARCHAR(50) NOT NULL, AGE INT NOT NULL, HANDLE VARCHAR(30) NOT NULL PRIMARY KEY)

--------------------

整理自： [http://blog.csdn.net/lb850747906/article/details/52145346][http_blog.csdn.net_lb850747906_article_details_52145346]

[http_blog.csdn.net_lb850747906_article_details_52145346]: http://blog.csdn.net/lb850747906/article/details/52145346