Day01-MybatisPlus

一、创建并初始化数据库

1、创建数据库：

mybatis_plus

2、创建 User 表

其表结构如下：

 其对应的数据库 Schema 脚本如下：

DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下：

DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

二、初始化工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程

Group：com.achang

Artifact：mybatis-plus

版本：2.2.1.RELEASE

---

三、添加依赖
1、引入依赖

spring-boot-starter、spring-boot-starter-test

添加：mybatis-plus-boot-starter、MySQL、lombok、

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写
 

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
    </exclusions>
</dependency>

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

<!--mysql-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

<!--lombok用来简化实体类-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring ，以避免因版本差异导致的问题

---

四、配置

在 application.properties 配置文件中添加 MySQL 数据库的相关配置：
mysql5

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=root

mysql8以上（spring boot 2.1）
注意：driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

注意：
1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，

这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or representsmore

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

五、编写代码

1、主类
在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹

注意：扫描的包名根据实际情况修改

 entity下的实体类:User

@Resource
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

 UserMapper

@Repository
public interface UserMapper extends BaseMapper<User> {
}

 启动类:

@SpringBootApplication
@MapperScan("com.czy.MybatisPlus.mapper")
public class MybatisPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class,args);
    }
}

六、开始使用

测试第一个功能，test要和主启动类的包结构一致，否则会发生

java.lang.IllegalStateException: Unable to find a @SpringBootConfiguration, you need to use @ContextConfiguration or @SpringBootTest(classes=...) with your test错误

和org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 类报错

com.czy.MybatisPlus.MybatisPlusTest

@SpringBootTest
class MybatisPlusTest {

    @Autowired
    private UserMapper userMapper;

    //测试第一个功能
    @Test
    public void findAll(){
        List<User> users = userMapper.selectList(null);
        System.out.println(users);
    }
}

七、配置日志

查看 sql 输出日志

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root



#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

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

结果 

 

五、MyBatisPlus的CRUD 接口

MybatisPlusTest.java

1、insert

1、插入操作

//测试添加功能
    @Test
    public void addUser(){
        User user = new User();
        user.setName("百里玄策");
        user.setAge(22);
        user.setEmail("1111111111");
        int insert = userMapper.insert(user);
        System.out.println("insert="+insert);//影响和行数
    }

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

2、主键策略：

（1）ID_WORKER

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

参考资料：分布式系统唯一ID生成方案汇总：

https://www.cnblogs.com/haoxinyue/p/5208136.html

（2）自增策略

要想主键自增需要配置如下主键策略

需要在创建数据表的时候设置主键自增

 实体字段中配置 @TableId(type = IdType.AUTO)(自己选择要不要配置)

@Resource
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

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

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

2、update

1、根据Id更新操作

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

//测试修改功能
    @Test
    public void updateUser(){
        User user = new User();
        user.setId(1516671899345039362L);
        user.setName("吴仁爱");
        user.setAge(24);
        userMapper.updateById(user);
    }

2、自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用 MyBatis Plus 的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

@Resource
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;

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

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

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

    @TableLogic
    private Integer deleted;
}

（3）实现元对象处理器接口

注意：不要忘记添加 @Component 注解，驼峰命名

com.czy.MybatisPlus.handler

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.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

---

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

乐观锁实现方式：

取出记录时，获取当前version

更新时，带上这个version

执行更新时， set version = newVersion where version = oldVersion

如果version不对，就更新失败
 

在提交数据时，比较当前版本号和数据库版本号是否一致，一致可提交，并将版本号+1；不一致就提交失败

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

ALTER TABLE `user` ADD COLUMN `version` INT

（2）实体类添加version字段

并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer Version;

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

com.czy.MybatisPlus.handler

public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);

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

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

特别说明:

支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime

整数类型下 newVersion = oldVersion + 1

newVersion 会回写到 entity 中

仅支持 updateById(id) 与 update(entity, wrapper) 方法

在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

3.删除

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

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

    /**
     * 逻辑删除插件
     * @return
     */
    @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }
}

4、分页

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

（1）创建配置类

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

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

 
}

//测试分页查询
    @Test
    public void testPage(){
        //1.创建page对象
        //传入两个参数，当前页 和 每页显示的记录数
        Page<User> page = new Page<>(1, 3);
        /*
        * 调用mp分页查询的方法
        * 调用mp分页查询的过程中，底层封装
        * 把分页所有的数据封装到page对象里面
        * */
        userMapper.selectPage(page,null);

        //通过page对象获取分页数据
        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.getPages());//总页数

        System.out.println(page.hasNext());//下一页
        System.out.println(page.hasPrevious());//上一页
    }

 SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE deleted=0 LIMIT 0,3