Java利用自定义注解、反射实现简单BaseDao

在常见的ORM框架中，大都提供了使用注解方式来实现entity与数据库的映射，这里简单地使用自定义注解与反射来生成可执行的sql语句。

这是整体的目录结构，本来是为复习注解建立的项目^.^

好的，首先我们来确定思路。

1.  自定义@Table @Column注解，

我们稍微模仿hibernate，让@Table作用于类上，来表明实体类与数据表的映射关系，且让@Table中的属性value映射为数据表的名称tableName；让@Column作用于属性上（这里没实现作用于set方法上），表明属性与数据表字段的映射关系，且让@Column中的属性value映射为数据表的某个字段columnName。

2.  我们需要模仿一个Dao层，

这个时候我们先定义一个实体User，具有name和password属性，然后定义一个UserDao，UserDao中存在一个save（User user）的方法，当我们实例化一个UserDao和User，我们调用UserDao的save方法，传入我们的User对象，返回一段sql，这段sql我们将它简单设定为“insert into user (name,password) VALUES('cai','123456')”，其中user为我们的数据表名称，name,password为数据表字段，'cai','123456'为User对象的属性。

--------------------------------0.0代码分割线----------------------------------------------

//Column.java

package com.shu.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

//Table.java

package com.shu.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Table {
    String value();

}

//User.java

package com.shu.entity;
import com.shu.annotation.Column;
import com.shu.annotation.Table;

@Table("t_user")
public class User {

    @Column("name")
    private String name;
    @Column("password")
    private String password;

    public String getName() {
        return name;
    }
    public String getPassword() {
        return password;
    }
    public void setName(String name) {
        this.name = name;
    }
    public void setPassword(String password) {
        this.password = password;
    }

}

//IBaseDao.java

package com.shu.dao;
import java.lang.reflect.Field;

import com.shu.annotation.Column;
import com.shu.annotation.Table;

public interface IBaseDao<T> {

    //最终目标：insert into user (NAME,password) VALUES('cai','123456');
    default String save(T entity) throws IllegalArgumentException, IllegalAccessException{
        //sql用于存放最终返回的sql语句
        StringBuilder sql = new StringBuilder("insert into ");
        //tableName用于存放sql语句中表名部分
        StringBuilder tableName;
        //columnName用于存放sql语句的字段部分
        StringBuilder columnName = new StringBuilder("(");
        //values用于存放sql语句中的赋值部分
        StringBuilder values = new StringBuilder("(");
        //获取对象user的class对象
        Class clazz = entity.getClass();
        //判断该User类是否有@Table注解
        boolean isTable = clazz.isAnnotationPresent(Table.class);
        if(isTable) {
            //获取User类@Table注解的值value，该值我们定义为User表的表名称
            Table t = (Table) clazz.getAnnotation(Table.class);
            tableName = new StringBuilder(t.value());
            //拼接表名
            sql.append(tableName+" ");
            //获取user对象的属性列表
            Field[] fieldList = clazz.getDeclaredFields();
            //遍历属性列表，分别拿出属性列表中被@Column注解的属性，并获取属性的值
            for(int i=0;i<fieldList.length;i++){
                Field f =  fieldList[i];
                boolean isColumn = f.isAnnotationPresent(Column.class);
                if(!isColumn){
                    continue;
                }
                Column column = f.getAnnotation(Column.class);
                 f.setAccessible(true);
                Object columnValue = f.get(entity);
                if(i==fieldList.length-1){
                    columnName.append(column.value()+") VALUES ");
                    values.append("'"+columnValue+"')");
                    sql.append(columnName);
                    sql.append(values);
                    continue;
                }
                columnName.append(column.value()+", ");
                values.append("'"+columnValue+"',");
            }

//            boolean isColumn = clazz.isAnnotationPresent(annotationClass);
        }
        return sql.toString();
    }

}

//UserDao.java

package com.shu.dao;

import com.shu.entity.User;

public class UserDao implements IBaseDao<User> {

}

//UserService.java

package com.shu.service;
import com.shu.dao.UserDao;
import com.shu.entity.User;

public class UserService {

    public static void main(String[] args) {
        // TODO Auto-generated constructor stub
        UserDao userDao = new UserDao();
        User user = new User();
        user.setName("cai");
        user.setPassword("123456");
        try {
            System.out.println(userDao.save(user));
        } catch (IllegalArgumentException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}

--------------------------------0.0代码分割线----------------------------------------------

在这里我们最后定义了一个Service层，让它去调用dao层然后生成对应的sql语句，你可以自定义其他的Entity，比如我目录中的Order，然后定义一个OrderDao实现IBaseDao接口，定义一个OrderService调用OrderDao的save方法，同样可以生成order表对应的sql语句。

这里总结一下不足：

1.hibernate的注解可以不用赋值，所以我认为要实现无需赋值直接获取表的名称或者字段的名称，可以利用反射的方法来获取。

2.这里只做了save方法，而且只是动态生成了sql语句，并没有和数据库交互，可以包装一个factory，提供持久化方法来实现对sql语句的执行。

3.这里对sql的拼接比较粗糙，各位可以想想有没有其他更为高效的方法。

以上。