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字符串的过程。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容

  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,429评论 0 4
  • 官方文档 简介 入门 XML配置 XML映射文件 动态SQL Java API SQL语句构建器 日志 一、 JD...
    拾壹北阅读 3,541评论 0 52
  • 1 引言# 本文主要讲解JDBC怎么演变到Mybatis的渐变过程,重点讲解了为什么要将JDBC封装成Mybait...
    七寸知架构阅读 76,424评论 36 980
  • 少年时痴迷武侠,很想有天被奇遇砸中,七经八脉秒通,由一个平淡无奇的姑娘,蜕化成宇宙超级美少女。 事隔多年,斗转星移...
    夏xiao安阅读 313评论 0 0
  • 陡峭的崖壁, 孑然承受着风的狂浪, 青丝乱舞, 在空中抓不住虚无。 她一袭黑色衣裙, 站在岌岌可危的崖边, 眸子里...
    喷子的面具阅读 235评论 0 0