使用 MyBatis 实现联表查询的分页功能

前言

在本教程中，我们将详细介绍如何使用 MyBatis 在 XML 文件中实现联表查询的分页功能，并将请求参数封装到一个 BO (Business Object) 对象中。这种方式不仅使代码更易于管理和维护，同时也提高了代码的可读性和可扩展性。

环境准备

1. Java 版本: 1.8+
2. Spring Boot 版本: 2.x
3. MyBatis 版本: 3.x
4. 数据库: MySQL

项目结构

我们将按照典型的三层架构（Controller、Service、DAO）来组织我们的代码。

步骤1: 添加依赖

确保你的项目中添加了 MyBatis 的相关依赖。如果你使用 Maven，可以在 pom.xml 文件中添加如下依赖：

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!-- Other dependencies -->
</dependencies>

步骤2: 配置数据库连接

在 application.properties 或 application.yml 文件中配置数据库连接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

步骤3: 创建实体类

假设我们有以下实体类：

User.java

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Long id;
    private String name;
    // Getters and Setters
}

UserRole.java

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserRole {
    private Long userId;
    private Long roleId;
    // Getters and Setters
}

Role.java

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Role {
    private Long id;
    private String roleName;
    // Getters and Setters
}

RoleVo.java (用于展示的视图对象)

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class RoleVo {
    private Long userId;
    private String roleName;
    // Getters and Setters
}

步骤4: 创建分页返回对象

我们先定义一个通用的分页返回对象 PageVO，它包含了一些基本的分页属性，如总记录数 (total)、每页显示的记录数 (size)、当前页码 (current) 和实际的数据列表 (records)。

PageVO.java

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

/**
 * 分页
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Schema(title = "分页")
public class PageVO<T> {

    /**
     * 总数
     */
    @Schema(title = "总数")
    private Long total;

    /**
     * 每页显示条数
     */
    @Schema(title = "每页显示条数")
    private Long size;

    /**
     * 当前页
     */
    @Schema(title = "当前页")
    private Long current;

    /**
     * 数据列表
     */
    @Schema(title = "数据列表")
    private List<T> records;

}

步骤5: 创建 BO 对象

接下来，我们需要创建一个 BO (Business Object) 对象来封装请求参数。

UserRoleQueryBO.java

package com.microsun.integrated.framework.domain;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 用户角色查询 BO
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Schema(title = "用户角色查询 BO")
public class UserRoleQueryBO {
    /**
     * 用户ID
     */
    @Schema(title = "用户ID")
    private Long userId;

    /**
     * 角色名称
     */
    @Schema(title = "角色名称")
    private String roleName;

    /**
     * 当前页码
     */
    @Schema(title = "当前页码")
    private Integer currentPage;

    /**
     * 每页数量
     */
    @Schema(title = "每页数量")
    private Integer pageSize;
}

步骤6: 创建 DAO 接口

在 DAO 层创建接口并定义分页查询方法：

UserMapper.java

package com.microsun.integrated.framework.mapper;

import com.microsun.integrated.framework.domain.RoleVo;
import com.microsun.integrated.framework.domain.UserRoleQueryBO;
import org.apache.ibatis.annotations.Param;

import java.util.List;

public interface UserMapper {
    /**
     * 联表查询实现分页，根据用户ID查询用户具有的角色列表
     * 把联表查询得到的数据当成一张单表来看
     *
     * @param bo 查询条件对象
     * @return 分页后的角色列表
     */
    List<RoleVo> getUlserListByMulTable(@Param("bo") UserRoleQueryBO bo);

    /**
     * 获取符合条件的角色列表的总数
     *
     * @param bo 查询条件对象
     * @return 角色列表的总数
     */
    int getUlserListCountByMulTable(@Param("bo") UserRoleQueryBO bo);
}

步骤7: 创建 XML 映射文件

