Hap 通用mapper初探

介绍

Hap框架的通用Mapper实现了对单表的增删改查,是在开源通用mapper(github地址)的基础上，添加了对多语言支持等功能，以适应Hap开发的需要。众所周知，MyBatis除了通过XML配置，还可以通过java注解来配置，通用mapper正是利用了MyBatis的SelectProvider、DeleteProvider等注解实现。

使用方法

自定义的mapper通过继承通用mapper，这样mapper就实现了通用mapper接口所用方法的复用，其中必须指定通用Mapper的泛型，这样就可以在service的实现类通过自定义mapper调用通用mapper接口中的所有方法，自定义mapper如下所示：

public interface CustomMapper extends Mapper<DTO> {
    ...
}

原理剖析

通用mapper接口通过多层的接口继承实现了方法的复用，其继承链如下图所示：

Mapper.png

最顶层的Mapper接口均包含一个与接口对应的方法，下面具体结合SelectByPrimaryMapper的selectByPrimaryKey方法分析通用mapper的实现原理，SelectProvider注解实现机制暂不予剖析，仅从通用mapper使用该注解的层次予以分析。

public interface SelectByPrimaryKeyMapper<T> {
    @SelectProvider(type = BaseSelectProvider.class, method = "dynamicSQL")
    T selectByPrimaryKey(Object key);
}

在selectByPrimaryKey方法上运用了SelectProvider注解,Mybatis官方文档对其解释如下：

这些可选的 SQL 注解（指SelectProvider, DeleteProvider, UpdateProvider, InsertProvider）允许你指定一个类名和一个方法在执行时来返回运行允许创建动态的 SQL。基于执行的映射语句, MyBatis 会实例化这个类,然后执行由 provider 指定的方法.type 属性是类。method 属性是方法名。引用自 Mybatis文档

在示例中，selectByPrimaryKey方法可以理解为由BaseSelectProvider类中的method属性对应的方法实现（在本例中methond属性指定的“dynamicSQL”，实际对应BaseSelectMapper的抽象父类MapperTemplate的dynamicSQL方法,返回“dynamicSQL”字符串），查看BaseSelectProvider源码可见，
所有方法均返回拼接好的SQL字符串。
以下代码截取自BaseSelectProvider.java:

// BaseSelectProvider.java
....
public String selectByPrimaryKey(MappedStatement ms) {
        final Class<?> entityClass = getEntityClass(ms);

        boolean isMl = EntityHelper.getEntityTable(entityClass).isSupportMultiLanguage();

        setResultType(ms, entityClass);
        StringBuilder sql = new StringBuilder();
        if (isMl) {
            sql.append(SqlHelper.selectAllColumns_TL(entityClass));
            sql.append(SqlHelper.fromTable_TL(entityClass, tableName(entityClass)));
            sql.append(SqlHelper.wherePKColumns_TL(entityClass));
        } else {
            sql.append(SqlHelper.selectAllColumns(entityClass));
            sql.append(SqlHelper.fromTable(entityClass, tableName(entityClass)));
            sql.append(SqlHelper.wherePKColumns(entityClass));
        }
        return sql.toString();
    }
...

这个方法接收一个MappedStatement对象（对应xml映射文件的一个<select/>或<insert/>等节点）。
getEntityClass方法返回了节点对应的DTO（通过自定义mapper的泛型获取）的类类型。
然后借助EntityHelper的getEntityTable方法获取DTO @Table的值,即DTO对应的表的信息的类，获取该表是否支持多语言信息（多语言信息的设置通过检查DTO是否有@MutibleLanguage注解实现）。
通过条件语句根据是否支持多语言返回拼接的不同字符串，为简化分析，以不支持多语言的表分析。
第一步，创建了一个名为sql的StringBuilder类用来拼接字符串用于返回。
第二步，拼接字符串。拼接的sql字符串由三个部分组成，这三个部分均通过SqlHelper的方法返回，返回类型均为字符串。分别为：

字段。SqlHelper.selectAllColumns(entityClass)
表。SqlHelper.fromTable(entityClass, this.tableName(entityClass))
限定条件。SqlHelper.whereAllIfColumns(entityClass, this.isNotEmpty())

// SqlHelper.java
...
public static String getAllColumns(Class<?> entityClass) {
        Set<EntityColumn> columnList = EntityHelper.getColumns(entityClass);
        StringBuilder sql = new StringBuilder();
        Iterator var3 = columnList.iterator();

        while(var3.hasNext()) {
            EntityColumn entityColumn = (EntityColumn)var3.next();
            sql.append(entityColumn.getColumn()).append(",");
        }

       // 返回字符串形式如下"column1,column2,column3 ..."
        return sql.substring(0, sql.length() - 1);
    }
public static String selectAllColumns(Class<?> entityClass) {
        StringBuilder sql = new StringBuilder();
        sql.append("SELECT ");
        sql.append(getAllColumns(entityClass));
        sql.append(" ");

       // 返回字符串形式如下 "select column1, solumn2, column3"
        return sql.toString();
    }
...

以获取字段为例，主要通过EntityHelper的getColumns方法获取所有字段的集合，然后遍历集合，返回所有的字段拼接的字符串表示，最后与"select"、""拼接到一起并返回。
第三步，返回拼接好的select语句。

总结

通用Mapper的实现主要通过MyBatis的Provider注解，本质上是一个通过泛型和注解动态获取表的信息，拼接sql字符串的过程。