MybatisPlus学习笔记

一、简介

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

特性：

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

二、快速入门

1、创建数据库mybatis_plus

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

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

2、使用SpringBoot初始化项目

3、导入依赖

<dependencies>
    <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>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

注意：尽量不要同时导入 mybatis 和 mybatis-plus！版本的差异。

4、连接数据库

spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plususeUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

5、使用Mybatis-Plus

pojo

@Data 

@AllArgsConstructor 

@NoArgsConstructor 

public class User { 

private Long id; 

private String name; 

private Integer age; 

private String email; 

} 

mapper接口

package com.kuang.mapper; 

import com.baomidou.mybatisplus.core.mapper.BaseMapper; 

import com.kuang.pojo.User; 

import org.springframework.stereotype.Repository; 

// 在对应的Mapper上面继承基本的类 BaseMapper 

@Repository // 代表持久层 

public interface UserMapper extends BaseMapper<User> { 

// 所有的CRUD操作都已经编写完成了 

// 你不需要像以前的配置一大堆文件了！ 

} 

注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口

@MapperScan(“com.kuang.mapper”)

测试

@SpringBootTest 

class MybatisPlusApplicationTests { 

// 继承了BaseMapper，所有的方法都来自己父类 

// 我们也可以编写自己的扩展方法！ 

	@Autowired 

	private UserMapper userMapper; 

	@Test 

	void contextLoads() { 

	// 参数是一个 Wrapper ，条件构造器，这里我们先不用 null 

	// 查询全部用户 

	List<User> users = userMapper.selectList(null); 
	
	users.forEach(System.out::println); 

	} 

}

三、配置日志

在配置文件中配置我们的日志信息

//控制台输出
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl 

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

四、CRUD扩展

1、插入操作

@Test
    public void insertUser() {
        User user = new User();
        user.setName("zz");
        user.setAge(7);
        user.setEmail("[e-mail]");
        int insert = userMapper.insert(user);
        System.out.println(user);
    }

2、主键生成策略

1. 默认ID_WORKER：全局唯一id

   雪花算法：

   ​ snowflflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为

   ​ 毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味

   ​ 着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯

   ​ 一。

2. 主键自增

@TableId(type = IdType.AUTO) //主键自增
private Long id;

3. 其他主键策略

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

3、更新操作

@Test
    public void updateTest() {
        User user = new User();
        // 通过条件自动拼接动态sql
        user.setName("哈哈");
        user.setAge(18);
        user.setId(7L);
        userMapper.updateById(user);
    }

sql都是自动帮你动态配置的。

4、自动填充

开发项目时，创建时间和修改时间一般都是自动化完成的。

方式一：数据库级别

1. 在表中添加字段create_time、update_time

2. 测试

方式二：代码级别

1. 在实体类上添加注解

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

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

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("insert fill ...");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

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

3. 测试

5、乐观锁

乐观锁 : 故名思意十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出现了问题， 再次更新值测试 。

**悲观锁：**故名思意十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作！

乐观锁实现方式：

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

乐观锁：

先查询，获得版本号 version = 1

– A

update user set name = “kuangshen”, version = version + 1

where id = 2 and version = 1

– B

线程抢先完成，这个时候 version = 2，会导致 A 修改失败！

update user set name = “kuangshen”, version = version + 1

where id = 2 and version = 1

MP中乐观锁的实现

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

2. 实体类上添加相应的注解

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

3. 注册组件

@MapperScan("com.eva.mapper")
@Configuration
@EnableTransactionManagement //自动开启事务管理
public class MyBatisPlusConfig {
    //乐观锁
    @Bean
    public MybatisPlusInterceptor MybatisPlusInterceptor() {
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

4. 测试

// 测试乐观锁成功！
@Test public void testOptimisticLocker(){
    // 1、查询用户信息
    User user = userMapper.selectById(1L);
    // 2、修改用户信息
    user.setName("eva");
    user.setEmail("[e-mail]");
    // 3、执行更新操作
    userMapper.updateById(user);
}

6、查询操作

// 测试查询
@Test public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}
// 测试批量查询！
@Test public void testSelectByBatchId(){ 
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}
// 按条件查询之一使用map操作
@Test public void testSelectByBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","eva");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

7、分页查询

一般项目中使用分页的种类：

1. 原始的limit分页
2. pageHelper第三方插件
3. MP分页插件

MP中分页插件的使用

1. 配置拦截器组件

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

2. 直接使用page对象

	//测试分页
    @Test
    public void pageTest() {
        Page<User> page = new Page<>(1,4);//参数：当前页，页面大小
        Page<User> userPage = userMapper.selectPage(page, null);
        userPage.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());//总共多少条数据
    }

8、删除操作

