第一章：ActiveRecord

1.1 概述（摘自官网）

  • ActiveRecord（简称AR）一直广受动态语言（ PHP 、 Ruby 等）的喜爱，而 Java 作为准静态语言，对于
    ActiveRecord 往往只能感叹其优雅，所以我们也在 AR 道路上进行了一定的探索，喜欢大家能够喜欢。

什么是ActiveRecord？ ActiveRecord也属于ORM（对象关系映射）层，由Rails最早提出，遵循标准的ORM模型：表映射到记录，记
录映射到对象，字段映射到对象属性。配合遵循的命名和配置惯例，能够很大程度的快速实现模型的操作，而
且简洁易懂。

ActiveRecord的主要思想是：

  • 每一个数据库表对应创建一个类，类的每一个对象实例对应于数据库中表的一行记录；通常表的每个字段在类中都有相应的Field；
  • ActiveRecord同时负责把自己持久化，在ActiveRecord中封装了对数据库的访问，即CURD;
  • ActiveRecord是一种领域模型(Domain Model)，封装了部分业务逻辑；

1.2 开启AR之旅

  • 在MP中，开启AR非常简单，只需要实体对象继承Model即可，同时还需要重写pkVal方法，并返回主键。
  • 实体对象：
  1. package com.example.mp.domain;
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableField;
  5. import com.baomidou.mybatisplus.annotation.TableId;
  6. import com.baomidou.mybatisplus.annotation.TableName;
  7. import com.baomidou.mybatisplus.extension.activerecord.Model;
  8. import lombok.AllArgsConstructor;
  9. import lombok.Data;
  10. import lombok.NoArgsConstructor;
  11. import lombok.ToString;
  12. import lombok.experimental.Accessors;
  14. import java.io.Serializable;
  17. /**
  18.  * @author 许大仙
  19.  * @version 1.0
  20.  * @since 2021-06-17 21:01
  21.  */
  22. @Data
  23. @NoArgsConstructor
  24. @AllArgsConstructor
  25. @TableName("tb_user")
  26. @Accessors(chain = true)
  27. @ToString
  28. public class User extends Model<User> {
  30.     @TableId(type= IdType.AUTO)
  31.     private Long id;
  33.     @TableField("user_name") //解决字段名不一致
  34.     private String username;
  36.     private String password;
  38.     private String name;
  40.     private Integer age;
  42.     private String email;
  44.     @Override
  45.     public Serializable pkVal() {
  46.         return id;
  47.     }
  48. }
  • UserMapper.java
  1. package com.example.mp.mapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import com.example.mp.domain.User;
  5. import org.apache.ibatis.annotations.Mapper;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-17 21:10
  11.  */
  12. @Mapper
  13. public interface UserMapper extends BaseMapper<User> {
  15. }

注意：UserMapper不能删除。

1.3 根据主键查询

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.boot.test.context.SpringBootTest;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-19 18:47
  11.  */
  12. @SpringBootTest
  13. public class TestActiveRecord {
  15.     @Test
  16.     public void testSelectById() {
  17.         User user = new User().setId(1L).selectById();
  18.         System.out.println("user = " + user);
  19.     }
  20. }

1.4 新增数据

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.boot.test.context.SpringBootTest;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-19 18:47
  11.  */
  12. @SpringBootTest
  13. public class TestActiveRecord {
  15.     @Test
  16.     public void testInsert(){
  17.         boolean flag = new User()
  18.                 .setUsername("xudaxian")
  19.                 .setEmail("xudaxian@qq.com")
  20.                 .setPassword("123456")
  21.                 .setName("许大仙")
  22.                 .setAge(18).insert();
  23.         System.out.println("flag = " + flag);
  24.     }
  25. }

1.5 更新数据

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.boot.test.context.SpringBootTest;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-19 18:47
  11.  */
  12. @SpringBootTest
  13. public class TestActiveRecord {
  15.     @Test
  16.     public void testUpdate(){
  17.         User user = new User();
  18.         user.setId(1L);
  19.         user.setAge(18);
  21.         boolean flag = user.updateById();
  22.         System.out.println("flag = " + flag);
  23.     }
  24. }

1.6 删除数据

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.boot.test.context.SpringBootTest;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-19 18:47
  11.  */
  12. @SpringBootTest
  13. public class TestActiveRecord {
  15.     @Test
  16.     public void testDelete(){
  17.         User user = new User();
  18.         user.setId(1L);
  20.         boolean flag = user.deleteById();
  21.         System.out.println("flag = " + flag);
  22.     }
  24. }

