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的拼接比較粗糙，各位能夠想一想有沒有其餘更爲高效的方法。

以上。