//测试删除
    @Test
    public void logicDeleteTest() {
        userMapper.deleteById(2L);
        //userMapper.deleteBatchIds(Arrays.asList(1,2,3)); //批量删除
        //userMapper.deleteByMap(new HashMap<>()); //条件删除
    }

9、逻辑删除

物理删除：从数据库中直接删除

逻辑删除：在数据库中没有被删除，只是通过一个变量让它失效（deleted = 0 —> deletd = 1）

作用：防止数据的丢失，效果类似于回收站

MP中实现逻辑删除

1. 在数据库中添加一个deleted字段

2. 在实体类上添加注解

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

3. 在配置文件中进行相应配置

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

4. 测试

10、条件构造器（Wrapper）

当使用一些复杂的sql时就可以使用它来代替

测试一下。

    @Test
    void contextLoads() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12); //age大于等于12
        Integer count = userMapper.selectCount(wrapper);
        System.out.println("总数Count："+count);
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
    @Test
    public void Test1() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .like("email","@qq.com") //模糊查询 相当于 [e-mail]%
                .le("age",18); //小于等于18
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

    @Test
    public void Test2() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .eq("name","岳小帅");
        User user = userMapper.selectOne(wrapper);//查询一条数据
        System.out.println(user);
    }

    @Test
    public void Test3() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .likeRight("email","test")  //模糊查询 相当于 test%
                .between("age",24,30); //区间查询 [24,30]

        List<User> users = userMapper.selectList(wrapper);//查询一条数据
        users.forEach(System.out::println);

    }

    @Test
    public void Test4() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // id 在子查询中查出来
        wrapper.inSql("id","select id from user where id<12");
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

    @Test
    public void Test5() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .lt("age",20)
                .orderByDesc("age"); //按年龄顺序排序
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

五、代码自动生成器

dao、pojo、service、controller都给我自己去编写完成！

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

案例 ：

import com.baomidou.mybatisplus.annotation.DbType; 

import com.baomidou.mybatisplus.annotation.FieldFill; 

import com.baomidou.mybatisplus.annotation.IdType; 

import com.baomidou.mybatisplus.annotation.TableField; 

import com.baomidou.mybatisplus.generator.AutoGenerator; 

import com.baomidou.mybatisplus.generator.config.DataSourceConfig; 

import com.baomidou.mybatisplus.generator.config.GlobalConfig; 

import com.baomidou.mybatisplus.generator.config.PackageConfig; 

import com.baomidou.mybatisplus.generator.config.StrategyConfig; 

import com.baomidou.mybatisplus.generator.config.po.TableFill; 

import com.baomidou.mybatisplus.generator.config.rules.DateType; 

import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; 

import java.util.ArrayList; 

    // 代码自动生成器 

public class KuangCode {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("狂神说"); 

    	gc.setOpen(false); 

    	gc.setFileOverride(false); // 是否覆盖 

    	gc.setServiceName("%sService"); // 去Service的I前缀 

    	gc.setIdType(IdType.ID_WORKER); 

    	gc.setDateType(DateType.ONLY_DATE); 

    	gc.setSwagger2(true); 

    	mpg.setGlobalConfig(gc); 

    	//2、设置数据源 

    	DataSourceConfig dsc = new DataSourceConfig(); 

    	dsc.setUrl("jdbc:mysql://localhost:3306/kuang_community? 

    	useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8"); 

    	dsc.setDriverName("com.mysql.cj.jdbc.Driver"); 

    	dsc.setUsername("root"); 

    	dsc.setPassword("123456"); 

    	dsc.setDbType(DbType.MYSQL); 

    	mpg.setDataSource(dsc); 

    	//3、包的配置 

    	PackageConfig pc = new PackageConfig(); 

    	pc.setModuleName("blog"); 

    	pc.setParent("com.kuang"); 

    	pc.setEntity("entity"); 

    	pc.setMapper("mapper"); 

    	pc.setService("service"); 

    	pc.setController("controller"); 

    	mpg.setPackageInfo(pc); 

    	//4、策略配置 

    	StrategyConfig strategy = new StrategyConfig(); 

    	strategy.setInclude("blog_tags","course","links","sys_settings","user_record"," 

    	user_say"); // 设置要映射的表名 

    	strategy.setNaming(NamingStrategy.underline_to_camel); 

    	strategy.setColumnNaming(NamingStrategy.underline_to_camel); 

    	strategy.setEntityLombokModel(true); // 自动lombok； 

    	strategy.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); 

    	strategy.setTableFillList(tableFills); 

    	// 乐观锁 

    	strategy.setVersionFieldName("version");strategy.setRestControllerStyle(true); 

    	strategy.setControllerMappingHyphenStyle(true); // 

    	localhost:8080/hello_id_2 

    	mpg.setStrategy(strategy); 

    	mpg.execute(); //执行 

    } 

 }