1.7 根据条件查询数据

  • 示例：
  1. package com.example.mp;
  3. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4. import com.example.mp.domain.User;
  5. import org.junit.jupiter.api.Test;
  6. import org.springframework.boot.test.context.SpringBootTest;
  8. import java.util.List;
  10. /**
  11.  * @author 许大仙
  12.  * @version 1.0
  13.  * @since 2021-06-19 18:47
  14.  */
  15. @SpringBootTest
  16. public class TestActiveRecord {
  18.     @Test
  19.     public void testSelect(){
  20.         QueryWrapper<User> wrapper = new QueryWrapper<>();
  21.         wrapper.le("age","20");
  23.         User user = new User();
  24.         List<User> userList = user.selectList(wrapper);
  25.         System.out.println("userList = " + userList);
  26.     }
  27. }

第二章：Mybatis Plus的插件

2.1 mybatis的插件机制

  • mybatis允许我们在已映射语句执行过程中的某一点进行拦截调用。默认情况下，Mybatis允许使用插件来拦截的方法调用包括：
  1. Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
  1. ParameterHandler (getParameterObject, setParameters)
  1. ResultSetHandler (handleResultSets, handleOutputParameters)
  1. StatementHandler (prepare, parameterize, batch, update, query)
  • 我们可以看到可以拦截Executor接口的部分方法，比如update、query、commit、rollback等方法，还有其他接口的一些方法等。
  • 总体概况为：
    • 拦截执行器的方法。
    • 拦截参数的处理。
    • 拦截结果集的处理。
    • 拦截Sql语法构建的处理。
  • 示例：
  • ①自定义拦截器 
  1. package com.example.mp.plugins;
  3. import org.apache.ibatis.executor.statement.StatementHandler;
  4. import org.apache.ibatis.plugin.*;
  6. import java.sql.Statement;
  7. import java.util.Properties;
  9. /**
  10.  * //定义拦截那个对象的那个方法的那个参数
  11.  */
  12. @Intercepts({@Signature(type = StatementHandler.class, method = "parameterize", args = Statement.class)})
  13. public class MyInterceptor implements Interceptor {
  15.     /**
  16.      * 拦截目标对象的目标方法的执行
  17.      *
  18.      * @param invocation
  19.      * @return
  20.      * @throws Throwable
  21.      */
  22.     @Override
  23.     public Object intercept(Invocation invocation) throws Throwable {
  24.         System.out.println("--------MyInterceptor.intercept------------"+invocation.getMethod());
  25.         //执行目标方法
  26.         Object proceed = invocation.proceed();
  27.         return proceed;
  28.     }
  30.     /**
  31.      * 包装目标对象：为目标对象创建一个代理对象
  32.      *
  33.      * @param target
  34.      * @return
  35.      */
  36.     @Override
  37.     public Object plugin(Object target) {
  38.         System.out.println("------MyInterceptor--plugin-------"+target);
  40.         //借助Plugin的wrap使用当前的拦截器包装目标对象
  41.         Object wrap = Plugin.wrap(target, this);
  42.         //为当前target创建的动态代理
  43.         return wrap;
  44.     }
  46.     /**
  47.      * 将插件注册时的properties属性设置进来
  48.      *
  49.      * @param properties
  50.      */
  51.     @Override
  52.     public void setProperties(Properties properties) {
  53.         System.out.println("插件配置的信息 = " + properties);
  54.     }
  55. }
  • ②注册到Spring的容器中：
  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  6. import com.example.mp.plugins.MyInterceptor;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. /**
  11.  * @author 许大仙
  12.  * @version 1.0
  13.  * @since 2021-06-18 22:42
  14.  */
  15. @Configuration
  16. public class MybatisPlusConfig {
  18.     // 配置分页插件
  19.     @Bean
  20.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  21.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  22.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
  23.         return interceptor;
  24.     }
  26.     /**
  27.      * 注册 插件
  28.      *
  29.      * @return
  30.      */
  31.     @Bean
  32.     public MyInterceptor myInterceptor() {
  33.         return new MyInterceptor();
  34.     }
  35. }

2.2 防止全表更新与删除插件

  • 在MP中提供了防止全表更新与删除插件。

