MyBatis - 手写ORM框架 - 《编程知识库》

什么是ORM框架？
手撸ORM框架

什么是ORM框架？

ORM全称为：Object Relational Mapping，翻译成中文就是：对象关系映射。也就是说ORM框架就是对象关系映射框架，它通过元数据描述对象与关系映射的细节，ORM框架在运行的时候，可以根据对应与映射之间的关系将数据持久化到数据库中。
其实，从本质上讲，ORM框架主要实现的是程序对象到关系数据库数据的映射。说的直白点：ORM框架就是将实体和实体与实体之间的关系，转化为对应的SQL语句，通过SQL语句操作数据库，将数据持久化到数据库中，并且对数据进行相应的增删改查操作。
最常用的几种ORM框架为：MyBatis、Hibernate和JFinal。

手撸ORM框架

@Table注解的实现

首先，我们创建一个io.mykit.annotation.jdk.db.providerJava包，在这个Java包创建一个@Table注解，@Table注解标注在Java类上，表示当前类会被映射到数据库中的哪张数据表上，如下所示。

package io.mykit.annotation.jdk.db.provider;
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;
/**
 * 自定义Table注解
 * @author binghe
 *
 */
@Inherited
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Table {
 String value() default "";
}

@Column注解的实现

同样的，在io.mykit.annotation.jdk.db.provider包下创建一个@Column注解，@Column注解标注在类中的字段上，表示当前类中的字段映射到数据表中的哪个字段上，如下所示。

package io.mykit.annotation.jdk.db.provider;
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;
/**
 * 自定义Column注解
 * @author binghe
 *
 */
@Inherited
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
 String value() default "";
}

看到这里，不管是使用过MyBatis的小伙伴还是使用过Hibernate的小伙伴，应该都会有所体会吧？没错，@Table注解和@Column注解，不管是在MyBatis框架还是Hibernate框架中，都会被使用到。这里，我们在收录极简版ORM框架时，也使用了这两个经典的注解。

创建实体类

在io.mykit.annotation.jdk.db.provider.entity包下创建实体类User，并且@Table注解和@Column注解会被分别标注在User类上和User类中的字段上，将其映射到数据库中的数据表和数据表中的字段上，如下所示。

package io.mykit.annotation.jdk.db.provider.entity;
import io.mykit.annotation.jdk.db.provider.Column;
import io.mykit.annotation.jdk.db.provider.Table;
/**
 * 自定义使用注解的实体
 * @author binghe
 *
 */
@Table("t_user")
public class User implements Serializable{
 @Column("id")
 private String id;
 @Column("name")
 private String name;
 public User() {
  super();
 }
 public User(String id, String name) {
  super();
  this.id = id;
  this.name = name;
 }
 public String getId() {
  return id;
 }
 public void setId(String id) {
  this.id = id;
 }
 public String getName() {
  return name;
 }
 public void setName(String name) {
  this.name = name;
 }
 @Override
 public String toString() {
  return "User [id=" + id + ", name=" + name + "]";
 }
}

注解解析类的实现

在io.mykit.annotation.jdk.db.provider.parser包中创建一个AnnotationParser类，AnnotationParser 类是整个框架的核心，它负责解析标注在实体类上的注解，并且将对应的实体类及其字段信息映射到对应的数据表和字段上，如下所示。

package io.mykit.annotation.jdk.db.provider.parser;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import io.mykit.annotation.jdk.db.provider.Column;
import io.mykit.annotation.jdk.db.provider.Table;
/**
 * 解析自定义注解
 * @author binghe
 *
 */
