Mybatis Dynamic Query 框架整合

项目地址:https://github.com/wz2cool/mybatis-dynamic-query
文档地址:https://wz2cool.gitbooks.io/mybatis-dynamic-query-zh-cn/content/
博客文章:https://wz2cool.github.io/tags/Mybatis-Dynamic-Query/

初入JAVA

    因为工作关系,开始接触JAVA(但心中一直割舍不下我大.net)。一开始选择持久化框架的时候,同事选的是Mybatis,开始我还闹情绪,感觉应该选hibernate,因为以前用EntityFramework 感觉还不错。关键是入JAVA不久,算了就用Mybatis 吧,也算是误打误撞才有了这个动态查询框架。

Mybatis 震撼

    如果说hibernate是全自动的,那么Mybatis 就是半自动。Mybatis 比 hibernate 更强的在于他对sql 的控制更加好,hibernate 这些ORM 生成的sql 在调优的时候比较麻烦,当然你们可以说使用hibernate 照样可以写sql,嗯是可以的,但是把一块 sql 写到了code 里面而且还是String 类型, 以后改个什么字段找半天(如果有不对,请大家指出)。
    Mybatis 有个专门的 xml 文件放sql 语句,这个其实很不错,至少不用去code 里面找 sql。 其实 Mybatis 是提供了一些根据条件生成对应的sql 比如<if> <foreach> 标签。

动态查询框架初衷

    在实际应用Mybatis 的时候,我们同样遇到了问题,就是xml 接口数量爆炸的情况,而且XML 代码量大了,也不是非常好维护,XML 也是一种没有强类型的语言。 嗯 这个就是我们的框架建立的最初目的。
    灵感的爆发同样来自于我大.net, 其实你们如果用过RIA service 就知道 FilterDescriptor 哈哈,确实借鉴了一下 参考: https://msdn.microsoft.com/en-us/library/system.windows.controls.filterdescriptor(v=vs.91).aspx

框架解决了什么问题

  1. 不必写大量的代码在XML中,因为这些代码都是弱类型的。
  2. 筛选排序是被Java代码中维护,可以进行组合使用。
  3. 你的筛选排序是可以热更新的,在代码中想什么时候加就什么时候加。
  4. 你的筛选条件是可以被持久化的,可以作为配置保存下来。

框架基本组织

interface

一个实体的基本操作定义

@Mapper
public interface NorthwindDao {
    List<Product> getProductByDynamic(Map<String, Object> params);

    int insert(Map<String, Object> params);

    int update(Map<String, Object> params);

    int delete(Map<String, Object> params);
}

xml 基本格式

xml 中与之对应的实现

<!-- 增加 -->
<insert id="insert" parameterType="java.util.Map">
        ${insertExpression}
</insert>

<!-- 删除 -->
<delete id="delete" parameterType="java.util.Map">
        ${deleteExpression}
</delete>

<!-- 修改 -->
<update id="update" parameterType="java.util.Map">
        ${updateExpression}
</update>

<!-- 查询 -->
<select id="getProductByDynamic" parameterType="java.util.Map"
            resultType="com.github.wz2cool.dynamic.mybatis.db.model.entity.table.Product">
        SELECT * FROM product
        <if test="whereExpression != null and whereExpression != ''">WHERE ${whereExpression}</if>
        <if test="orderExpression != null and orderExpression != ''">ORDER BY ${orderExpression}</if>
</select>

参数Map里面是什么

这里用一张图来说明

  1. 蓝色背景里面都是我们的动态表达式,注意里面参数都是占位符(比如 #{id_placeholder}).
  2. 绿色背景都是我们占位符的与之对应的实际数据

调用

简单写一个查询的例子

@Test
public void testEqual() throws Exception {
        FilterDescriptor idFilter =
                new FilterDescriptor(FilterCondition.AND, "productID", FilterOperator.EQUAL, 2);

        ParamExpression paramExpression = mybatisQueryProvider.getWhereExpression(ProductView.class, idFilter);
        Map<String, Object> queryParams = new HashMap<>();
        queryParams.putAll(paramExpression.getParamMap());
        queryParams.put("whereExpression", paramExpression.getExpression());

        ProductView productView =
                northwindDao.getProductViewsByDynamic(queryParams).stream().findFirst().orElse(null);
        assertEquals(Long.valueOf(2), productView.getProductID());
}

杂谈

  1. 在做这个框架也会去看别人写的Mybatis 框架,其中就有Mybatis-jpa,和博主交谈以后发现我这边少了 jdbcType 在insert和update中,果然和需要交流,当然这个会再1.0.2版本解决具体bug
  2. 在写文档的时候,有次推翻了原来的想法,坑啊,全部testCase 重写 T_T,坚持保持100%代码覆盖。
  3. 跨出开源第一步,代码、文档在一点点完善,虽然比不上大神的NB框架,至少第一步迈出去了。
  4. 希望大家多多关注,批评也可以,毕竟java 功底不深,欢迎指教。

文章整合

Mybatis Dynamic Query 简单筛选
Mybatis Dynamic Query 组筛选
Mybatis Dynamic Query 排序
Mybatis Dynamic Query 筛选+排序
Mybatis Dynamic Query 插入
Mybatis Dynamic Query 更新
Mybatis Dynamic Query 删除
Mybatis Dynamic Query 属性表达式
Mybatis Dynamic Query join视图

关注我 ##

最后大家可以关注我和 Mybatis-Dynamic-query项目 _
Follow @wz2cool Star Fork

posted @ 2017-08-01 15:43  wz2cool  阅读(1186)  评论(7编辑  收藏