Mybatis-Plus的使用详解

一、准备工作

1、导入相关依赖

   	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
 	<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    //Mybatis-Plus依赖
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.1.1</version>
    </dependency>

2、文件目录结构

User类

@Data
public class User {
    private int id;
    private String name;
    private int age;
    private String email;

	//用于Mybatis-Plus自动填充功能
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

UserMapper接口

@Repository
public interface UserMapper extends BaseMapper<User> {

}

测试insert

@RunWith(SpringRunner.class)
@SpringBootTest
public class CRUDTests {
    @Autowired
    private UserMapper userMapper;
    
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("Helen");
        user.setAge(18);
        user.setEmail("55317332@qq.com");
        
        int result = userMapper.insert(user);
        System.out.println(result); //影响的行数
        System.out.println(user); //id自动回填
    }
}

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

3、主键策略

（1）ID_WORKER

 MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID
 参考资料：分布式系统唯一ID生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

（2）自增策略

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

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

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

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

@Getter
public enum IdType {
    /**
     * 数据库ID自增
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型
     */
    NONE(1),
    /**
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充
     */
    INPUT(2),
    
	/* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
	/**
	 * 全局唯一ID (idWorker)
	 */
	ID_WORKER(3),
	/**
	 * 全局唯一ID (UUID)
	 */
	UUID(4),
	/**
	 * 字符串全局唯一ID (idWorker 的字符串表示)
	 */
	ID_WORKER_STR(5);
	
	private int key;
	
	IdType(int key) {
	    this.key = key;
	}
}

3、update
(1) 根据Id更新操作
注意：update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=?

(2)、自动填充

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

① 数据库表中添加自动填充字段
在User表中添加datetime类型的新的字段 create_time、update_time
② 实体上添加注解

@Data
public class User {
    ...

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

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

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

        this.setFieldValByName("createTime", new Date(), metaObject);

        this.setFieldValByName("updateTime", new Date(), metaObject);

    }

    @Override
    public void updateFill(MetaObject metaObject) {

        logger.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

④ 测试

（3）乐观锁

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

测试乐观锁
插入数据自动填充的时候设置版本初始值为1

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

        this.setFieldValByName("createTime", new Date(), metaObject);

        this.setFieldValByName("updateTime", new Date(), metaObject);

        this.setFieldValByName("version",1,metaObject);

    }

 //测试乐观锁(先查再改)
    @Test
    public void testOptimisticLocker() {
        User user = userMapper.selectById(7);
        user.setEmail("8999");

        userMapper.updateById(user);
    }

4、select

1、根据id查询记录

2、根据多个id批量查询

 //测试根据多个id批量查询
    @Test
    public void testSelectDemo1() {
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));
        System.out.println(users);

    }

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

@Configuration
@MapperScan("com.coderkun.mpdemo.mapper")
public class MpConfig {

    /*乐观锁插件*/
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }

    /*分页插件*/
    @Bean
    public PaginationInterceptor paginationInterceptor(){
        return new PaginationInterceptor();
    }
}

2）测试

//测试分页
@Test
public void testPagination() {
    Page page = new Page(1,5);
    userMapper.selectPage(page,null);

    System.out.println(page.getCurrent());//当前第几页
    System.out.println(page.getRecords());//当前页数据List集合
    System.out.println(page.getSize());//每页显示的记录数
    System.out.println(page.getTotal());//总记录数
    System.out.println(page.hasNext()); //是否有下一页
    System.out.println(page.hasPrevious());//是否有上一页

}

5、delete

（1）物理删除

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

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

（2）逻辑删除
① 数据库中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

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

@Data
public class User {
    private int id;
    private String name;
    private int age;
    private String email;
    //版本号
    @Version
    @TableField(fill = FieldFill.INSERT)
    private Integer version;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableLogic  //逻辑删除
    @TableField(fill = FieldFill.INSERT)
    private Boolean deleted;
}

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

@Component
public class MyMetaObjectHandler implements   MetaObjectHandler {

    private static final Logger logger = LoggerFactory.getLogger(MetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        logger.info("start insert fill ....");

       .........

        this.setFieldValByName("deleted", false, metaObject);


    }

    @Override
    public void updateFill(MetaObject metaObject) {

        logger.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

④ application.properties 加入配置

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

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

⑤ 在 MybatisPlusConfig 中注册 Bean

@Bean
 public ISqlInjector sqlInjector() {
    return new LogicSqlInjector();
}

⑥ 测试逻辑删除
测试后发现，数据并没有被删除，deleted字段的值由0变成了1
测试后分析打印的sql语句，是一条update
注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

  /*逻辑删除*/
    @Test
    public void testLoginDelete(){
        int result = userMapper.deleteById(10);
        System.out.println(result);

    }

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

   /*逻辑删除后的查询*/
    @Test
    public void testFindAllAfterLogigDel(){
        System.out.println(userMapper.selectList(null));

    }

测试后分析打印的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 中配置

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

（3）Spring Boot 中设置dev环境

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

可以针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties，也可以自定义环境名称：如test1、test2。

2、测试

（1）常规测试

   @Test
    public void insert() {
        User user = new User();
        user.setName("哈哈哈哈哈");
        user.setAge(888);
        user.setEmail("1518969392@qq.com");

        userMapper.insert(user);
    }

输出：

三、MybatisPlus-Generator便捷生成代码

public class CodeGenerator {

    @Test
    public void run() {

        // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
//        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir("F:\\spignboot_Idea\\guli_parent\\service\\service-edu" + "/src/main/java");
        gc.setAuthor("testjava");
        gc.setOpen(false); //生成后是否打开资源管理器
        gc.setFileOverride(false); //重新生成时文件是否覆盖

        gc.setServiceName("%sService");	//去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主键策略(主键类型为Long为ID_WORKER，为String为ID_WORKER_STR（char也是)
        gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
        gc.setSwagger2(true);//开启Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/gulimall?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("eduservice"); //模块名
        pc.setParent("com.coderkun");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("edu_teacher");  //对应的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
        strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀

        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作

        strategy.setRestControllerStyle(true); //restful api风格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符

        mpg.setStrategy(strategy);


        // 6、执行
        mpg.execute();
    }
}

---

欢迎关注公众号Java技术大本营，会不定期分享BAT面试资料等福利。

---