SpringBoot - 学习笔记《集成 MyBatis-Plus》

浅浅的花香味﹌ 2022-10-30 01:22 196阅读 0赞

### SpringBoot - 学习笔记《集成 MyBatis-Plus》 ###

*  简介
 *  1. 代码生成
 *   *  总结
 *  2. 通用Mapper、Service
 *   *  通用Mapper 支持
     *  通用Service 支持
     *  集成演示
     *   *  1. 准备工作：测试数据
         *  2. 添加依赖、配置文件
         *  3. 创建实体类
         *  4. 创建Mapper
         *  5. 创建Service(可选)
         *  6. 创建测试类
 *  本项目源码
 *  参考资料

# 简介 #

[MyBatis-Plus][] 简称`MP` ，之前做过Spring集成MyBatis-Plus看底部参考资料。  
MyBatis的各种插件无非要解决的是两个问题：

1.  提供默认的通用增删改查功能。
2.  支持便捷的生成自定义代码。

# 1. 代码生成 #

这方面，还有很大的优化空间。毕竟现在Mybatis插件这么多，优秀的代码生成GUI工具也不少。

*  **编码方式**：今天调通了下次一用又出翔。毕竟不是一直追他的版本，升个级感觉我们又是陌生人了。之前写过 [Mybatis-Plus-Generator 初体验][Mybatis-Plus-Generator] 本次就不赘述了。
 *  **GUI界面**：官方出了idea插件 [MybatisX][] 但是很敷衍（copy from free mybatis plugin），文档就几张GIF，也没有详细的说明。不过留了个QQ群 829161197。毕竟是MP一套的东西，就说一说吧。勉强用来生成通用Mapper所需要的 Entity 和 Mapper 够了。（实用价值不大）

如果你之前已经安装过`free mybatis plugin`就会看到两个。大写开头那个才是`MybatisX`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]  
这个界面操作起来也是非常不智能。误操作概率很大，还没历史记录。（把人家原来有的功能删了666）  
下面的选项也是。。。估计留着自嗨的。  
牛就牛在这东西生成的东西，并没有结合MP自己的通用Mapper、Service  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 1]

## 总结 ##

还不如直接用 [EasyCode][] 人家还提供了 MP 的模板。要不你们考虑下合作多好。  
`EasyCode` \+ `MP通用CURD` 目前是比较可行的。可悲在于，EasyCode的自定义模板很自由，MP随时有被踢掉的风险。比如有哪个热心的粉丝出一套 MP模板。。。 EasyCode 的用户就可以完全放弃 MP 了。  
话说回来，有心做精品，好好合作，也是有搞头的。并非一定是谁吃了谁。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 2]

# 2. 通用Mapper、Service #

对于通用的数据库操作，MyBatis-Plus提供了通用Mapper。我们使用MP时只要做两步：

1.  创建实体
2.  创建对应`Mapper`并继承`BaseMapper<T>`

这样通用的CURD就到手了。

关于带条件的操作`慎用`，因为用到了MP自己定义的[条件构造器][Link 1]。自己玩的小项目，还行。如果用于团队项目，容易被背锅。当然如果你是项目负责人能hold住也没问题。下面是简单介绍，详情看官方文档。本文底部有链接。

## 通用Mapper 支持 ##

除常规CURD外，还封装了一些扩展方法：

1.  根据 entity 条件，删除记录
2.  根据ID 批量删除
3.  根据 whereEntity 条件，更新记录
4.  根据ID 批量查询
5.  根据条件，查询记录有几个版本。

## 通用Service 支持 ##

除常规CURD外，还封装了一些扩展方法：

1.  批量插入
2.  自动判断保存or更新、自动判断保存or更新（批量）
3.  按条件删除
4.  批量删除
5.  按条件更新
6.  根据ID批量更新
7.  查询：单条、列表
8.  分页查询
9.  统计总数
10. 按条件统计总数
11. 链式查询
12. 链式更改

## 集成演示 ##

### 1. 准备工作：测试数据 ###

测试数据直接用这个：[数据库 SQL测试数据 - 笑虾原创诗词表][SQL_ -]

各种版本参考：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>JDK</td> 
   <td>1.8</td> 
  </tr> 
  <tr> 
   <td>spring-boot-starter-parent</td> 
   <td>2.4.2</td> 
  </tr> 
  <tr> 
   <td>druid-spring-boot-starter</td> 
   <td>1.2.4</td> 
  </tr> 
  <tr> 
   <td>mybatis-plus-boot-starter</td> 
   <td>3.4.2</td> 
  </tr> 
 </tbody> 
</table>

### 2. 添加依赖、配置文件 ###

pom.xml

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>RELEASE</version>
            </dependency>

application.yml

spring:
      #数据库连接配置
      datasource:
        driverClassName: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=GMT%2B8
        username: root
        password: root
    
    # Mybatis日志: 输出指定包下的日志
    logging:
      level:
        com.mybatisplus.demo.mapper: trace

### 3. 创建实体类 ###

