mybatis免sql插件之JpaMapper-以Jpa hib

2018-12-06 本文已影响19人逍遥天扬

mybatis免sql插件之JpaMapper-以Jpa hibernate的风格写mybatis（mybatis实现简单分表-sharding功能）

简介

JpaMapper以Jpa hibernate的风格写mybatis的代码，可以减少手动写sql的烦恼。

优势：

不替换底层实现，仅生成sql并交给mybatis
方法基本与Jpa hibernate相似，易于框架替换，当然，没那么厉害，不支持联表哦，项目还在继续完善中。
提供简单分表功能
逻辑简单，可以拿去自己定制
提供分页排序功能，最简单的方法实现分页！

gitee地址：https://gitee.com/ffch/JpaMapper

github地址：https://github.com/ffch/jpa-mapper

上篇介绍主键id生成策略和useGeneratedKeys无效的场景。这一篇将介绍如何使用mybatis做简单分表。

mybatis的bind

bind是什么

bind标签可以使用OGNL表达式创建一个变量并将其绑定到上下文中。大家都这样说。

为什么会有bind呢？

使用concat函数连接字符串，在MySQL中，这个函数支持多个参数，但是在Oracle中只支持两个参数。由于不同数据库之间的语法差异，如果更换了数据库，有些SQL语句可能就需要重写。针对这种情况，可以使用bind标签来避免由于更换数据库带来的一些麻烦。我们将上面的语句改为bind方式。大家都这样说。

bind示例

<if test=” userNarne != null and userNarne !=””>
<bind narne= " userNarneLike ” value ＝ ”’ 草 ’＋ userNarne ＋ ’ 每 ’” />
and user name like #{userNarneLike}
</if>

这里是用bind做了个简单的运算。

KeyGenerator是主键生成策略的接口，实现KeyGenerator的类主要有三个：

Jdbc3KeyGenerator，其实就是自增策略
NoKeyGenerator，顾名思义就是啥也没有。
SelectKeyGenerator，解析SelectKey注解定义的主键策略。

bind还能做分表

为了实现我们的分表（sharding）功能，我们需要思考sql语句怎样才能实现分表，因为mybatis只能根据我们的sql语句来进行CRUD，并不能做程序上的分表。

CUD操作只能是单表，所以注定我们的分表功能的CUD只能是单表，根据分表字段找到对应表，虽然功能并不是很强大，但足够大多数场景使用了。

R操作可以使用Union操作连接多个相同表的查询数据，因为我们可以将查询操作扩展到多表。当然，无法支持太复杂查询。

这里列出一个简单的Insert操作分表的示例：

@Insert({
    "<script>",
        "<bind name=\"tableName\" value=\"item.getIdentifyTable()\" />",
        "INSERT INTO ${tableName}",        "(chat_no,uid,opp_id,user_id,user_type,course_id,live_id,nickname,chat_time,chat_type,target_uid,content,create_time,update_time)",
        "values ",
        "(",
        "#{item.chatNo},",
        "#{item.uid},",
        "#{item.oppId},",
        "#{item.userId},",
        "#{item.userType},",
        "#{item.courseId},",
        "#{item.liveId},",
        "#{item.nickname},",
        "#{item.chatTime},",
        "#{item.chatType},",
        "#{item.targetUid},",
        "#{item.content},",
        "#{item.createTime},",
        "#{item.updateTime}",
        ")",
    "</script>"})

item是传入实体，getIdentifyTable方法将拿到我们想要的那个表。这里我们需要明确下$和#的区别：

$是连接，等于是字符串的操作，在生成sql语句之前

是指定参数，是在生成sql语句之后，等于将#指定的参数扔到？中。

所以，这里用${tableName}而不是#{tableName}

自定义分表

如果看了之前几篇文章介绍，你可能已经知道如何写出分表的Mapper了。

这里我们建立个SimpleShardingMapper，SimpleShardingMapper中定义好我们要实现的CRUD操作，因为是分表，就不要做太多花哨的功能，免得mybatis受不了。

我们可以自定义注解@ShardingKey：

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;


/**
 * @author cff
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
public @interface ShardingKey {
    String prefix() default "";
    String suffix() default "";
    
    //分表方法
    String methodRange() default "";
    String methodPrecis() default "";
}

methodRange指定处理between and 操作并生成多个表名。

methodPrecis用于指定精确的那个表名。

因为实体可能并不会传入方法中，所以我们不要建立成员方法，可以建静态方法。

这样指定表名的sql生成过程就可以写成：

ShardingEntity shardingEntity = jpaModelEntity.getShardingEntity();
StringBuilder sql = new StringBuilder();
sql.append("<bind name=\"pattern\" value=\"@");
sql.append(shardingEntity.getEntityFullName());
sql.append("@");
if(isSole){
    sql.append(shardingEntity.getMethodPrecis());
    sql.append("(");
    if(StringUtil.isNotEmpty(paramPrefix)){
        sql.append(paramPrefix);
        sql.append(".");
    }
    sql.append(shardingEntity.getFieldName());
}else{
    sql.append(shardingEntity.getMethodRange());
    sql.append("(");
    sql.append("start, end");
}
sql.append(")\" />");
return sql.toString();

有了表名，我们就可以在组装sql的时候用${tableName}动态指定了。

如果是多表，那就需要用foreach了
如：

<foreach collection ="pattern" item="item" index="index" separator=" union ">
</foreach>
pattern是表名的集合，foreach中间写查询语句，用union进行分隔，也可以用union all。

这篇大致介绍完了。

下篇先介绍下JpaMapper的详细功能和使用方法，后续再增加分页功能。

mybatis免sql插件之JpaMapper-以Jpa hib