MyBatisPlus 与 Thymeleaf 全栈分页整合方案

2、示例表结构介绍

使用城市停水信息数据为例，重点介绍如何进行数据的分页展示。其表结构如下：

对应的实例数据如下：

二、Java 后台分页实现

本节结合 MybatisPlus 框架详细介绍在后台如何实现前端的分页需求。

1、实体类实现

实体的实现代码如下：

package org.yelang.pcwater.domain;
import java.io.Serializable;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@TableName(value = "biz_stop_water_info")
@NoArgsConstructor
@AllArgsConstructor
@Setter
@Getter
@ToString
public class StopWaterInfo implements Serializable {
    private static final long serialVersionUID = -1582687729349525826L;
    @TableId(value="pk_id")
    private Long pkId;
    @TableField(value = "affect_user")
    private String affectUser;
    @TableField(value = "affected_range")
    private String affectedRange;
    @TableField(value = "affect_region")
    private String affectRegion;
    @TableField(value = "created_on")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createdOn;
    @TableField(value = "inform_emergency_plan")
    private String informEmergencyPlan;
    @TableField(value = "inform_id")
    private Integer informId;
    @TableField(value = "inform_remark")
    private String informRemark;
    @TableField(value = "main_lead_path")
    private String mainLeadPath;
    private String position;
    private String reason;
    @TableField(value = "service_phone")
    private String servicePhone;
    @TableField(value = "show_end_date")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @SerializedName("showenddate")
    private Date showEndDate;
    @TableField(value = "stop_end_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date stopEndTime;
    @TableField(value = "stop_start_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date stopStartTime;
    @TableField(value = "stop_time")
    @SerializedName("stoptime")
    private String stopTime;
    @TableField(value = "stopwater_type")
    private String stopwaterType;
    @TableField(value = "supply_emergency_plan")
    private String supplyEmergencyPlan;
    @TableField(value = "supply_remark")
    private String supplyRemark;
    private String title;
    private String type;
    @TableField(value = "regin_name")
    private String reginName;
    @TableField(value = "sync_sno")
    private Long syncSno;
}

2、业务层分页实现

在业务接口中定义分页方法：

IPage<StopWaterInfo> page(Integer pageNum, Integer pageSize, String regionName);

具体实现逻辑如下：

@Override
public IPage<StopWaterInfo> page(Integer pageNum, Integer pageSize, String regionName) {
    QueryWrapper<StopWaterInfo> queryWrapper = new QueryWrapper<StopWaterInfo>();
    queryWrapper.like("regin_name", regionName);
    queryWrapper.orderByDesc("created_on");
    Page<StopWaterInfo> page = new Page<>(pageNum, pageSize);
    return this.baseMapper.selectPage(page, queryWrapper);
}

3、控制层实现

控制层接收前端提交的参数，调用业务层的分页方法，将结果回写给前端：

@PostMapping("/list")
@ResponseBody
public AjaxResult list(@RequestParam(defaultValue = "1") Integer pageNum,
                       @RequestParam(defaultValue = "5") Integer pageSize,
                       @RequestParam(defaultValue = "") String regionName) {
    IPage<StopWaterInfo> page = waterInfoService.page(pageNum, pageSize, regionName);
    AjaxResult result = AjaxResult.success();
    result.put("data", page);
    return result;
}

三、Thymeleaf 分页集成

Thymeleaf 是一种现代的 Java 模板引擎，能够很好地与 Spring Boot 集成。本节介绍如何在 Thymeleaf 中集成后端的分页应用，并且实现分页条。

1、分页表格展示

在 Html 中定义表格结构：

<div>
    <table>
        <thead>
            <tr>
                <th>创建时间</th>
                <th>停水地点</th>
                <th>原因</th>
            </tr>
        </thead>
        <tbody>
            <tr th:if="${#lists.isEmpty(waterEvents)}">
                <td colspan="3">请点击查询按钮加载数据。</td>
            </tr>
        </tbody>
    </table>
</div>

使用 ajax 的方式从后端加载相应的数据：

function renderTablePage(page) {
    currentPage = page;
    const tableBody = document.getElementById('table-body');
    tableBody.innerHTML = '';
    $.ajax({
        type:"post",
        url:ctx + "datasync/list",
        dataType:"json",
        cache:false,
        processData:true,
        data: {"pageNum":page,"pageSize":EVENTS_PER_PAGE,"regionName":""},
        success:function(result){
            const pageData = result.data.records;
            const totalPages = result.data.pages;
            if (pageData.length === 0) {
                tableBody.innerHTML = `<tr><td colspan="5">未找到符合条件的停水事件。</td></tr>`;
            } else {
                pageData.forEach(event => {
                    const row = tableBody.insertRow();
                    row.innerHTML = `
                        <td>${event.createdOn}</td>
                        <td>${event.position}</td>
                        <td>${event.reason}</td>
                    `;
                });
            }
            renderPagination(totalPages);
        },
        error:function(){
            tableBody.innerHTML = `<tr><td colspan="5">未找到符合条件的停水事件。</td></tr>`;
        }
    });
}

2、分页条集成

在 html 页面中定义分页标签：

<div>
    <nav aria-label="Table Pagination">
        <ul>
        </ul>
    </nav>
</div>

同步设置分页条：

function renderPagination(totalPages) {
    const paginationContainer = document.getElementById('table-pagination');
    paginationContainer.innerHTML = '';
    if (totalPages <= 1) return;
    paginationContainer.innerHTML += `
        <li ${currentPage === 1 ? 'disabled' : ''}>
            <a href="#" onclick="changePage(${totalPages},${currentPage - 1})" aria-label="Previous">前一页</a>
        </li>
    `;
    paginationContainer.innerHTML += `
        <li ${currentPage >= totalPages ? 'disabled' : ''}>
            <a href="#" onclick="changePage(${totalPages},${currentPage + 1})" aria-label="Next">后一页</a>
        </li>
    `;
}

3、成果展示

最终的成果展示如下图：

四、可能遇到的问题

1、分页不展示

如果你的应用截图显示数据全部加载且没有分页条，说明配置可能有问题。

2、问题解决

大概率是遇到了没有正确设置 Mybatis 的数据库分页插件的问题。解决的办法是在后台配置好分页插件即可。

package org.yelang.pcwater.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor i = new MybatisPlusInterceptor();
        i.addInnerInterceptor(new PaginationInnerInterceptor(DbType.POSTGRE_SQL));
        return i;
    }
}

配置好以上代码后，再次运行程序，即可成功出现分页条。