Mybatis-Plus——极速上手

本文主要是介绍Mybatis-Plus的快速上手，可以跳过简介和特点，属于实操篇，看过本文之后可以快速的操作数据库的单表。

学习文章参考：

Mybatis-Plus-【通俗易懂全讲解】

Mybatis-Plus详解

以上两篇文章详细的介绍了Mybatis-Plus的内容：代码生成器、条件构造器、分页查询、乐观锁应用等。博主是参照上面两篇文章学习的。

简介

MyBatis-Plus 简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

MyBatis-Plus官网

特点（来自官网）

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作

• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求

• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题

• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作

• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询

• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

• 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

极速入门

案例采用操作单表进行演示，对Person实体类进行CURD操作。

数据库准备

准备好数据表（person），这里使用的是Oracle的数据库

create table "person"
(
    id int constraint USER_PK primary key,
    username varchar(20),
    password varchar(150),
    age int,
    email varchar(50)
)
/

导入依赖

<!--jdbc的依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!--mybatis-plus的依赖-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.0</version>
</dependency>
<!--数据库依赖-->
...

准备实体类

这里采用的是Lombok来快速生成构造方法、getter和setter

@Data//自动生成所有的getter、setter
@AllArgsConstructor//生成所有参数的构造方法
@NoArgsConstructor//生成无参构造
public class Person {
    private Integer id;//用户id
    private String username;//用户名
    private String password;//密码
    private Integer age;//年龄
    private String email;//邮箱
}

然后编写mapper

以往我们使用mybatis的时候是写一个PersonMapper的接口，然后自定义方法，然后在xml文件中去做映射，而mybatis-plus只需要写一个mapper接口继承BaseMapper就行了

@Repository
public interface PersonMapper extends BaseMapper<Person> {
​
}

因为在BaseMapper里面已经定义好了很多方法，所以我们继承之后就能直接使用

添加注解

在启动类上面添加注解 @MapperScan，就是扫描那些地方写了你自己的Mapper

@SpringBootApplication
@MapperScan("com.wang.mapper")//后面接的是包名
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class,args);
    }
}

OK，入门步骤已经完成，非常的简单，只需要：

1. 创建数据表

2. 编写实体类

3. 写一个接口继承BaseMapper<T>

测试

测试一下：插入方法

@SpringBootTest
public class PersonMapperTest {
    
    @Autowired
    PersonMapper personMapper;
​
    @Test
    public void testInsert(){
        int i = personMapper.insert(
                new Person(2, "testName", "123456", 19, "xxx@123.com")
        );
        System.out.println("success, "+ i +" rows changed!");
    }
​
}

测试结果：

success, 1 rows changed !

可以看到，已经新增了一条数据

 

自动装配时间

在阿里巴巴的的开发者手册中写道，基本所有的表都应该配有字段：创建时间和修改时间，在博主的公司中也有类似的要求，所以学习了一下mybatis-plus的自动装配时间的方法。

准备工作

本案例下，先修改一下表，增加两个字段：create_time 和 update_time

然后在相应的实体类Person中添加相应的属性：

...
private Date createTime;//创建时间
private Date updateTime;//修改时间

填充时间

重点来了，完成时间的自动填充需要两步：

1. 在新增的两个属性上面添加注解@TableField，然后注明什么时候进行自动填充

   @TableField(value = "create_time",fill = FieldFill.INSERT)
   //value代表的是数据库中的字段名字，fill代表填充：这里是在插入的时候自动填充
   private Date createTime;
   ​
   @TableField(value = "update_time",fill = FieldFill.INSERT_UPDATE)
   //这里是在插入和更新的时候自动填充
   private Date updateTime;

2. 然后编写一下插入的规则，创建类实现MetaObjectHandler接口，重写他的两个方法，这个处理器可以在所有需要自动装配时间的实体类上面运行。

   @Component
   public class MyMetaObjectHandler implements MetaObjectHandler {
       @Override
       public void insertFill(MetaObject metaObject) {
           this.setFieldValByName("createTime",new Date(),metaObject);
           this.setFieldValByName("updateTime",new Date(),metaObject);
       }
   ​
       @Override
       public void updateFill(MetaObject metaObject) {
           this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
       }
   }

测试

@Test
public void testInsert(){
    Person person = new Person();
    person.setId(3);
    person.setAge(18);
    person.setEmail("example@qq.com");
    person.setUsername("test");
    person.setPassword("123456");
    
    //可以看到我们并没有插入时间
    int i = personMapper.insert(person);
    System.out.println("success, "+ i +" rows changed!");
}

测试结果

自动插入时间了