自己设计一个-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); 
  }
  // 调用通用查问将