众所周知,mybatis plus 封装的 mapper 不支持 join,如果需要支持就必须自己去实现。但是对于大部分的业务场景来说,都需要多表达 join,要不然就没必要采用关系型数据库了。
那么有没有一种不通过硬 SQL 的形式,通过框架提供 join 能力呢?答案是,可以有。经过一段时间的插眼排眼操作,成功地封装了一个 jar 包。本文讲讲它的用法。
使用方法
安装
Maven
com.github.yulichangmybatis-plus-join1.2.4
Gradle
implementation'com.github.yulichang:mybatis-plus-join:1.2.4'
或者 clone 代码到本地执行 mvn install,再引入以上依赖。
注意:mybatis plus version >= 3.4.0。
使用
mapper继承MPJBaseMapper (必选)
service继承MPJBaseService (可选)
serviceImpl继承MPJBaseServiceImpl (可选)
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能。
项目地址:https://github.com/YunaiV/ruoyi-vue-pro
核心类 MPJLambdaWrapper和MPJQueryWrapper
MPJLambdaWrapper用法
简单的三表查询
classtest{@Resource private UserMapper userMapper; void testJoin() { List list = userMapper.selectJoinList(UserDTO.class,new MPJLambdaWrapper() .selectAll(UserDO.class).select(UserAddressDO::getTel) .selectAs(UserAddressDO::getAddress, UserDTO::getUserAddress) .select(AreaDO::getProvince, AreaDO::getCity) .leftJoin(UserAddressDO.class,UserAddressDO::getUserId,UserDO::getId).leftJoin(AreaDO.class,AreaDO::getId,UserAddressDO::getAreaId).eq(UserDO::getId,1) .like(UserAddressDO::getTel,"1") .gt(UserDO::getId,5)); }}
对应sql
SELECTt.id, t.name, t.sex, t.head_img, t1.tel, t1.addressASuserAddress, t2.province, t2.cityFROMusertLEFTJOINuser_address t1ONt1.user_id = t.idLEFTJOINarea t2ONt2.id = t1.area_idWHERE( t.id = ?ANDt1.telLIKE?ANDt.id > ?)
说明:
UserDTO.class 查询结果返回类(resultType)
selectAll() 查询指定实体类的全部字段
select() 查询指定的字段,支持可变参数,同一个select只能查询相同表的字段 故将UserAddressDO和AreaDO分开为两个select()
selectAs() 字段别名查询,用于数据库字段与业务实体类属性名不一致时使用
leftJoin() 参数说明 第一个参数: 参与连表的实体类class 第二个参数: 连表的ON字段,这个属性必须是第一个参数实体类的属性 第三个参数: 参与连表的ON的另一个实体类属性
默认主表别名是t,其他的表别名以先后调用的顺序使用t1,t2,t3....
条件查询,可以查询主表以及参与连接的所有表的字段,全部调用mp原生的方法,正常使用没有sql注入风险
MPJLambdaWrapper 还有很多其他的功能
简单的SQL函数使用:https://gitee.com/best_handsome/mybatis-plus-join/wikis/selectFunc()?sort_id=4082479
ON语句多条件支持:https://gitee.com/best_handsome/mybatis-plus-join/wikis/leftJoin?sort_id=3496671
分页查询
classtest{@ResourceprivateUserMapper userMapper; void testJoin() { IPage iPage = userMapper.selectJoinPage(new Page<>(2,10), UserDTO.class,new MPJLambdaWrapper() .selectAll(UserDO.class).select(UserAddressDO::getTel) .selectAs(UserAddressDO::getAddress, UserDTO::getUserAddress) .select(AreaDO::getProvince, AreaDO::getCity) .leftJoin(UserAddressDO.class,UserAddressDO::getUserId,UserDO::getId).leftJoin(AreaDO.class,AreaDO::getId,UserAddressDO::getAreaId));}}
对应sql
SELECTt.id, t.name, t.sex, t.head_img, t1.tel, t1.addressASuserAddress, t2.province, t2.cityFROMusertLEFTJOINuser_address t1ONt1.user_id = t.idLEFTJOINarea t2ONt2.id = t1.area_idLIMIT?,?
MPJQueryWrapper
简单的3表查询
classtest{@ResourceprivateUserMapper userMapper; void testJoin() { List list = userMapper.selectJoinList(UserDTO.class,new MPJQueryWrapper() .selectAll(UserDO.class).select("addr.tel","addr.address","a.province") .leftJoin("user_address addr on t.id = addr.user_id") .rightJoin("area a on addr.area_id = a.id") .like("addr.tel","1") .le("a.province","1")); }}
对应 sql
SELECTt.id, t.name, t.sex, t.head_img, addr.tel, addr.address, a.provinceFROMusertLEFTJOINuser_address addront.id = addr.user_idRIGHTJOINarea aonaddr.area_id = a.idWHERE( addr.telLIKE?ANDa.province <= ?)
说明:
UserDTO.class 查询结果类(resultType)
selectAll(UserDO.class) 查询主表全部字段(主表实体类)默认主表别名 "t"
select() mp的select策略是覆盖,以最后一次为准,这里的策略是追加,可以一直select 主表字段可以用lambda,会自动添加表别名,主表别名默认是 t ,非主表字段必须带别名查询
leftJoin() rightJoin() innerJoin() 传sql片段 格式 (表 + 别名 + 关联条件)
条件查询,可以查询主表以及参与连接的所有表的字段,全部调用mp原生的方法,正常使用没有sql注入风险
分页查询
classtest{@Resource private UserMapper userMapper; void testJoin() { IPage page = userMapper.selectJoinPage(newPage<>(1,10), UserDTO.class,newMPJQueryWrapper() .selectAll(UserDO.class).select("addr.tel","addr.address") .select("a.province") .leftJoin("user_address addr on t.id = addr.user_id") .rightJoin("area a on addr.area_id = a.id")); }}
对应sql
SELECTt.id, t.name, t.sex, t.head_img, addr.tel, addr.address, a.provinceFROMusertLEFTJOINuser_address addront.id = addr.user_idRIGHTJOINarea aonaddr.area_id = a.idLIMIT?,?
还可以这么操作,但不建议
classtest{@ResourceprivateUserMapper userMapper; void testJoin() { List list = userMapper.selectJoinList(UserDTO.class,new MPJQueryWrapper() .selectAll(UserDO.class).select("addr.tel","addr.address")//行列转换.select("CASE t.sex WHEN '男' THEN '1' ELSE '0' END AS sex")//求和函数.select("sum(a.province) AS province")//自定义数据集.leftJoin("(select * from user_address) addr on t.id = addr.user_id") .rightJoin("area a on addr.area_id = a.id") .like("addr.tel","1") .le("a.province","1") .orderByDesc("addr.id")); }}
对应sql
SELECTt.id, t.name, t.sex, t.head_img, addr.tel, addr.address,CASEt.sexWHEN'男'THEN'1'ELSE'0'ENDASsex,sum(a.province)ASprovinceFROMusertLEFTJOIN(select*fromuser_address) addront.id = addr.user_idRIGHTJOINarea aonaddr.area_id = a.idWHERE( addr.telLIKE?ANDa.province <= ?)ORDERBYaddr.idDESC
针对以上 jar 感兴趣的,可以下载对应的源码,进一步地学习!