创建对应的 XML 映射文件 UserMapper.xml，并在其中编写 SQL 查询语句：

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.microsun.integrated.framework.mapper.UserMapper">
    <select id="getUlserListByMulTable" resultType="com.microsun.integrated.framework.domain.RoleVo">
        select sr.role_name
        from sys_user su
        left join sys_user_role sur on su.id = sur.user_id
        left join sys_role sr on sur.role_id = sr.id
        where su.id = #{bo.userId}
        <if test="bo.roleName != null and bo.roleName != ''">
            and sr.role_name like concat('%', #{bo.roleName}, '%')
        </if>
        limit #{bo.pageSize} offset #{bo.currentPage} * #{bo.pageSize}
    </select>

    <select id="getUlserListCountByMulTable" resultType="int">
        select count(*)
        from sys_user su
        left join sys_user_role sur on su.id = sur.user_id
        left join sys_role sr on sur.role_id = sr.id
        where su.id = #{bo.userId}
        <if test="bo.roleName != null and bo.roleName != ''">
            and sr.role_name like concat('%', #{bo.roleName}, '%')
        </if>
    </select>
</mapper>

这里我们使用 <if> 标签来动态拼接 SQL 语句，并且通过 limit 子句来实现分页。

步骤8: 创建 Service 接口

定义 Service 接口：

UserService.java

package com.microsun.integrated.framework.service;

import com.microsun.integrated.framework.domain.PageVO;
import com.microsun.integrated.framework.domain.RoleVo;
import com.microsun.integrated.framework.domain.UserRoleQueryBO;

public interface UserService {
    /**
     * 获取用户角色列表
     *
     * @param bo 查询条件对象
     * @return 分页后的角色列表
     */
    PageVO<RoleVo> getUserRoleList(UserRoleQueryBO bo);
}

步骤9: 创建 Service 实现类

实现 Service 接口：

UserServiceImpl.java

package com.microsun.integrated.framework.service.impl;

import com.microsun.integrated.framework.domain.PageVO;
import com.microsun.integrated.framework.domain.RoleVo;
import com.microsun.integrated.framework.domain.UserRoleQueryBO;
import com.microsun.integrated.framework.mapper.UserMapper;
import com.microsun.integrated.framework.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public PageVO<RoleVo> getUserRoleList(UserRoleQueryBO bo) {
        // 调用方法获取总数
        int totalCount = userMapper.getUlserListCountByMulTable(bo);

        // 调用方法获取分页后的列表
        List<RoleVo> roleVos = userMapper.getUlserListByMulTable(bo);

        // 创建分页对象
        PageVO<RoleVo> pageVO = new PageVO<>();
        pageVO.setTotal((long) totalCount);
        pageVO.setSize((long) bo.getPageSize());
        pageVO.setCurrent((long) bo.getCurrentPage());
        pageVO.setRecords(roleVos);

        return pageVO;
    }
}

步骤10: 创建 Controller

创建 Controller 类来处理前端请求：

UserController.java

package com.microsun.integrated.framework.controller;

import com.microsun.integrated.framework.domain.PageVO;
import com.microsun.integrated.framework.domain.RoleVo;
import com.microsun.integrated.framework.domain.UserRoleQueryBO;
import com.microsun.integrated.framework.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/roles")
    public PageVO<RoleVo> getUserRoleList(
            @RequestParam(value = "currentPage", defaultValue = "1") int currentPage,
            @RequestParam(value = "pageSize", defaultValue = "10") int pageSize,
            @RequestParam(value = "userId", required = false) Long userId,
            @RequestParam(value = "roleName", required = false) String roleName) {

        UserRoleQueryBO bo = new UserRoleQueryBO();
        bo.setUserId(userId);
        bo.setRoleName(roleName);
        bo.setCurrentPage(currentPage);
        bo.setPageSize(pageSize);

        return userService.getUserRoleList(bo);
    }
}

步骤11: 测试

现在你可以启动 Spring Boot 应用并测试你的分页联表查询功能。可以通过发送 HTTP GET 请求到 /users/roles 来测试上述功能，例如：

• GET /users/roles?currentPage=1&pageSize=2&userId=1&roleName=admin
• GET /users/roles?currentPage=1&pageSize=2&userId=1

结论

通过本教程，我们成功地实现了使用 MyBatis 在 XML 文件中实现联表查询的分页功能，并将请求参数封装到一个 BO 对象中。这种方式不仅使代码更易于管理和维护，同时也提高了代码的可读性和可扩展性。