注意：此插件仅适用于开发环境，不适用于生产环境。

  • 示例：
  • ①配置防止全表更新与删除的插件
  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
  6. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. /**
  11.  * @author 许大仙
  12.  * @version 1.0
  13.  * @since 2021-06-18 22:42
  14.  */
  15. @Configuration
  16. public class MybatisPlusConfig {
  19.     @Bean
  20.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  21.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  22.         //配置分页插件
  23.         PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
  24.         interceptor.addInnerInterceptor(paginationInnerInterceptor);
  25.         //配置防止全表更新与删除的插件
  26.         BlockAttackInnerInterceptor blockAttackInnerInterceptor = new BlockAttackInnerInterceptor();
  27.         interceptor.addInnerInterceptor(blockAttackInnerInterceptor);
  29.         return interceptor;
  30.     }
  32. }
  • ②测试：
  1. package com.example.mp;
  3. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4. import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
  5. import com.example.mp.domain.User;
  6. import com.example.mp.mapper.UserMapper;
  7. import org.junit.jupiter.api.Test;
  8. import org.mybatis.spring.MyBatisSystemException;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.boot.test.context.SpringBootTest;
  12. /**
  13.  * @author 许大仙
  14.  * @version 1.0
  15.  * @since 2021-06-18 19:22
  16.  */
  17. @SpringBootTest
  18. public class TestUpdate {
  19.     @Autowired
  20.     private UserMapper userMapper;
  22.     @Test
  23.     public void test() {
  24.         //封装更新字段的对象
  25.         User user = new User();
  26.         user.setAge(18);
  28.         try {
  29.             int result = userMapper.update(user, null);
  30.             System.out.println("result = " + result);
  31.         } catch (MyBatisSystemException e) {
  32.             e.printStackTrace();
  33.         }
  34.     }
  35. }
  • ③结果。

防止全表更新与删除插件.png

2.3 乐观锁插件

2.3.1 主要适用场景

  • 当要更新一条记录的时候，希望这条记录没有被别人更新。
  • 乐观锁实现方式：
    • ①取出记录时，获取当前version。
    • ②更新时，带上这个version。
    • ③执行更新时， set version = newVersion where version = oldVersion。
    • ④如果version不对，就更新失败。

2.3.2 插件配置

  • 乐观锁配置：
  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
  6. import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
  7. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  8. import org.springframework.context.annotation.Bean;
  9. import org.springframework.context.annotation.Configuration;
  11. /**
  12.  * @author 许大仙
  13.  * @version 1.0
  14.  * @since 2021-06-18 22:42
  15.  */
  16. @Configuration
  17. public class MybatisPlusConfig {
  20.     @Bean
  21.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  22.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  23.         //配置分页插件
  24.         PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
  25.         interceptor.addInnerInterceptor(paginationInnerInterceptor);
  26.         //乐观锁配置
  27.         OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor = new OptimisticLockerInnerInterceptor();
  28.         interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor);
  29.         //配置防止全表更新与删除的插件
  30.         BlockAttackInnerInterceptor blockAttackInnerInterceptor = new BlockAttackInnerInterceptor();
  31.         interceptor.addInnerInterceptor(blockAttackInnerInterceptor);
  33.         return interceptor;
  34.     }
  36. }

2.3.3 注解实体字段

  • 需要为实体字段添加@Version注解。
  • ①修改表，添加version字段，并且设置初始值为1。
  1. ALTER TABLE `tb_user` ADD COLUMN `version` int NULL ;
  1. UPDATE `tb_user` SET `version`='1';
  • ②为User实体对象添加version字段，并且添加@Version注解。
  1. package com.example.mp.domain;
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableField;
  5. import com.baomidou.mybatisplus.annotation.TableId;
  6. import com.baomidou.mybatisplus.annotation.Version;
  7. import lombok.AllArgsConstructor;
  8. import lombok.Data;
  9. import lombok.NoArgsConstructor;
  10. import lombok.ToString;
  11. import lombok.experimental.Accessors;
  13. import java.io.Serializable;
  15. /**
  16.  * @author 许大仙
  17.  * @version 1.0
  18.  * @since 2021-06-17 21:01
  19.  */
  20. @Data
  21. @NoArgsConstructor
  22. @AllArgsConstructor
  23. //@TableName("tb_user")
  24. @ToString
  25. @Accessors(chain = true)
  26. public class User implements Serializable {
  28.     @TableId(type= IdType.AUTO)
  29.     private Long id;
  31.     @TableField("user_name") //解决字段名不一致
  32.     private String username;
  34.     private String password;
  36.     private String name;
  38.     private Integer age;
  40.     private String email;
  42.     @Version
  43.     private Integer version;
  45. }

