一、insert

1、插入操作

  1. @RunWith(SpringRunner.class) 
  2. @SpringBootTest 
  3. public class CRUDTests {
  5. @Autowired
  6. private UserMapper userMapper;
  8. @Test
  9. public void testInsert(){
  11.     User user = new User();
  12.     user.setName("Helen");
  13.     user.setAge(18);
  14.     user.setEmail("55317332@qq.com");
  16.     int result = userMapper.insert(user);
  17.     System.out.println(result); //影响的行数
  18.     System.out.println(user); //id自动回填
  19. }

注意：数据库插入id值默认为：全局唯一id
image.png

2、主键策略

（1）ID_WORKER
MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID

参考资料：分布式系统唯一ID生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

（2）自增策略

要想主键自增需要配置如下主键策略
需要在创建数据表的时候设置主键自增
实体字段中配置 @TableId(type = IdType.AUTO)

@TableId(type = IdType.AUTO) private Long id;

要想影响所有实体的配置，可以设置全局主键配置

  1. #全局设置主键生成策略
  2. mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知

  1. @Getter 
  2. public enum IdType {
  3.     /**
  4.     * 数据库ID自增
  5.     */
  6.     AUTO(0),
  7.     /**
  8.     * 该类型为未设置主键类型
  9.     */
  10.     NONE(1),
  11.     /**
  12.     * 用户输入ID
  13.     * 该类型可以通过自己注册自动填充插件进行填充
  14.     */
  15.     INPUT(2),
  16.     /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
  17.     /**
  18.      * 全局唯一ID (idWorker)，默认方式
  19.      */
  20.     ID_WORKER(3),
  21.     /**
  22.      * 全局唯一ID (UUID)
  23.      */
  24.     UUID(4),
  25.     /**
  26.      * 字符串全局唯一ID (idWorker 的字符串表示)
  27.      */
  28.     ID_WORKER_STR(5);
  30.     private int key;
  32.     IdType(int key) {
  33.         this.key = key;
  34.     }
  35. }

二、update

1、根据Id更新操作

注意：update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=? 

  1. @Test 
  2. public void testUpdateById(){
  3.         User user = new User();
  4.     user.setId(1L);
  5.     user.setAge(28);
  7.     int result = userMapper.updateById(user);
  8.     System.out.println(result);
  10. }

2、自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。
我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段
在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

  1. @Data 
  2. public class User {
  3.   ......
  5.   @TableField(fill = FieldFill.INSERT)
  6.   private Date createTime;
  8.   //@TableField(fill = FieldFill.UPDATE)
  9.   @TableField(fill = FieldFill.INSERT_UPDATE)
  10.   private Date updateTime;
  12. }

（3）实现元对象处理器接口
注意：不要忘记添加 @Component 注解 

  1. package com.atguigu.mybatisplus.handler;
  2. import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  3. import org.apache.ibatis.reflection.MetaObject;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.stereotype.Component;
  7. import java.util.Date;
  8. @Component 
  9. public class MyMetaObjectHandler implements MetaObjectHandler {
  11.   private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
  13.   @Override
  14.   public void insertFill(MetaObject metaObject) {
  15.       LOGGER.info("start insert fill ....");
  16.       this.setFieldValByName("createTime", new Date(), metaObject);
  17.       this.setFieldValByName("updateTime", new Date(), metaObject);
  18.   }
  20.   @Override
  21.   public void updateFill(MetaObject metaObject) {
  22.       LOGGER.info("start update fill ....");
  23.       this.setFieldValByName("updateTime", new Date(), metaObject);
  24.     }
  25.  }

（4）测试

3、乐观锁

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

乐观锁实现方式：

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败

（1）数据库中添加version字段

  1. ALTER TABLE user ADD COLUMN version INT

image.png

（2）实体类添加version字段

并添加 @Version 注解 

  1. @Version 
  2. @TableField(fill  = FieldFill.INSERT) 
  3. private Integer version;

（3）元对象处理器接口添加version的insert默认值

  1. @Override 
  2. public void insertFill(MetaObject metaObject) {
  3.   ......
  4.   this.setFieldValByName("version", 1, metaObject);
  5. }

特别说明: 支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime 整数类型下 newVersion = oldVersion + 1 newVersion 会回写到 entity 中 仅支持 updateById(id) 与 update(entity, wrapper) 方法 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

（4）在 MybatisPlusConfig 中注册 Bean
创建配置类

  1. package com.atguigu.mybatisplus.config;
  2. import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
  3. import org.mybatis.spring.annotation.MapperScan;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.transaction.annotation.EnableTransactionManagement;
  7. @EnableTransactionManagement
  8. @Configuration 
  9. @MapperScan("com.atguigu.mybatis_plus.mapper")
  10. public class MybatisPlusConfig {
  12.   /**
  13.    * 乐观锁插件
  14.    */
  15.   @Bean
  16.   public OptimisticLockerInterceptor optimisticLockerInterceptor() {
  17.       return new OptimisticLockerInterceptor();
  18.     }
  19. }

（5）测试乐观锁可以修改成功
测试后分析打印的sql语句，将version的数值进行了加1操作

  1. /**
  2. * 测试 乐观锁插件
  3. */
  4. @Test  
  5. public void testOptimisticLocker() {
  6.   //查询
  7.   User user = userMapper.selectById(1L);
  8.   //修改数据
  9.   user.setName("Helen Yao");
  10.   user.setEmail("helen@qq.com");
  11.   //执行更新
  12.   userMapper.updateById(user);
  13. }


（5）测试乐观锁修改失败

  1. /**
  2. * 测试乐观锁插件 失败
  3. */
  4. @Test  
  5. public void testOptimisticLockerFail() {
  6.   //查询
  7.   User user = userMapper.selectById(1L);
  8.   //修改数据
  9.   user.setName("Helen Yao1");
  10.   user.setEmail("helen@qq.com1");
  11.   //模拟取出数据后，数据库中version实际数据比取出的值大，即已被其它线程修改并更新了version
  12.   user.setVersion(user.getVersion() - 1);
  13.   //执行更新
  14.   userMapper.updateById(user);
  15. }

三、select

1、根据id查询记录

  1. @Test 
  2. public void testSelectById(){
  4.   User user = userMapper.selectById(1L);
  5.   System.out.println(user);
  6. }

2、通过多个id批量查询

完成了动态sql的foreach的功能

  1. @Test 
  2. public void testSelectBatchIds(){
  4.   List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
  5.   users.forEach(System.out::println);
  6. }

3、简单的条件查询

通过map封装查询条件

  1. @Test 
  2. public void testSelectByMap(){
  4.   HashMap<String, Object> map = new HashMap<>();
  5.   map.put("name", "Helen");
  6.   map.put("age", 18);
  7.   List<User> users = userMapper.selectByMap(map);
  9.   users.forEach(System.out::println);
  10. }

注意： map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id

4、分页

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能
（1）创建配置类
此时可以删除主类中的 @MapperScan 扫描注解 

  1. /**
  2. * 分页插件
  3. */
  4. @Bean  
  5. public PaginationInterceptor paginationInterceptor() {
  6.     return new PaginationInterceptor();
  7. }

（2）测试selectPage分页
测试：最终通过page对象获取相关数据

  1. @Test 
  2. public void testSelectPage() {
  4.   Page<User> page = new Page<>(1,5);
  5.   userMapper.selectPage(page, null);
  7.   page.getRecords().forEach(System.out::println);
  8.   System.out.println(page.getCurrent());
  9.   System.out.println(page.getPages());
  10.   System.out.println(page.getSize());
  11.   System.out.println(page.getTotal());
  12.   System.out.println(page.hasNext());
  13.   System.out.println(page.hasPrevious());
  14. }

控制台sql语句打印：SELECT id,name,age,email,create_time,update_time FROM user LIMIT 0,5

（3）测试selectMapsPage分页：结果集是Map

  1. @Test 
  2. public void testSelectMapsPage() {
  4.   Page<User> page = new Page<>(1, 5);
  5.   IPage<Map<String, Object>> mapIPage = userMapper.selectMapsPage(page, null);
  7.   //注意：此行必须使用 mapIPage 获取记录列表，否则会有数据类型转换错误
  8.   mapIPage.getRecords().forEach(System.out::println);
  9.   System.out.println(page.getCurrent());
  10.   System.out.println(page.getPages());
  11.   System.out.println(page.getSize());
  12.   System.out.println(page.getTotal());
  13.   System.out.println(page.hasNext());
  14.   System.out.println(page.hasPrevious());
  15. }

四、delete

1、根据id删除记录

  1. @Test 
  2. public void testDeleteById(){
  4.   int result = userMapper.deleteById(8L);
  5.   System.out.println(result);
  7. }

2、批量删除

  1. @Test 
  2. public void testDeleteBatchIds() {
  3.     int result = userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
  4.   System.out.println(result);
  5. }

3、简单的条件查询删除

  1. @Test 
  2. public void testDeleteByMap() {
  4.   HashMap<String, Object> map = new HashMap<>();
  5.   map.put("name", "Helen");
  6.   map.put("age", 18);
  8.   int result = userMapper.deleteByMap(map);
  9.   System.out.println(result);
  10. }

4、逻辑删除

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据

逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

（1）数据库中添加 deleted字段

  1. ALTER TABLE user ADD COLUMN deleted boolean

image.png

（2）实体类添加deleted 字段
并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解 

  1. @TableLogic 
  2. @TableField(fill  = FieldFill.INSERT) 
  3. private Integer deleted;

（3）元对象处理器接口添加deleted的insert默认值

  1. @Override 
  2. public void insertFill(MetaObject metaObject) {
  3.   ......
  4.   this.setFieldValByName("deleted", 0, metaObject);
  5. }

（4）application.properties 加入配置
此为默认值，如果你的默认值和mp默认的一样,该配置可无

  1. mybatis-plus.global-config.db-config.logic-delete-value=1
  2. mybatis-plus.global-config.db-config.logic-not-delete-value=0

（5）在 MybatisPlusConfig 中注册 Bean

  1. @Bean 
  2. public ISqlInjector sqlInjector() {
  3.     return new LogicSqlInjector();
  4. }

（6）测试逻辑删除
测试后发现，数据并没有被删除，deleted字段的值由0变成了1

测试后分析打印的sql语句，是一条update
注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

  1. /**
  2. * 测试 逻辑删除
  3. */
  4. @Test  
  5. public void testLogicDelete() {
  6.   int result = userMapper.deleteById(1L);
  7.   System.out.println(result);
  8. }


（7）测试逻辑删除后的查询
MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断

  1. /**
  2. * 测试 逻辑删除后的查询：
  3. * 不包括被逻辑删除的记录
  4. */
  5. @Test  
  6. public void testLogicDeleteSelect() {
  7.   User user = new User();
  8.   List users = userMapper.selectList(null);
  9.   users.forEach(System.out::println);
  10. }


测试后分析打印的sql语句，包含 WHERE deleted=0
SELECT id,name,age,email,create_time,update_time,deleted FROM user WHERE deleted=0

五、性能分析

性能分析拦截器，用于输出每条 SQL 语句及其执行时间
SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题

1、配置插件

（1）参数说明
参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。
参数：format： SQL是否格式化，默认false。
（2）在 MybatisPlusConfig 中配置

  1. /**
  2. * SQL 执行性能分析插件
  3. * 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
  4. */
  5. @Bean  
  6. @Profile({"dev","test"})// 设置 dev test 环境开启
  7. public PerformanceInterceptor performanceInterceptor() {
  8.   PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
  9.   performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
  10.   performanceInterceptor.setFormat(true);
  11.   return performanceInterceptor;
  12. }


（3）Spring Boot 中设置dev环境

  1. #环境设置：dev、test、prod
  2. spring.profiles.active=dev

可以针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

也可以自定义环境名称：如test1、test2

2、测试

（1）常规测试

  1. /**
  2. * 测试 性能分析插件
  3. */
  4. @Test  
  5. public void testPerformance() {
  6.   User user = new User();
  7.   user.setName("我是Helen");
  8.   user.setEmail("helen@sina.com");
  9.   user.setAge(18);
  10.   userMapper.insert(user);
  11. }


输出：
image.png

（2）将maxTime 改小之后再次进行测试
performanceInterceptor.setMaxTime(5);//ms，超过此处设置的ms不执行
如果执行时间过长，则抛出异常：The SQL execution time is too large,
输出：
image.png

六、其它

如果想进行复杂条件查询，那么需要使用条件构造器 Wapper，涉及到如下方法
1、delete
2、selectOne
3、selectCount
4、selectList
5、selectMaps
6、selectObjs
7、update