MybatisPlus

写在前面
这篇文章是跟随狂神说Java视频学习自己做的笔记
视频：https://www.bilibili.com/video/BV17E411N7KN?p=1

• MybatisPlus可以节省我们大量的工作时间，所有的CRUD代码他都可以自动生成
• MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
• 官网：https://baomidou.com/
  

快速入门

• 使用第三方组件
• 1.导入对应的依赖
• 2.研究依赖如何配置
• 3.代码如何编写
• 4.提高扩展技术能力

步骤

1.创建数据库mybatis_plus
2.创建user表

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)
);
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');

--真实开发中，还必须要有的字段,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified

3.编写项目，初始化项目，使用SpringBoot初始化
4.导入依赖

<!--数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--mybatis-plus-->
        <!--mybatis-plus是自己开发的不是官方的-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

说明：我们使用mybatis-plus可以节省我们大量代码，尽量不要同时导入mybatis和mybatis-plus
5.链接数据库，和mybatis步骤一样

spring.datasource.username=root
spring.datasource.password=000000
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8

6.传统方式pojo-dao(链接mybatis，配置mapper.xml)-service-controller
6.使用了mybatis-plus之后

• pojo

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

lombok常用注解
@Data ： 注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法
@AllArgsConstructor ： 注在类上，提供类的全参构造
@NoArgsConstructor ： 注在类上，提供类的无参构造
@Setter ： 注在属性上，提供 set 方法
@Getter ： 注在属性上，提供 get 方法
@EqualsAndHashCode ： 注在类上，提供对应的 equals 和 hashCode 方法
@Log4j/@Slf4j ： 注在类上，提供对应的 Logger 对象，变量名为 log

• mapper接口

@Repository//代表持久层
//在对应的Mapper上面继承基本的类BaseMapper
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD操作都已经编写完成了
    //你不需要再像以前一样配置一大堆文件了
}

注意点：我们需要在主启动类上去扫描我们mapper包下的所有接口@MapperScan("com.dankon.mapper")

• 测试类中的测试

@SpringBootTest
class MybatisPlusApplicationTests {
    //继承了BaseMapper，所有的方法都来自父类，我们也可以编写自己的扩展方法
    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //参数是一个wapper，条件构造器，这里我们先不用
        //查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

配置日志

• 我们所有sql现在是不可见的，我们希望指定他们是怎么执行的，所以我们必须要看日志！

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

输出结果

配置完毕日志后，后面的学习就需要注意这个自动生成的SQL

CRUD扩展

//插入测试
    @Test
    public void testInsert(){
        User user = new User();
        user.setAge(3);
        user.setEmail("dsadas@qq.com");
        user.setName("ddsadsa");

        int insert = userMapper.insert(user);//帮我们自动生成id
        System.out.println(insert);//受影响的行数
        System.out.println(user);//发现，id会自动回填
    }

结果:

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

主键生成策略

@TableId(type = IdType.ID_WORKER)默认全局唯一ID

分布式系统唯一id生成方案：https://www.cnblogs.com/haoxinyue/p/5208136.html

• 雪花算法
  snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。

主键自增

我们需要配置主键自增
1.我们需要添加注解@TableId(type = IdType.AUTO)
2.在数据库中此字段也必须为自增的

3.再次测试插入即可

其余的源码解释

	AUTO(0),//数据库id自增
    NONE(1),//未设置主键
    INPUT(2),//手动输入
    ID_WORKER(3),//默认的全局唯一id
    UUID(4),//全局唯一id uuid
    ID_WORKER_STR(5);//ID_WORKER的字符表示法

更新操作

@Test
    //测试更新
    public void testUpdate(){
        //通过条件自动拼接动态sql
        User user = new User();
        user.setId(6L);
        user.setName("dankon");
        user.setAge(18);
        //注意：updateById 的参数是一个对象
        int i = userMapper.updateById(user);
        System.out.println(i);

    }

结果：

自动填充

创建时间、修改时间！这些个操作基本上都是自动生成的，我们不希望手动更新
阿里巴巴开发手册：所有的数据库表：gmt_creat,gmt_modified，几乎所有的表都需要配置上，而且需要自动化

方式一：数据库级别

1.在表中新增字段 create_time、update_time

2.同步实体类

private Date createTime;
    private Date updateTime;

方式二：代码级别

1.删除数据库默认值，跟新操作

2.实体类字段属性上面需要添加注解

//字段添加填充内容
    @TableField( fill = FieldFill.INSERT)
    private Date createTime;
    @TableField( fill = FieldFill.UPDATE)
    private Date updateTime;

3.编写处理器处理这个注解

@Slf4j
@Component//一定不要忘记把处理器加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    //插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("star insert fill....");
        //String fieldName, Object fieldVal, MetaObject metaObject
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    //更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("star update fill....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

乐观锁

乐观锁：顾名思义十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出现了问题，就再更新测试
悲观锁：顾名思义十分悲观，它总是认为总是出现问题，无论干什么都会先去上锁，再去测试

乐观锁实现方式

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

乐观锁：1.先查询获得版本号version=1
-- A
update user set name = "dankon" ,version = version + 1
where version = 1 and id = 2

--B 线程抢先完成，这个时候version=2，会导致A修改失败
update user set name = "dankon" ,version = version + 1
where version = 1 and id = 2

Mybatis-plus乐观锁插件测试

1.给数据库中添加version字段

2.在实体类中添加相应的字段