2.3.4 测试

  • 测试：
  1. package com.example.mp;
  3. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4. import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
  5. import com.example.mp.domain.User;
  6. import com.example.mp.mapper.UserMapper;
  7. import org.junit.jupiter.api.Test;
  8. import org.mybatis.spring.MyBatisSystemException;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.boot.test.context.SpringBootTest;
  12. /**
  13.  * @author 许大仙
  14.  * @version 1.0
  15.  * @since 2021-06-18 19:22
  16.  */
  17. @SpringBootTest
  18. public class TestUpdate {
  19.     @Autowired
  20.     private UserMapper userMapper;
  22.     @Test
  23.     public void testOptimisticLocker() {
  24.         //先查询再修改，会触发乐观锁配置，即实体对象中要有version字段值
  25.         User user = userMapper.selectById(1);
  27.         user.setUsername("许大仙");
  29.         int result = userMapper.updateById(user);
  30.         System.out.println("result = " + result);
  31.     }
  33. }

乐观锁插件.png

2.3.5 特别说明

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

第三章：SQL注入器

3.1 概述

  • 我们知道，在MP中，通过AbstractSqlInjector将BaseMapper中的方法注入到Mybatis容器中，这样这些方法才可以正常执行。
  • 那么，我们如果需要扩充BaseMapper中的方法，又该如何实现。

3.2 编写MyBaseMapper

  • MyBaseMapper.java
  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  5. import java.util.List;
  7. public interface MyBaseMapper<T> extends BaseMapper<T> {
  9.     List<T> findALl();
  11. }
  • 其他的Mapper都可以继承该Mapper，这样实现了统一的扩展：
  1. package com.example.mp.mapper;
  3. import com.example.mp.config.MyBaseMapper;
  4. import com.example.mp.domain.User;
  5. import org.apache.ibatis.annotations.Mapper;
  7. /**
  8.  * @author 许大仙
  9.  * @version 1.0
  10.  * @since 2021-06-17 21:10
  11.  */
  12. @Mapper
  13. public interface UserMapper extends MyBaseMapper<User> {
  15. }

3.3 编写FindAll

  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.core.injector.AbstractMethod;
  4. import com.baomidou.mybatisplus.core.metadata.TableInfo;
  5. import org.apache.ibatis.mapping.MappedStatement;
  6. import org.apache.ibatis.mapping.SqlSource;
  8. public class FindAll extends AbstractMethod {
  9.     @Override
  10.     public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
  11.         String sqlMethod = "findAll";
  12.         String sql = "select * from " + tableInfo.getTableName();
  13.         SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql,
  14.                 modelClass);
  15.         return this.addSelectMappedStatementForTable(mapperClass, sqlMethod, sqlSource, tableInfo);
  16.     }
  17. }

3.4 编写MySqlInjector

  • 如果直接继承AbstractSqlInjector的话，原有的BaseMapper中的方法将失效，我们选择继承DefaultSqlInjector来实现扩展。
  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.core.injector.AbstractMethod;
  4. import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
  5. import org.springframework.stereotype.Component;
  7. import java.util.List;
  9. @Component
  10. public class MySqlInjector extends DefaultSqlInjector {
  12.     @Override
  13.     public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
  14.         List<AbstractMethod> methodList = super.getMethodList(mapperClass);
  15.         methodList.add(new FindAll());
  16.         return methodList;
  17.     }
  18. }

3.5 测试

  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import com.example.mp.mapper.UserMapper;
  5. import org.junit.jupiter.api.Test;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.boot.test.context.SpringBootTest;
  9. import java.util.List;
  12. @SpringBootTest
  13. class MpApplicationTests {
  15.     @Autowired
  16.     private UserMapper userMapper;
  18.     @Test
  19.     public void test(){
  20.         List<User> userList = userMapper.findAll();
  21.         System.out.println("userList = " + userList);
  22.     }
  23. }

第四章：自动填充

4.1 概述

  • 有些时候，我们可能会有这样的需求，插入或更新数据的时候，希望有些字段可以自动填充数据，比如：密码、version等。在MP中提供了这样的功能，可能实现自动填充。

