自己设计一个 JAVA + MyBatis 解析实体类多表通用查询

  • 首先想清楚实体类与数据表的映射关系, 如

    //那么我们需要先自定义如下几个注解
    
    //用于表示实体类对应的数据表
    @TableName(value = "数据表名") 
    //用于表示实体主键
    @TableId
    //用于表示字段为逻辑删除
    @TableLogic
  • 现在已经可以通过实体类描述一张数据表了,那么我们来想一下如何优雅的想一个使用方式吧

    • 首先我们需要表示查询的字段有哪些?如何表示呢?
    • 如何关联表
    • 如何定义查询条件
    • 排序
    • 如何分组等等
    • …(按需求添加功能)
    //那么我们需要定义一个查询描述的实体
    class MulSelect {
        MulSelect(selectColumns/*要查询的字段*/, Table ...tables/*用到的数据表*/);
        //条件查询 WhereCustomSegment 后面介绍
           WhereCustomSegment where(String table);
           //排序
        orderBy(String ...columns);
        //...
    }  
    class WhereCustomSegment {
        like(String column, String value);
        and(String column, String value);
        notLike(String column, String value);
        eq(String column, String value);
        //...数据库操作方法,这里不多写
    }
    //现在根据我们的需求已经粗略的定义了, 那么我们再想想如何优雅的使用吧。User: 用户表,Address:地址表, Orders: 订单表
    new MulSelect("user.user_id, user.user_name, address.detail, orders.orders_id, orders.orders_no", new User(), new Address(), new Orders());
    //这样我们好像已经表示了要查询的字段,要使用到的表,但是我想查询的字段用实体的Field,一张整表的字体我想直接用实体表示,那么我们再修改下使用方式吧
    new MulSelect("user.UserId, user.userName, address.detail, orders", new User(), new Address(), new Orders());
    
    //ok, 那么我们再想一下如何排序
    MulSelect.orderBy("user.userName", "orders.createAt asc", ...);
    //ok, 那么我们再想下如何使用查询吧
    multipleSelect
        .where("user")
        .like("userName", "whoareyou")
        .eq("userGender", 1)
        .where("address")
        .like("provice", "江苏")
        .where("orders")
        .like("ordersNo", "20200117")
    //哎呦,感觉不错哦,那么我们就开始按照我们希望的使用方式去实现吧
  • 很好,现在我们已经想好了怎么使用了,那么我们开始按照使用的思路去实现吧

    • 先来处理一下查询的字段和用到的表吧

      //虽然我们使用的时候是实体,但最终还是要解析sql的,那么我们需要想好解析成sql 时候所用到的东东,提前准备好
      class TableEntity {
          String tableName; //表的真正名称肯定是要的
          String nickName; //表名的重命名也是要的, 去掉真名的表的下划线的全英文字母  
          String idName; //表的主键名称肯定是要的
          String logicName; //上面定义了逻辑删除功能,所以这个逻辑删除也要
          List<String> entityColumns; //实体的字段
          List<String> tableColumns; //与实体字段一对一的数据表的字段
          Object entity; //与之相关的实体
      }
      //现在用到数据表实体已经定义好了,是不是要写个工具将传入的实体参数解析成 TableEntity 了呢
      class TableUtil {
          TableEntity toTableEntity(Object entity); //将实体解析成TableEntity
          //...
      }
      //已经有了数据表的描述,那么我们将selectColumns 解析成 sql 的 select 字段完全没有问题了吧
      //将 "user.UserId, user.userName, address.detail, orders" 解析
      // ',' 分割去空格, '.' 前后的替换为 nickName,'.' 后面替换为数据表的字段,单独的 orders 替换为 nickName.[every tableColumn]
      class TableUtil {
          TableEntity toTableEntity(Object entity); //将实体解析成TableEntity
          //添加一个工具来实现吧
          String toNativeSelectColumns(String SelectColumns);
      }
    • 那么我们再来看看如何实现表的连接吧

      /**
          传过来是这样的参数:  new User(), new Address(), new Orders()
          简单的约束弄: 找到 User 表的主键(@TableId) 字段的Field名, 匹配 Address中的 Filed名,找到了那么说明用此字段关联,同样的方式, 循环向后寻找即可找到所有关联。但是这样的简单的定义约束。user表的主键需要为user_id, address表的与user表关联的字段 必需也要叫user_id,关联的字段名必须取一样的名称,如果想不一样,可以使用注解,这里先不作介绍。
      */
      //那么工具类又新增方法, 这里只作Left Join
      class TableUtil {
          TableEntity toTableEntity(Object entity); //将实体解析成TableEntity
          //添加一个工具来实现吧
          String toNativeSelectColumns(String SelectColumns);
          //添加left join 方法
          List<String> toLeftJoin(Object ...entities);
      }
    • 现在已经解决了查找的字段与自动关联的问题,那么接下来是如何条件查询了, 前面我们已经定义了 WhereCustomSegment 类了,完善一个思路吧

      class WhereCustomSegment {
          public WhereCustomSegment(TableEntity ...tableEntities);  //构造,我们需要关于数据表的全部信息
          WhereCustomSegment where(String tableName);
      }
      //那么如何实现一个like 方法呢? 如:   like("userName", "whoareyou")
      //了解 myBatis 这段应该了 user.user_name like #{userName}, 按此救命我们将现在有信息解析为此就相当容易了
      stringBuffer
          .append(" ")
          .append(tableEntity.getNickName()) // 表的nick name
          .append(".") 
          .append(tableEntity.getTableColumns().get(tableEntity.getEntityColumns().indexOf(fieldName))) //通过field名称找到数据表中的字段
          .append(" ")
          .append("like ")//opreaction 操作 
          .append("#{parameter.")
          .append(key) // 不重复的key 如 userName
          .append("}");
      parameter.put(key, value); //将对应的key 和 value 存储起来,用于调xml时候作为参数传递过去
      //简易的思路就完成了
    • 现在已经准备好解析完成的sqlSegment了,那么我们要把他放在myBatis的Xml里,我们定义个MulSelectMapper.java && MulSelectMapper.xml

      //MulSelectMapper.java
      public interface MulSelectMapper {
          public List<Map<String, Object>> multiSelect(MulSelect param);
          //分页统计总数
          public Integer countMulSelect(MulSelect param);
      }
      //MulSelectMapper.xml
      <select id="mulSelect" parameterType="com.common.MulSelect" resultType="map">
          select distinct ${selectColumns} from ${masterTable}  
          <if test="join!=null">
              <foreach collection="join" index="index" item="item" separator=" " >
                  left join ${item}
              </foreach>
          </if>
          <where>
              ${sqlSegment}
          </where>
          <if test="groupBy!=null and groupBy!=''">
              group by ${groupBy}
          </if>
          <if test="orderBy!=null and orderBy!=''">
              order by ${orderBy}
          </if>
          <if test="start != null and end != null">
              limit #{start}, #{end}
          </if>
      </select>
    • 现在就差一个通用的service 来调用了 MultipleService.java

      public class MultipleService { 
          MultipleResult multipleSelect(MulSelect param); 
      }
      //调用通用查询将
  • OK,现在使用方法设计出来了, 核心的解析流程也出来了, 如何调也设计好了,那下章我们来一行一行去实现自己的通过查询吧

原文 

https://segmentfault.com/a/1190000023272105

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 自己设计一个 JAVA + MyBatis 解析实体类多表通用查询

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址