SpringBoot 整合 MyBatis Plus 基本使用和分页，FreeMarker分页渲染

avatar 2018年12月23日15:57:23 10 16987 views
博主分享免费Java教学视频，B站账号：Java刘哥 ，长期提供技术问题解决、项目定制：本站商品点此
本文主要介绍 MyBatis Plus 的使用，顺便讲一下分页。

MyBatis Plus 是基于MyBatis 做了层封装，只需要继承它的 BaseDao, 我们就不需要写很多简单的 CURD，而且mapper实现也不用写，可以说瞬间减轻了一部分工作量。而且它也自带分页插件，不需要再使用 PageHelper 了。

一、SpringBoot 2.0 整合 MyBatis Plus

  1. pom.xml
  1. <!-- mybatis-plus begin -->
  2.     <dependency>
  3.         <groupId>com.baomidou</groupId>
  4.         <artifactId>mybatisplus-spring-boot-starter</artifactId>
  5.         <version>1.0.5</version>
  6.     </dependency>
  7.     <dependency>
  8.         <groupId>com.baomidou</groupId>
  9.         <artifactId>mybatis-plus</artifactId>
  10.         <version>2.1.8</version>
  11.     </dependency>
  12.     <dependency>
  13.         <groupId>org.springframework.boot</groupId>
  14.         <artifactId>spring-boot-starter-jdbc</artifactId>
  15.     </dependency>
  16.      <!--mybatis-plus end-->



2. application.yml
  1. mybatis-plus:
  2.   mapper-locations: classpath*:/mapper/**Mapper.xml
  3.   #实体扫描，多个package用逗号或者分号分隔
  4.   typeAliasesPackage: com.liuyanzhao.sens.entity
  5.   global-config:
  6.     #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
  7.     id-type: 0
  8.     #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
  9.     field-strategy: 2
  10.     #驼峰下划线转换
  11.     db-column-underline: true
  12.     #刷新mapper 调试神器
  13.     refresh-mapper: true
  14.     #逻辑删除配置（下面3个配置）
  15.     logic-delete-value: 0
  16.     logic-not-delete-value: 1
  17.   configuration:
  18.     map-underscore-to-camel-case: true
  19.     cache-enabled: false

注意修改第二行的 xml 文件位置和第4行的实体包位置



3. 代码结构

注意关注 entity、mapper类 和 mapper.xml 位置，注意和上面的配置文件对应





4. MyBatis Plus 配置类
  1. package com.liuyanzhao.sens.config;
  3. import com.baomidou.mybatisplus.plugins.PaginationInterceptor;
  4. import com.baomidou.mybatisplus.plugins.PerformanceInterceptor;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  9. /**
  10.  * @author 言曌
  11.  * @date 2018/12/22 下午1:49
  12.  */
  14. @Configuration
  15. public class MybatisPlusConfig {
  17.     /***
  18.      * plus 的性能优化
  19.      * @return
  20.      */
  21.     @Bean
  22.     public PerformanceInterceptor performanceInterceptor() {
  23.         PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
  24.         /*<!-- SQL 执行性能分析，开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长 -->*/
  25.         performanceInterceptor.setMaxTime(1000);
  26.         /*<!--SQL是否格式化 默认false-->*/
  27.         performanceInterceptor.setFormat(true);
  28.         return performanceInterceptor;
  29.     }
  31.     /**
  32.      * mybatis-plus分页插件
  33.      */
  34.     @Bean
  35.     public PaginationInterceptor paginationInterceptor() {
  36.         return new PaginationInterceptor();
  37.     }
  40. }


二、开始使用


这里以日志类作为一个Demo演示，包含增删改查

1.实体
  1. package com.liuyanzhao.sens.entity;
  3. import com.baomidou.mybatisplus.annotations.TableId;
  4. import com.baomidou.mybatisplus.annotations.TableName;
  5. import com.baomidou.mybatisplus.enums.IdType;
  6. import lombok.Data;
  8. import java.io.Serializable;
  9. import java.util.Date;
  11. /**
  12.  * <pre>
  13.  *     操作日志
  14.  * </pre>
  15.  *
  16.  * @author : saysky
  17.  * @date : 2018/1/19
  18.  */
  19. @Data
  20. @TableName("sens_log")
  21. public class Log implements Serializable {
  23.     private static final long serialVersionUID = -2571815432301283171L;
  25.     /**
  26.      * id
  27.      */
  28.     @TableId(type = IdType.AUTO)
  29.     private Long logId;
  31.     /**
  32.      * 标题
  33.      */
  34.     private String logTitle;
  36.     /**
  37.      * 内容
  38.      */
  39.     private String logContent;
  41.     /**
  42.      * 产生日志的ip
  43.      */
  44.     private String logIp;
  46.     /**
  47.      * 产生的时间
  48.      */
  49.     private Date logCreated;
  51.     public Log() {
  52.     }
  54.     public Log(String logTitle, String logContent, String logIp, Date logCreated) {
  55.         this.logTitle = logTitle;
  56.         this.logContent = logContent;
  57.         this.logIp = logIp;
  58.         this.logCreated = logCreated;
  59.     }
  60. }