4.2 添加@TableField注解

  • User.java
  1. package com.example.mp.domain;
  3. import com.baomidou.mybatisplus.annotation.*;
  4. import lombok.AllArgsConstructor;
  5. import lombok.Data;
  6. import lombok.NoArgsConstructor;
  7. import lombok.ToString;
  8. import lombok.experimental.Accessors;
  10. import java.io.Serializable;
  11. import java.util.Date;
  13. /**
  14.  * @author 许大仙
  15.  * @version 1.0
  16.  * @since 2021-06-17 21:01
  17.  */
  18. @Data
  19. @NoArgsConstructor
  20. @AllArgsConstructor
  21. @ToString
  22. @Accessors(chain = true)
  23. public class User implements Serializable {
  25.     @TableId(type = IdType.AUTO)
  26.     private Long id;
  28.     @TableField("user_name") //解决字段名不一致
  29.     private String username;
  31.     private String password;
  33.     private String name;
  35.     private Integer age;
  37.     private String email;
  39.     @Version
  40.     private Integer version;
  42.     /**
  43.      * 为createTime添加自动填充功能，在新增数据的时候有效
  44.      */
  45.     @TableField(value = "create_time",fill = FieldFill.INSERT)
  46.     private Date createTime;
  48.     /**
  49.      * 为updateTime添加自动填充功能，在更新数据的时候有效
  50.      */
  51.     @TableField(value = "update_time",fill = FieldFill.UPDATE)
  52.     private Date updateTime;
  55. }
  • sql脚本：
  1. ALTER TABLE `tb_user` ADD COLUMN `create_time` datetime NULL ;
  1. ALTER TABLE `tb_user` ADD COLUMN `update_time` datetime NULL ;
  • FieldFill提供了多种模式选择：
  1. public enum FieldFill {
  2.     /**
  3.      * 默认不处理
  4.      */
  5.     DEFAULT,
  6.     /**
  7.      * 插入时填充字段
  8.      */
  9.     INSERT,
  10.     /**
  11.      * 更新时填充字段
  12.      */
  13.     UPDATE,
  14.     /**
  15.      * 插入和更新时填充字段
  16.      */
  17.     INSERT_UPDATE
  18. }

4.3 自定义MetaObjectHandler

  1. package com.example.mp.config;
  3. import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  4. import lombok.extern.slf4j.Slf4j;
  5. import org.apache.ibatis.reflection.MetaObject;
  6. import org.springframework.stereotype.Component;
  8. import java.util.Date;
  10. @Slf4j
  11. @Component
  12. public class MPMetaObjectHandler implements MetaObjectHandler {
  14.     @Override
  15.     public void insertFill(MetaObject metaObject) {
  16.         this.strictInsertFill(metaObject, "createTime", () -> new Date(), Date.class);
  17.     }
  19.     @Override
  20.     public void updateFill(MetaObject metaObject) {
  21.         this.strictUpdateFill(metaObject, "updateTime", () -> new Date(), Date.class);
  22.     }
  23. }

4.4 测试

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import com.example.mp.mapper.UserMapper;
  5. import org.junit.jupiter.api.Test;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.boot.test.context.SpringBootTest;
  9. import java.util.List;
  12. @SpringBootTest
  13. class MpApplicationTests {
  15.     @Autowired
  16.     private UserMapper userMapper;
  18.     @Test
  19.     public void testInsert(){
  20.         User user = new User();
  21.         user.setUsername("zhangsan");
  22.         user.setPassword("123456");
  23.         user.setName("张三");
  24.         user.setAge(18);
  25.         user.setEmail("123456@qq.com");
  27.         int count = userMapper.insert(user);
  28.         System.out.println("count = " + count); //数据库受影响的行数
  29.         System.out.println("user.getId() = " + user.getId()); //自增后的id会回填到对象中
  30.     }
  31. }
  • 结果：

自动填充结果.png

第五章：逻辑删除

5.1 概述

  • 开发系统的时候，有时候在实现功能的时候，删除操作需要实现逻辑删除，所谓的逻辑删除就是将数据标记为删除，而非真正的物理删除（非DELETE操作），查询的时候需要携带状态条件，确保被标记的数据不被查询到。这样做的目的就是避免数据被真正的删除。