 @Version//乐观锁的注解
 private Integer version;

3.注册组件

@MapperScan("com.dankon.mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}

4.测试一下

//测试乐观锁成功
    @Test
    public void testOptimisticLocker(){
        //查询用户信息
        User user = userMapper.selectById(1L);
        //2.修改用户信息
        user.setName("lock");
        user.setEmail("dsa5545@123.com");
        //3.执行更新操作
        userMapper.updateById(user);
    }

    //测试乐观锁失败，多线程下
    @Test
    public void testOptimisticLocker2(){
        //线程1
        User user = userMapper.selectById(1L);
        user.setName("lock1");
        user.setEmail("dsa5545@123.com");
        //模拟另一个线程执行插队操作
        User user2 = userMapper.selectById(1L);
        user2.setName("lock2");
        user2.setEmail("dsa5545@123.com");
        userMapper.updateById(user2);

        userMapper.updateById(user);//如果没有乐观锁就会覆盖插队线程的值
    }

查询操作

//测试查询
    @Test
    public void  testSelectById(){
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    //测试批量查询
    @Test
    public void  testSelectBatchIds(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }

    //按条件查询-map操作
    @Test
    public void test(){
        HashMap<String,Object> map = new HashMap<>();
        map.put("name","lock2");
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

分页查询

分页在网站使用的十分之多
1.原始的limit分页
2.pageHelper第三方插件
3.MyBatisPlus也内置了分页插件

如何使用

1.配置拦截器组件即可

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

2.直接使用page对象即可

 //测试分页查询
    @Test
    public void testPage(){
        //参数一：当前页
        //参数二：页面大小
        //使用了分页插件，所有的分页操作也变得简单了
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page,null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());
    }

删除操作

//测试删除
    @Test
    public void testDeleteById(){
        int i = userMapper.deleteById(1336647598672551938L);
        System.out.println(i);
    }

    //通过id批量删除
    @Test
    public void testDeleteBatchIds(){
        int i = userMapper.deleteBatchIds(Arrays.asList(1336647598672551939L, 6));
        System.out.println(i);
    }

    //通过Map删除
    @Test
    public void testDeleteMap(){
        HashMap<String,Object> map = new HashMap<>();
        map.put("name", "lock2");
        int i1 = userMapper.deleteByMap(map);
        System.out.println(i1);
    }

逻辑删除

物理删除：从数据库中直接删除
逻辑删除：在数据库中没有被移除，而是通过一个变量让他失效！deleted = 0 => deleted = 1

测试一下

1. 在数据库中添加一个deleted字段
   
2. 实体类中增加属性

@TableLogic//逻辑删除
private Integer deleted;

3. 配置

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

#配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

4. 测试删除操作

//测试删除
    @Test
    public void testDeleteById(){
        int i = userMapper.deleteById(2L);
        System.out.println(i);
    }

性能分析插件

我们平时的开发中，会碰到一些慢sql
作用：分析sql运行时间
MybatisPlus也提供了一些性能分析插件，如果超过这个时间就停止运行
5. 导入插件

@Bean
    @Profile({"dev","test"})
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//设置sql执行的最大时间，如果超过了就不执行
        performanceInterceptor.setFormat(true);//是否开启格式化支持
        return performanceInterceptor;
    }

在springboot中设置dev或test环境spring.profiles.active=dev
6. 测试使用

@Test
    void contextLoads() {
        //参数是一个wapper，条件构造器，这里我们先不用
        //查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

条件构造器：Wrapper

1. 测试1

@Test
    void contextLoads() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);
        userMapper.selectList(wrapper).forEach(System.out::println);
    }

2. 测试2

@Test
    void contextLoads2() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","Sandy");
        User user = userMapper.selectOne(wrapper);
        System.out.println(user);
    }

3. 测试3

@Test
    void contextLoads3() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);
        Integer integer = userMapper.selectCount(wrapper);
        System.out.println(integer);
    }

4. 测试4

@Test
    void contextLoads4() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .notLike("name","e")
                .likeRight("email","t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

5. 测试5

 @Test
    void contextLoads5() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .inSql("id","select id from user where id<3");
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

6. 测试6

@Test
    void contextLoads6() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

代码生成器

//代码生成器
public class DankonCode {
    public static void main(String[] args) {
        //需要构建一个代码自动生成器 对象
        AutoGenerator mpg = new AutoGenerator();

        //配置策略

        //1.全局配置
        GlobalConfig gc = new GlobalConfig();

        //获取当前系统路径
        String projectPath = System.getProperty("user.dir");
        //输出路径
        gc.setOutputDir(projectPath+"/src/main/java");
        //设置作者名字
        gc.setAuthor("Dankon");
        //是否打开windows文件夹
        gc.setOpen(false);
        //是否覆盖
        gc.setFileOverride(false);
        //设置服务名称,去Service的I前缀
        gc.setServiceName("%sService");
        //设置生成策略
        gc.setIdType(IdType.ID_WORKER);
        //设置日期的类型
        gc.setDateType(DateType.ONLY_DATE);
        //是否配置swagger
        gc.setSwagger2(true);

        //将全局配置放到代码生成器中
        mpg.setGlobalConfig(gc);

        //设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("000000");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3.包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.dankon");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");

        //4.策略配置
        StrategyConfig sc = new StrategyConfig();
        //表名下划线命名转驼峰命名
        sc.setNaming(NamingStrategy.underline_to_camel);
        //列的名称下划线转驼峰命名
        sc.setColumnNaming(NamingStrategy.underline_to_camel);
        //设置要映射的表明
        sc.setInclude("user");
        //是否启动lombok
        sc.setEntityLombokModel(true);
        //设置逻辑删除字段
        sc.setLogicDeleteFieldName("deleted");
        //自动填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        sc.setTableFillList(tableFills);
        //乐观锁
        sc.setVersionFieldName("version");
        //开启Rest驼峰命名
        sc.setRestControllerStyle(true);
        sc.setControllerMappingHyphenStyle(true);//url使用下划线命名

        mpg.setStrategy(sc);
        //执行
        mpg.execute();
    }
}

需添加依赖：

 <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>