2.Mapper 类
  1. package com.liuyanzhao.sens.mapper;
  3. import com.baomidou.mybatisplus.mapper.BaseMapper;
  4. import com.baomidou.mybatisplus.plugins.pagination.Pagination;
  5. import com.liuyanzhao.sens.entity.Log;
  6. import org.apache.ibatis.annotations.Mapper;
  8. import java.util.List;
  10. /**
  11.  * 日志Mapper
  12.  * @author liuyanzhao
  13.  */
  14. @Mapper
  15. public interface LogMapper extends BaseMapper<Log> {
  17.     /**
  18.      * 查询所有
  19.      * @param pagination 分页信息
  20.      * @return List
  21.      */
  22.     List<Log> findAll(Pagination pagination);
  24.     /**
  25.      * 查询最新的五条数据
  26.      *
  27.      * @return List
  28.      */
  29.     List<Log> findTopFive();
  31.     /**
  32.      * 删除所有的记录
  33.      * @return 影响行数
  34.      */
  35.     Integer deleteAll();
  36. }

我们查看 BaseMapper，发现里面已经常用的 insert/updateById/selectById/delete/deleteById 等方法，

需要自定义的，按照传统方法添加就行了



3.Mapper xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.liuyanzhao.sens.mapper.LogMapper">
  4.   <resultMap id="BaseResultMap" type="com.liuyanzhao.sens.entity.Log">
  5.     <id column="log_id" jdbcType="INTEGER" property="logId"/>
  6.     <result column="log_title" jdbcType="VARCHAR" property="logTitle"/>
  7.     <result column="log_content" jdbcType="VARCHAR" property="logContent"/>
  8.     <result column="log_ip" jdbcType="VARCHAR" property="logIp"/>
  9.     <result column="log_created" jdbcType="TIMESTAMP" property="logCreated"/>
  10.   </resultMap>
  12.   <sql id="all_columns">
  13.    log_id, log_title, log_content, log_ip, log_created
  14.     </sql>
  16.   <sql id="tb">`sens_log`</sql>
  18.   <sql id="all_values">
  19.         #{logId}, #{logTitle}, #{logContent}, #{logIp}, #{logCreated}
  20.     </sql>
  22.   <select id="findAll" resultMap="BaseResultMap">
  23.     SELECT
  24.     <include refid="all_columns"/>
  25.     FROM
  26.     <include refid="tb"/>
  27.   </select>
  30.   <select id="findTopFive" resultMap="BaseResultMap">
  31.     SELECT
  32.     <include refid="all_columns"/>
  33.     FROM
  34.     <include refid="tb"/>
  35.     ORDER BY log_id DESC LIMIT 5
  36.   </select>
  38.   <delete id="deleteAll">
  39.     DELETE FROM <include refid="tb"/>
  40.   </delete>
  41. </mapper>

关于增删改查的基本接口不需要写了



4.Service实现
  1. package com.liuyanzhao.sens.service.impl;
  3. import com.baomidou.mybatisplus.plugins.Page;
  4. import com.liuyanzhao.sens.entity.Log;
  5. import com.liuyanzhao.sens.mapper.LogMapper;
  6. import com.liuyanzhao.sens.service.LogService;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.stereotype.Service;
  10. import java.util.List;
  12. /**
  13.  * <pre>
  14.  *     日志业务逻辑实现类
  15.  * </pre>
  16.  *
  17.  * @author : saysky
  18.  * @date : 2018/1/19
  19.  */
  20. @Service
  21. public class LogServiceImpl implements LogService {
  23.     @Autowired(required = false)
  24.     private LogMapper logMapper;
  27.     /**
  28.      * 保存日志
  29.      *
  30.      * @param log log
  31.      * @return log
  32.      */
  33.     @Override
  34.     public Log saveByLog(Log log) {
  35.         logMapper.insert(log);
  36.         return log;
  37.     }
  39.     /**
  40.      * 根据编号移除
  41.      *
  42.      * @param logId logId
  43.      */
  44.     @Override
  45.     public void removeByLogId(Long logId) {
  46.         logMapper.deleteById(logId);
  47.     }
  49.     /**
  50.      * 移除所有日志
  51.      */
  52.     @Override
  53.     public void removeAllLog() {
  54.         logMapper.deleteAll();
  55.     }
  57.     /**
  58.      * 查询所有日志并分页
  59.      *
  60.      * @param page 分页信息
  61.      * @return Page
  62.      */
  63.     @Override
  64.     public Page<Log> findAllLog(Page<Log> page) {
  65.         return page.setRecords(logMapper.findAll(page));
  66.     }
  68.     /**
  69.      * 查询最新的五条日志
  70.      *
  71.      * @return List
  72.      */
  73.     @Override
  74.     public List<Log> findLogLatest() {
  75.         return logMapper.findTopFive();
  76.     }
  78.     /**
  79.      * 根据编号查询
  80.      *
  81.      * @param logId logId
  82.      * @return Optional
  83.      */
  84.     @Override
  85.     public Log findLogByLogId(Long logId) {
  86.         return logMapper.selectById(logId);
  87.     }
  88. }