5.2 修改表结构

  • 为tb_user表添加deleted字段，用于表示数据是否被删除，1代表删除，0代表未删除。
  1. ALTER TABLE `tb_user` ADD COLUMN `deleted` INT ( 1 ) NULL DEFAULT 0 COMMENT '1代表删除，0代表未删除' AFTER `version`;
  • 修改User实体，增加deleted属性，并添加@TableLogic注解。
  1. package com.example.mp.domain;
  3. import com.baomidou.mybatisplus.annotation.*;
  4. import lombok.AllArgsConstructor;
  5. import lombok.Data;
  6. import lombok.NoArgsConstructor;
  7. import lombok.ToString;
  8. import lombok.experimental.Accessors;
  10. import java.io.Serializable;
  11. import java.util.Date;
  13. /**
  14.  * @author 许大仙
  15.  * @version 1.0
  16.  * @since 2021-06-17 21:01
  17.  */
  18. @Data
  19. @NoArgsConstructor
  20. @AllArgsConstructor
  21. @ToString
  22. @Accessors(chain = true)
  23. public class User implements Serializable {
  25.     @TableId(type = IdType.AUTO)
  26.     private Long id;
  28.     @TableField("user_name") //解决字段名不一致
  29.     private String username;
  31.     private String password;
  33.     private String name;
  35.     private Integer age;
  37.     private String email;
  39.     @Version
  40.     private Integer version;
  42.     /**
  43.      * 为createTime添加自动填充功能，在新增数据的时候有效
  44.      */
  45.     @TableField(value = "create_time",fill = FieldFill.INSERT)
  46.     private Date createTime;
  48.     /**
  49.      * 为updateTime添加自动填充功能，在更新数据的时候有效
  50.      */
  51.     @TableField(value = "update_time",fill = FieldFill.UPDATE)
  52.     private Date updateTime;
  54.     @TableLogic
  55.     private Integer deleted;
  56. }

5.3 配置

  • application.yml
  1. # MP配置
  2. mybatis-plus:
  3.   global-config:
  4.     db-config:
  5.       table-prefix: tb_
  6.       logic-delete-field: deleted #全局逻辑删除的实体字段名
  7.       logic-delete-value: 1 # 逻辑已删除值
  8.       logic-not-delete-value: 0 # 逻辑未删除值
  9.   configuration:
  10.     # 开启日志
  11.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

5.4 测试

  • 测试删除：
  1. package com.example.mp;
  3. import com.example.mp.mapper.UserMapper;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.boot.test.context.SpringBootTest;
  8. /**
  9.  * @author 许大仙
  10.  * @version 1.0
  11.  * @since 2021-06-18 20:04
  12.  */
  13. @SpringBootTest
  14. public class TestDeleteById {
  15.     @Autowired
  16.     private UserMapper userMapper;
  18.     @Test
  19.     public void test(){
  20.         //执行删除操作
  21.         int result = userMapper.deleteById(6);
  22.         System.out.println("result = " + result);
  23.     }
  25. }
  • 结果：

测试逻辑删除的结果.png

  • 测试查询：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import com.example.mp.mapper.UserMapper;
  5. import org.junit.jupiter.api.Test;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.boot.test.context.SpringBootTest;
  9. /**
  10.  * @author 许大仙
  11.  * @version 1.0
  12.  * @since 2021-06-18 21:00
  13.  */
  14. @SpringBootTest
  15. public class TestSelectById {
  16.     @Autowired
  17.     private UserMapper userMapper;
  19.     @Test
  20.     public void test(){
  21.         //根据id查询数据
  22.         User user = userMapper.selectById(6);
  23.         System.out.println("user = " + user);
  24.     }
  25. }
  • 结果：

测试逻辑删除查询的结果.png

第六章：通用枚举

6.1 概述

  • 解决了繁琐的配置，让 mybatis 优雅的使用枚举属性！

6.2 修改表结构

  1. ALTER TABLE `tb_user`
  2. ADD COLUMN `sex` int(1) NULL DEFAULT 1 COMMENT '1-男，2-女' AFTER `deleted`;

6.3 定义枚举

  1. package com.example.mp.enums;
  3. import com.baomidou.mybatisplus.annotation.IEnum;
  5. public enum SexEnum implements IEnum<Integer> {
  7.     MAN(1,"男"),
  8.     WOMAN(2,"女");
  10.     private int value;
  12.     private String desc;
  14.     SexEnum(int value, String desc) {
  15.         this.value = value;
  16.         this.desc = desc;
  17.     }
  19.     @Override
  20.     public Integer getValue() {
  21.         return value;
  22.     }
  23. }

6.4 配置

  • application.yml
  1. # MP配置
  2. mybatis-plus:
  3.   global-config:
  4.     db-config:
  5.       table-prefix: tb_
  6.       logic-delete-field: deleted #全局逻辑删除的实体字段名
  7.       logic-delete-value: 1 # 逻辑已删除值
  8.       logic-not-delete-value: 0 # 逻辑未删除值
  9.   configuration:
  10.     # 开启日志
  11.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  12.   # 配置枚举包扫描  
  13.   type-enums-package: com.example.mp.enums