package com.mybatisplus.curd.entity;
    
    import lombok.Data;
    
    import java.io.Serializable;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    /** * 诗词表(Poem)实体类 * * @author jerryjin * @since 2021-02-16 17:20:50 */
    @Data
    public class Poem implements Serializable { 
        private static final long serialVersionUID = 393671495535297496L;
        /** 主键 */
        private Object id;
        /** 诗词标题 */
        private String title;
        /** 诗词内容 */
        private String content;
        /** 作者 */
        private String author;
        /** 发表时间 */
        private Date publishedTime;
        /** 更新时间 */
        private Date updateTime;
        /** 创建时间 */
        private Date createTime;
        
        @Override
        public String toString() { 
            return id + ":《" + title + "》\n-" + author + " " + (new SimpleDateFormat("YYYY-MM")).format(publishedTime) + "\n" + content + "\n" ;
        }
    }

### 4. 创建Mapper ###

package com.mybatisplus.curd.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.mybatisplus.curd.entity.Poem;
    import org.apache.ibatis.annotations.Mapper;
    
    /** * 诗词表(Poem)表数据库访问层 * * @author jerryjin * @since 2021-02-16 17:20:50 */
    @Mapper
    public interface PoemMapper extends BaseMapper<Poem> { 
    }

### 5. 创建Service(可选) ###

package com.mybatisplus.curd.service;
    
    import com.baomidou.mybatisplus.extension.service.IService;
    import com.mybatisplus.curd.entity.Poem;
    
    /** * @author jerryjin */
    public interface PoemService extends IService<Poem> { 
    }

package com.mybatisplus.curd.service.impl;
    
    import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    import com.mybatisplus.curd.entity.Poem;
    import com.mybatisplus.curd.mapper.PoemMapper;
    import com.mybatisplus.curd.service.PoemService;
    import org.springframework.stereotype.Service;
    
    /** * @author jerryjin */
    @Service
    public class PoemServiceImpl extends ServiceImpl<PoemMapper, Poem> implements PoemService { 
    }

### 6. 创建测试类 ###

package com.mybatisplus.curd;
    
    import com.mybatisplus.curd.entity.Poem;
    import com.mybatisplus.curd.mapper.PoemMapper;
    import com.mybatisplus.curd.service.PoemService;
    import org.junit.Assert;
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import javax.annotation.Resource;
    import java.util.List;
    
    /** * 测试通用Mapper、Service */
    @RunWith(SpringRunner.class)
    @SpringBootTest
    class MybatisplusDemoApplicationTests { 
        
        @Resource
        private PoemMapper poemMapper;   
    
        @Resource
        private PoemService poemService;
    
        /** * 通用 mapper */
        @Test
        void contextLoads(){ 
            System.out.println(("----- poemMapper.selectList 方法 test ------"));
            List<Poem> userList = poemMapper.selectList(null);
            Assert.assertEquals(19, userList.size());
            System.out.println(("----- 输出完整列表： ------"));
            userList.forEach(System.out::println);
        }
        /** * 通用 Service */
        @Test
        void contextLoads2(){ 
            System.out.println(("----- poemService.list 方法 test ------"));
            List<Poem> userList = poemService.list();
            Assert.assertEquals(19, userList.size());
            System.out.println(("----- 输出完整列表： ------"));
            userList.forEach(System.out::println);
        }
    }

# 本项目源码 #

[本项目源码 mybatisplus-demo ][mybatisplus-demo]

# 参考资料 #

[官方文档：CRUD 接口 （通用 Service、Mapper）][CRUD _ _ Service_Mapper]  
[官方文档：条件构造器][Link 1]

[Spring 学习笔记《集成 MyBatis-Plus》][Spring _ MyBatis-Plus]  
[Mybatis-Plus-Generator 初体验][Mybatis-Plus-Generator 1]

[MyBatis-Plus]: https://mp.baomidou.com/guide/#%E7%89%B9%E6%80%A7
[Mybatis-Plus-Generator]: https://blog.csdn.net/jx520/article/details/90745016
[MybatisX]: https://mp.baomidou.com/guide/mybatisx-idea-plugin.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]: /images/20221024/cc975dc1091a4142b493e7df672b09d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 1]: /images/20221024/82b3fc17522b479ba70ce377848c7393.png
[EasyCode]: https://blog.csdn.net/jx520/article/details/105937556
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 2]: /images/20221024/360bf22fbfba49ca875109b87cbbd252.png
[Link 1]: https://mp.baomidou.com/guide/wrapper.html
[SQL_ -]: https://blog.csdn.net/jx520/article/details/113825966
[mybatisplus-demo]: https://gitee.com/jerryjin0630/mybatisplus-demo
[CRUD _ _ Service_Mapper]: https://mp.baomidou.com/guide/crud-interface.html
[Spring _ MyBatis-Plus]: https://jerryjin.blog.csdn.net/article/details/90724408
[Mybatis-Plus-Generator 1]: https://jerryjin.blog.csdn.net/article/details/90745016