第4个方法是分页查询，为下面的做铺垫



相信用过 MyBatis 的朋友，开始使用 MyBatis Plus 上手很快的。


三、分页


承接上面的代码，我们实现日志分页显示

1.添加配置

上面 MybatisPlusConfig 中已经添加了分页拦截器



2. Controller 层
  1. /**
  2.  * 日志分页
  3.  *
  4.  * @param model model
  5.  * @param page  当前页码
  6.  * @return 模板路径/themes/{theme}/index
  7.  */
  8. @GetMapping(value = "logs")
  9. public String index(Model model,
  10.                     @RequestParam(name = "page",required = false, defaultValue = "1") Integer page,
  11.                     @RequestParam(name = "size",required = false, defaultValue = "10") Integer size) {
  12.     //所有日志数据，分页
  13.     Page pageable = new Page(page , size);  
  14.     Page<Log> logs = postService.findPostByStatus(pageable);  
  15.     model.addAttribute("logs", logs);
  16.     return this.render("index");
  17. }

主要关注第13-14行



3.Page 类

不要导错包

分页对象主要包含以下几个重要字段

records：数据列表

total：总记录数

pages：总页数

size：页大小，一页显示多少条

current：当前页码(从第1页开始)








四、引入 FreeMarker 渲染页面


以本站首页分页样式为例

1.引入FreeMaerker
  1. <!-- freemarker依赖 -->
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-freemarker</artifactId>
  5.         </dependency>



2.application.yml
  1. spring:
  2.   freemarker:
  3.     allow-request-override: false
  4.     cache: false
  5.     check-template-location: true
  6.     charset: utf-8
  7.     content-type: text/html
  8.     expose-request-attributes: false
  9.     expose-session-attributes: false
  10.     expose-spring-macro-helpers: true
  11.     suffix: .ftl
  12.     settings:
  13.       auto_import: /spring.ftl as spring
  14.       template_update_delay: 0