6.5 修改实体

  1. package com.example.mp.domain;
  3. import com.baomidou.mybatisplus.annotation.*;
  4. import com.example.mp.enums.SexEnum;
  5. import lombok.AllArgsConstructor;
  6. import lombok.Data;
  7. import lombok.NoArgsConstructor;
  8. import lombok.ToString;
  9. import lombok.experimental.Accessors;
  11. import java.io.Serializable;
  12. import java.util.Date;
  14. /**
  15.  * @author 许大仙
  16.  * @version 1.0
  17.  * @since 2021-06-17 21:01
  18.  */
  19. @Data
  20. @NoArgsConstructor
  21. @AllArgsConstructor
  22. @ToString
  23. @Accessors(chain = true)
  24. public class User implements Serializable {
  26.     @TableId(type = IdType.AUTO)
  27.     private Long id;
  29.     @TableField("user_name") //解决字段名不一致
  30.     private String username;
  32.     private String password;
  34.     private String name;
  36.     private Integer age;
  38.     private String email;
  40.     //性别为枚举
  41.     private SexEnum sex;
  43.     @Version
  44.     @TableField(value = "version", fill = FieldFill.INSERT)
  45.     private Integer version;
  47.     /**
  48.      * 为createTime添加自动填充功能，在新增数据的时候有效
  49.      */
  50.     @TableField(value = "create_time", fill = FieldFill.INSERT)
  51.     private Date createTime;
  53.     /**
  54.      * 为updateTime添加自动填充功能，在更新数据的时候有效
  55.      */
  56.     @TableField(value = "update_time", fill = FieldFill.UPDATE)
  57.     private Date updateTime;
  59.     @TableLogic
  60.     private Integer deleted;
  62. }

6.6 测试

  • 示例：
  1. package com.example.mp;
  3. import com.example.mp.domain.User;
  4. import com.example.mp.enums.SexEnum;
  5. import com.example.mp.mapper.UserMapper;
  6. import org.junit.jupiter.api.Test;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.boot.test.context.SpringBootTest;
  10. import java.util.List;
  13. @SpringBootTest
  14. class MpApplicationTests {
  16.     @Autowired
  17.     private UserMapper userMapper;
  19.     @Test
  20.     public void testInsert(){
  21.         User user = new User();
  22.         user.setUsername("wangba");
  23.         user.setPassword("123456");
  24.         user.setName("王八");
  25.         user.setAge(18);
  26.         user.setEmail("123456@qq.com");
  27.         user.setSex(SexEnum.MAN);
  29.         int count = userMapper.insert(user);
  30.         System.out.println("count = " + count); //数据库受影响的行数
  31.         System.out.println("user.getId() = " + user.getId()); //自增后的id会回填到对象中
  32.     }
  34. }
  • 结果：

通用枚举结果.png

第七章：代码生成器

7.1 概述

  • AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

7.2 创建工程

  • pom.xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.5.1</version>
  9.         <relativePath/>
  10.     </parent>
  11.     <groupId>com.example</groupId>
  12.     <artifactId>mp-generator</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>mp-generator</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>11</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.projectlombok</groupId>
  26.             <artifactId>lombok</artifactId>
  27.             <optional>true</optional>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>mysql</groupId>
  31.             <artifactId>mysql-connector-java</artifactId>
  32.             <scope>runtime</scope>
  33.         </dependency>
  34.         <dependency>
  35.             <groupId>org.springframework.boot</groupId>
  36.             <artifactId>spring-boot-starter-test</artifactId>
  37.             <scope>test</scope>
  38.         </dependency>
  39.         <!-- mybatis-plus对SpringBoot的支持 -->
  40.         <dependency>
  41.             <groupId>com.baomidou</groupId>
  42.             <artifactId>mybatis-plus-boot-starter</artifactId>
  43.             <version>3.4.3.1</version>
  44.         </dependency>
  45.         <dependency>
  46.             <groupId>com.baomidou</groupId>
  47.             <artifactId>mybatis-plus-generator</artifactId>
  48.             <version>3.4.1</version>
  49.         </dependency>
  50.         <dependency>
  51.             <groupId>org.freemarker</groupId>
  52.             <artifactId>freemarker</artifactId>
  53.             <version>2.3.31</version>
  54.         </dependency>
  55.     </dependencies>
  57.     <build>
  58.         <plugins>
  59.             <plugin>
  60.                 <groupId>org.springframework.boot</groupId>
  61.                 <artifactId>spring-boot-maven-plugin</artifactId>
  62.             </plugin>
  63.         </plugins>
  64.     </build>
  66. </project>