public class AnnotationParser {
 /** 
     * 通过注解来组装查询条件，生成查询语句 
     * @param obj 
     * @return 
     */  
    public static String assembleSqlFromObj(Object obj) {  
        Table table = obj.getClass().getAnnotation(Table.class);  
        StringBuffer sbSql = new StringBuffer();  
        String tableName = table.value();  
        sbSql.append("select * from " + tableName + " where 1=1 ");  
        Field[] fileds = obj.getClass().getDeclaredFields();  
        for (Field f : fileds) {  
            String fieldName = f.getName();  
            String methodName = "get" + fieldName.substring(0, 1).toUpperCase()  
                    + fieldName.substring(1);  
            try {  
                Column column = f.getAnnotation(Column.class);  
                if (column != null) {  
                    Method method = obj.getClass().getMethod(methodName);  
                    Object v = method.invoke(obj);  
                    if (v != null) {  
                        if (v instanceof String) {  
                         String value = v.toString().trim();
                            // 判断参数是不是 in 类型参数 1,2,3  
                            if (value.contains(",")) {  
                             //去掉value中的,
                             String sqlParams = value.replace(",", "").trim();
                             //value中都是纯数字
                             if(isNum(sqlParams)){
                              sbSql.append(" and " + column.value() + " in (" + value + ") ");  
                             }else{
                              String[] split = value.split(",");
                              //将value重置为空
                              value = "";
                              for(int i = 0; i < split.length - 1; i++){
                               value += "'"+split[i]+"',";
                              }
                              value += "'"+split[split.length - 1]+"'";
                              sbSql.append(" and " + column.value() + " in (" + value + ") ");  
                             }
                            } else {  
                             if(value != null && value.length() > 0){
                              sbSql.append(" and " + column.value() + " like '%" + value + "%' ");  
                             }
                            }  
                        } else {
                            sbSql.append(" and " + column.value() + "=" + v.toString() + " ");  
                        }  
                    }  
                }  
            } catch (Exception e) {  
                e.printStackTrace();  
            }  
        }  
        return sbSql.toString();  
    }  
    /** 
     * 检查给定的值是不是 id 类型 1.检查字段名称 2.检查字段值 
     *  
     * @param target 
     * @return 
     */  
    public static boolean isNum(String target) {  
        boolean isNum = false;  
        if (target.toLowerCase().contains("id")) {  
            isNum = true;  
        }  
        if (target.matches("\\d+")) {  
            isNum = true;  
        }  
        return isNum;  
    }  
}

至此，我们的极简版ORM框架就实现好了，不过实现完还不行，我们还要对其进行测试验证。

测试类的实现

在io.mykit.annotation.jdk.provider包下创建AnnotationTest 类，用以测试我们实现的极简ORM框架的效果，具体如下所示。

package io.mykit.annotation.jdk.provider;
import org.junit.Test;
import io.mykit.annotation.jdk.db.provider.entity.User;
import io.mykit.annotation.jdk.db.provider.parser.AnnotationParser;
import io.mykit.annotation.jdk.provider.parser.AnnotationProcessor;
/**
 * 测试自定义注解
 * @author binghe
 *
 */
public class AnnotationTest {
 @Test
 public void testDBAnnotation(){
  User testDto = new User("123", "34");  
  User testDto1 = new User("123", "test1");  
  User testDto2 = new User("", "test1,test2,test3,test4");  
        String sql = AnnotationParser.assembleSqlFromObj(testDto);  
        String sql1 = AnnotationParser.assembleSqlFromObj(testDto1);  
        String sql2 = AnnotationParser.assembleSqlFromObj(testDto2);  
        System.out.println(sql);  
        System.out.println(sql1);  
        System.out.println(sql2);  
 }
}
运行测试

我们运行AnnotationTest#testDBAnnotation()方法，命令行会输出如下信息。
select from t_user where 1=1 and id like ‘%123%’ and name like ‘%34%’
select from t_user where 1=1 and id like ‘%123%’ and name like ‘%test1%’
select * from t_user where 1=1 and name in (‘test1’,’test2’,’test3’,’test4’)
可以看到，我们在测试程序中，并没有在测试类中传入或者执行任何SQL语句，而是直接创建User类的对象，并调用AnnotationParser#assembleSqlFromObj()进行解析，并且将对应的实体类对象转换为SQL语句返回。