mybatis plus多表查询的扩展

精选原创

虾王之王 2024-09-14 21:53:05 ©著作权

文章标签 MybatisPlus Join MPJ Mybatis 多表查询 Springboot 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者虾王之王的原创作品，请联系作者获取转载授权，否则将追究法律责任

mybatis plus提供了简单的CURD操作，但是有时我们的业务需要要求进行多表查询，这个时候，我们就需要加入多表查询的扩展了。

mybatis-plus-join，基于mybatis-plus的所有优点，然后还支持连表查询，还支持一对多，一对一的查询。

mybatis-plus-join是mybatis plus的一个多表插件，上手简单，几分钟就能学会全部使用方式。行了废话不多说直接看代码吧。

插件文档 MyBatis-Plus-Join

插件Github仓库

mybatis-plus-join: 支持连表查询的mybatis-plus体验！mybatis-plus风格的连表操作，提供 leftJoin、rightJoin、innerJoin连表操作 (gitee.com)

一、安装插件

在pom中添加依赖

<dependency>
    <groupId>com.github.yulichang</groupId>
    <artifactId>mybatis-plus-join-boot-starter</artifactId>
    <version>1.4.11</version>
</dependency>

二、Mapper

MybatisPlus Join提供了MPJBaseMapper，继承BaseMapper，继承了原本的功能提供了关联查询的功能。

将实体mapper有Mybatis plus的改成插件的

@Mapper
public interface UserMapper extends MPJBaseMapper<UserDO> {

}

三、使用方法

简单的连表查询

查询 user 表全部字段address表的 city、address字段

public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        MPJLambdaWrapper<User> wrapper = JoinWrappers.lambda(User.class)
                .selectAll(User.class)//查询user表全部字段
                .select(Address::getCity, Address::getAddress)
                .leftJoin(Address.class, Address::getUserId, User::getId);

        List<UserDTO> userList = userMapper.selectJoinList(UserDTO.class, wrapper);
    }
}

生成的sql

SELECT t.id,t.name,t.age,t.email,t2.city,t2.address FROM user t LEFT JOIN address t1 ON t1.user_id = t.id

通过以上几个简单的步骤，我们就实现了 User 表的连表功能，甚至连 XML 文件都不用编写！

从以上步骤中，我们可以看到集成MyBatis-Plus-Join非常的简单，只需要引入 starter 工程即可。

但 MyBatis-Plus-Join 的强大远不止这些功能，全部功能请参考插件文档 https://mybatisplusjoin.com

分页查询

mybatis plus join插件支持mybatis plus原生的插件

public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        MPJLambdaWrapper<User> wrapper = JoinWrappers.lambda(User.class)
                .selectAll(User.class)//查询user表全部字段
                .select(Address::getCity, Address::getAddress)
                .leftJoin(Address.class, Address::getUserId, User::getId);
  //分页查询 只需调用selectJoinPage方法,传入Mybatis Plus的page对象就行了
        Page<UserDTO> page = userMapper.selectJoinPage(new Page<>(1, 10), UserDTO.class, wrapper);
    }
}

对应sql

我这用的是Mysql,会添加 Limit, 分页插件会更具不同数据库拼接不同的分页方言

SELECT t.id,t.name,t.age,t.email,t2.city,t2.address FROM user t LEFT JOIN address t1 ON t1.user_id = t.id LIMIT ?

一对多查询

对多查询也很方便,只需调用selectCollection就行了, 对多查询需要List集合作为映射字段类型

public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        MPJLambdaWrapper<User> wrapper = JoinWrappers.lambda(User.class)
                .selectCollection(AddressDO.class, UserDTO::getAddressList)
                .leftJoin(Address.class, Address::getUserId, User::getId);
  
        List<UserDTO> list= userMapper.selectJoinList(UserDTO.class, wrapper);
    }
}

一对一查询

一对一查询和对多查询用法一模一样, 把selectCollection换成selectAssociation就行了, 映射字段就不能是集合了,改成对应的实体类或DTO类

public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        MPJLambdaWrapper<User> wrapper = JoinWrappers.lambda(User.class)
                .selectAssociation(AddressDO.class, UserDTO::getAddressDto)
                .leftJoin(Address.class, Address::getUserId, User::getId);
  
        List<UserDTO> list= userMapper.selectJoinList(UserDTO.class, wrapper);
    }
}

通过以上几个简单的步骤，我们就实现了 User 表的一对一和一对多功能，甚至连 XML 文件都不用编写！

插件还支持指定字段映射,指定别名映射,嵌套映射等强大的功能, 全部功能请参考插件文档 https://mybatisplusjoin.com