7.3 生成器代码

  1. package com.example.mp.generator;
  3. import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
  4. import com.baomidou.mybatisplus.core.toolkit.StringUtils;
  5. import com.baomidou.mybatisplus.generator.AutoGenerator;
  6. import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  7. import com.baomidou.mybatisplus.generator.config.GlobalConfig;
  8. import com.baomidou.mybatisplus.generator.config.PackageConfig;
  9. import com.baomidou.mybatisplus.generator.config.StrategyConfig;
  10. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  11. import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  13. import java.util.Scanner;
  15. public class MysqlGenerator {
  16.     /**
  17.      * <p>
  18.      * 读取控制台内容
  19.      * </p>
  20.      */
  21.     public static String scanner(String tip) {
  22.         Scanner scanner = new Scanner(System.in);
  23.         StringBuilder help = new StringBuilder();
  24.         help.append("请输入" + tip + "：");
  25.         System.out.println(help);
  26.         if (scanner.hasNext()) {
  27.             String ipt = scanner.next();
  28.             if (StringUtils.isNotBlank(ipt)) {
  29.                 return ipt;
  30.             }
  31.         }
  32.         throw new MybatisPlusException("请输入正确的" + tip + "！");
  33.     }
  35.     /**
  36.      * RUN THIS
  37.      */
  38.     public static void main(String[] args) {
  39.         // 代码生成器
  40.         AutoGenerator mpg = new AutoGenerator();
  42.         // 全局配置
  43.         GlobalConfig gc = new GlobalConfig();
  44.         String projectPath = System.getProperty("user.dir");
  45.         gc.setOutputDir(projectPath + "/src/main/java");
  46.         gc.setAuthor("许大仙");
  47.         gc.setOpen(false);
  48.         // gc.setSwagger2(true); 实体属性 Swagger2 注解
  49.         mpg.setGlobalConfig(gc);
  51.         // 数据源配置
  52.         DataSourceConfig dsc = new DataSourceConfig();
  53.         dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false&serverTimezone=GMT%2B8&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true");
  54.         // dsc.setSchemaName("public");
  55.         dsc.setDriverName("com.mysql.cj.jdbc.Driver");
  56.         dsc.setUsername("root");
  57.         dsc.setPassword("123456");
  58.         mpg.setDataSource(dsc);
  60.         // 包配置
  61.         PackageConfig pc = new PackageConfig();
  62.         pc.setModuleName(scanner("模块名"));
  63.         pc.setParent("com.example.mp.generator");
  64.         mpg.setPackageInfo(pc);
  66. //        // 自定义配置
  67. //        InjectionConfig cfg = new InjectionConfig() {
  68. //            @Override
  69. //            public void initMap() {
  70. //                // to do nothing
  71. //            }
  72. //        };
  73. //        List<FileOutConfig> focList = new ArrayList<>();
  74. //        focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
  75. //            @Override
  76. //            public String outputFile(TableInfo tableInfo) {
  77. //                // 自定义输入文件名称
  78. //                return projectPath + "/xudaxain-mp-generator/src/main/resources/mapper/" + pc.getModuleName()
  79. //                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  80. //            }
  81. //        });
  82. //        cfg.setFileOutConfigList(focList);
  83. //        mpg.setCfg(cfg);
  84. //        mpg.setTemplate(new TemplateConfig().setXml(null));
  86.         // 策略配置
  87.         StrategyConfig strategy = new StrategyConfig();
  88.         strategy.setNaming(NamingStrategy.underline_to_camel);
  89.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  90. //        strategy.setSuperEntityClass("com.baomidou.mybatisplus.samples.generator.common.BaseEntity");
  91.         strategy.setEntityLombokModel(true);
  92. //        strategy.setSuperControllerClass("com.baomidou.mybatisplus.samples.generator.common.BaseController");
  93.         strategy.setInclude(scanner("表名"));
  94.         strategy.setSuperEntityColumns("id");
  95.         strategy.setControllerMappingHyphenStyle(true);
  96.         strategy.setTablePrefix(pc.getModuleName() + "_");
  97.         mpg.setStrategy(strategy);
  98.         // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
  99.         mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  100.         mpg.execute();
  101.     }
  102. }