MyBatis-Plus 编写SQL语句实现多表条件分页查询

MyBatis-Plus实现多表分页条件查询

MyBatis-Plus在单表简单的CRUD操作上十分便捷，但当涉及到复杂的多表间的联合查询，而且还要携带条件的情况下，就会显得无从下手，一般情况下我们可以在service层写大量的代码逻辑达到多表条件查询的要求，当然也可以手写sql语句，这样更加方便。

本文主要介绍如何通过手写sql语句实现多表分页条件查询。

表关系

我们现在有三张表：user、teacher、student

---

user:

id

username

password

real_name

…

---

teacher:

id

user_id

…

---

student:

id

user_id

teacher_id
…

---

其中，user表中的real_name为用户的真实姓名，teacher表以及student表中的user_id代表该teacher或student所对应的user的id

现在，我们希望根据学生姓名模糊查询到所有符合条件的学生的id、姓名、以及所属教师的姓名。那么必须要进行多表的查询。

先写出上述结果所对应的SQL语句：

select 
	s.id,
	u1.real_name as student_name,
	u2.real_name as teacher_name
from 
	student s 
	left join teacher t on t.id = s.teacher_id
	left join user u1 on u1.id = s.user_id
	left join user u2 on u2.id = t.user_id
where 
	u1.real_name like '%<condition>%'

注意此处使用了两次user表，u1对应的是学生的用户表，u2对应的是教师的用户表，并且均使用了left join，为了确保所有的学生（包括没有teacher_id的学生）都被查询到。

写完了sql语句，接下来需要做的就是将sql语句应用到项目中，将sql语句的查询结果用Java的方式保存——即封装为一个实体类。

实体类

我们先创建这样一个实体类作为查询返回结果的接收对象：

@Data
public class StudentResVo{
    private Long id;
    private String studentName;
    private String teacherName;
}

然后再创建一个查询的条件类作为前端传递的参数的接收对象：

public class StudentQueryVo{
    private String keyword;
}

创建完这两个类后，我们开始按照controller-service-mapper的顺序编写代码逻辑。

controller层

//controller
@RequestMapping("xxx")
@RestController
public class StudentController{
    @Autowired
    private StudentService service;
    ...
    @GetMapping("{current}/{size}")
    public IPage<StudentResVo> queryPageList(
    	@PathVariable("current") Long current,
        @PathVariable("size") Long size,
        StudentQueryVo vo
    ){
        // 创建page对象
        Page<StudentResVo> pageParam = new Page<>(current, size);
        // 调用service层的方法
        IPage<StudentResVo> pageModel = service.queryPageList(vo, pageParam);
        return pageModel;
    }
    ...
}

值得一提的是，分页功能是调用MyBatis-Plus插件通过AOP方式实现的，只需要传递分页的参数（current和size），不需要编写任何的代码逻辑。

// MyBatis-Plus分页插件配置
@Configuration
@MapperScan("xxx.xxx")
public class MybatisPlusConfig {

    /**
     * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

接来下我们编写service层的逻辑：

service层

// 接口
public interface StudentService extends IService<Student>{
    ...
    IPage<StudentResVo> queryPageList(StudentQueryVo vo, Page<StudentResVo> pageParam);
    ...

}
// 实现类
@Service
public class StudentServiceImpl 
    extends ServiceImpl<StudentMapper, Student> 
    implements StudentService {
    ...
    @Override
    public IPage<StudentResVo> queryPageList(StudentQueryVo vo, Page<StudentResVo> pageParam) {
        // 检查查询条件
        if (vo != null && vo.getKeyword() != null) {
            vo.setKeyword(vo.getKeyword().trim());
        }
        // 调用mapper层的方法
        return baseMapper.queryPageList(pageParam, vo);
    }
    ...

}

最后在mapper层定义并在xml文件中编写sql语句实现方法：

mapper层

@Mapper
public interface StudentMapper extends BaseMapper<Student>{
    ...
    IPage<StudentResVo> queryPageList(Page<StudentResVo> pageParam, @Param("vo") StudentQueryVo vo);
    ...
}

在xml文件中编写SQL语句

<select id="queryPageList" resultType="StudentResVo">
    select 
        s.id,
        u1.real_name as student_name,
        u2.real_name as teacher_name
    from 
        student s 
        left join teacher t on t.id = s.teacher_id
        left join user u1 on u1.id = s.user_id
        left join user u2 on u2.id = t.user_id
    where 
    	s.is_deleted = 0 and t.is_deleted = 0 # 需要手动添加逻辑删除条件
        <if test="vo.keyword != null and vo.keyword != ''">
            and u1.real_name like concat('%',#{vo.keyword},'%')
        </if>
</select>

至此，就在MyBatis中完成多表的条件查询操作了。

总结

MyBatis的工作说到底就是ORM（对象关系映射），
一般的单表用实体类映射，表中的字段与类中的属性相对应；
而多表查询出来的结果也需要有一个对应的类与之映射，这时候我们就要根据实际情况创建一个对象接收查询出来的结果，并且也不能直接套用Mybatis自动生成的方法，而是需要自己声明方法并在xml文件中编写SQL语句实现来处理。