3. html 代码部分如下
  1. <nav class="navigation pagination" role="navigation">
  2.     <h2 class="screen-reader-text">文章导航</h2>
  3.     <div class="nav-links">
  5.     <#assign totalPages = posts.pages>
  6.     <#assign totalElements = posts.total>
  7.     <#assign number = posts.current>
  8.     <#assign first = (posts.current == 1)>
  9.     <#assign last = (posts.current == posts.pages)>
  10.     <#assign hasPrevious = (posts.current > 1)>
  11.     <#assign hasNext = (posts.current < posts.pages)>
  12.     ${totalPages} ${totalElements}  ${number}
  14.     <#--上一页-->
  15.     <#if hasPrevious>
  16.         <a class="prev page-numbers" href="${prefix}/page/${number-1}">
  17.             <i class="fa fa-angle-left"></i>
  18.         </a>
  19.     </#if>
  21.     <#--总页数小于等于7全部显示-->
  22.     <#if totalPages <= 7>
  23.         <#if totalPages gt 1>
  24.             <#list 1..totalPages-1 as pageIndex>
  25.                 <a class="page-numbers <#if number == pageIndex>current</#if>" href="${prefix}/page/${pageIndex}">
  26.                     <span class="screen-reader-text">第 </span>${pageIndex}<span class="screen-reader-text"> 页</span>
  27.                 </a>
  28.             </#list>
  29.         </#if>
  31.     <#--总页数大于7，部分以...显示-->
  32.     <#else>
  33.     <#--首页-->
  34.         <#if first>
  35.             <span class="page-numbers current">
  36.                 <span class="screen-reader-text">第 </span>1<span class="screen-reader-text"> 页</span>
  37.             </span>
  38.         <#else>
  39.             <a class="page-numbers" href="${prefix}/page/1">
  40.                 <span class="screen-reader-text">第 </span>1<span class="screen-reader-text"> 页</span>
  41.             </a>
  42.         </#if>
  45.     <#--当前页面小于等于4-->
  46.         <#if number  <= 3 >
  47.             <#list 2..5 as pageIndex>
  48.                 <#if number == pageIndex>
  49.                     <span class="page-numbers current">
  50.                          <span class="screen-reader-text">第 </span>${pageIndex}<span
  51.                             class="screen-reader-text"> 页</span>
  52.                      </span>
  53.                 <#else>
  54.                     <a class="page-numbers" href="${prefix}/page/${pageIndex}">
  55.                         <span class="screen-reader-text">第 </span>${pageIndex}<span class="screen-reader-text"> 页</span>
  56.                     </a>
  57.                 </#if>
  58.             </#list>
  59.             <span class="page-numbers dots">…</span>
  60.         </#if>
  62.     <#--最后一页与当前页面之差，小于等于3-->
  63.         <#if (totalPages - number ) <= 4 >
  64.             <span class="page-numbers dots">…</span>
  65.             <#list (totalPages - 4)..(totalPages - 1) as pageIndex2>
  66.                 <#if number == pageIndex2>
  67.                     <span class="page-numbers current">
  68.                          <span class="screen-reader-text">第 </span>${pageIndex2}<span
  69.                             class="screen-reader-text"> 页</span>
  70.                      </span>
  71.                 <#else>
  72.                     <a class="page-numbers" href="${prefix}/page/${pageIndex2}">
  73.                         <span class="screen-reader-text">第 </span>${pageIndex2}<span
  74.                             class="screen-reader-text"> 页</span>
  75.                     </a>
  76.                 </#if>
  77.             </#list>
  78.         </#if>
  80.     <#--最后一页与当前页面之差大于3，且当前页面大于4-->
  82.         <#if (number  > 3) && ((totalPages - number) > 4 )>
  83.             <span class="page-numbers dots">…</span>
  84.             <a class="page-numbers" href="${prefix}/page/${number}/">
  85.                 <span class="screen-reader-text">第 </span>${number}<span class="screen-reader-text"> 页</span>
  86.             </a>
  87.             <span class="page-numbers current">
  88.                 <span class="screen-reader-text">第 </span>${number+1}<span class="screen-reader-text"> 页</span>
  89.             </span>
  90.             <a class="page-numbers" href="${prefix}/page/${number+2}">
  91.                 <span class="screen-reader-text">第 </span>${number+2}<span class="screen-reader-text"> 页</span>
  92.             </a>
  93.             <span class="page-numbers dots">…</span>
  94.         </#if>
  96.     </#if>
  98.     <#--尾页-->
  99.         <a class="page-numbers <#if number == totalPages>current</#if>" href="${prefix}/page/${totalPages}">
  100.             <span class="screen-reader-text">第 </span>${totalPages}<span class="screen-reader-text"> 页</span>
  101.         </a>
  103.     <#--下一页-->
  104.     <#if hasNext>
  105.         <a class="next page-numbers" href="${prefix}/page/${number+1}">
  106.             <i class="fa fa-angle-right"></i>
  107.         </a>
  108.     </#if>
  109.     </div>
  110. </nav>



效果如下
  • 如果页数小于等于7，会全部显示
  • 如果页数大于7，中间的会以...显示，如下
























历史上的今天
十二月
23日
  • 微信
  • 交流学习，资料分享
  • weinxin
  • 个人淘宝
  • 店铺名：言曌博客咨询部

  • (部分商品未及时上架淘宝)
avatar

发表评论

avatar 登录者：匿名
匿名评论，评论回复后会有邮件通知

  

已通过评论：2   待审核评论数：0
  1. avatar mckola_molas
    回复 2021年01月18日 09:20:56

    大佬，这个有什么实现原理吗？ 具体一点的，page类是我自己写还是直接用mybatis-plus？

    • avatar 言曌
      回复 2021年01月18日 09:29:08

      @mckola_molas:你看导入的包就知道啊，用mybatis plus的

      • avatar mckola_molas
        回复 2021年01月18日 09:37:56

        @言曌:okok谢谢大佬，这个是我没有仔细看导致的，不过postservice我真的没有找到啊啊啊啊啊 秋梨膏帮忙给个思路

  2. avatar 哈哈
    回复 2020年02月20日 19:45:18

    大佬，我用SpringBoot+MyBatistPlus，在全局配置id-type: 0，为什么不生效呢？