Mybatis-plus 基本操作（IDEA）

代码(可直接运行)：Mybatis-plus

---

1. 简介

• 官网：http://mp.baomidou.com/
• 参考教程：http://mp.baomidou.com/guide/
• MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

2. Mybatis-plus 入门（查询所有数据）

• 创建数据库 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');

• 创建 IDEA 工程，快速初始化一个 Spring Boot 工程
• Maven pom.xml 添加依赖

	<dependencies>
		<!-- springboot启动器 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		<!-- springboot test -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</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>
	</dependencies>

• application.properties

# 配置数据库
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?\
serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8 
spring.datasource.username=root
spring.datasource.password=Kc635908933

# mybatis日志 -- 查看 mysql 输出日志
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

# 设置程序运行的环境
spring.profiles.active=dev

• 创建实体类

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

• 编写代码 – 查询列表所有数据

	@Autowired
	private UserMapper userMapper;

	// 查询所有数据
	@Test
	public void testSelect(){
		// wrapper == MP内置的条件封装器
		List<User> userList = userMapper.selectList(null);
		userList.forEach(System.out::println);
	}

3. CRUD

3.1 insert（主键策略）

• insert

	// 插入数据
	@Test
	public void testInsert(){
		User user = new User();
		user.setName("kuangcheng");
		user.setAge(24);
		user.setEmail("635908933@qq.com");
		int result = userMapper.insert(user);
		System.out.println(result); //影响的行数
		System.out.println(user); //id自动回填
	}

• 主键策略
  mybatis-plus默认使用的主键生成的策略是IdType.ID_WORKER，根据类型随机产生一个全局唯一的ID，内容为空自动填充。

@Data
public class User {

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

    private String name;
    private Integer age;
    private String email;
    }

@TableId(type = IdType.AUTO) 实现主键自增

3.2 update

	// 更新数据
	@Test
	public void testUpdate(){
		User user = new User();
		user.setId(1L);      // id 是长整型
		user.setAge(28);

		int result = userMapper.updateById(user);
		System.out.println(result);
	}

3.3 select

• 根据 id 查询

	// 根据id查询
	@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）

	// 通过map封装查询条件
	// map中的key对应的是数据库中的列名
	@Test
	public void testSelectByMap(){
		HashMap<String, Object> map = new HashMap<>();
		map.put("name", "kc");
		map.put("age", 24);
		List<User> users = userMapper.selectByMap(map);
		users.forEach(System.out::println);
	}

• 分页查询（配置类）

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

	// 分页
	@Test
	public void testSelectPage() {
		// current-当前页；size-每页显示的记录数
		Page<User> page = new Page<>(1,5);
		userMapper.selectPage(page, null);

		page.getRecords().forEach(System.out::println);   // 当前页的list集合
		System.out.println(page.getCurrent());            // 当前页
		System.out.println(page.getPages());              // 页数
		System.out.println(page.getSize());               // 每页显示的记录数
		System.out.println(page.getTotal());              // 总记录数

		System.out.println(page.hasNext());   // 当前页是否有下一页
		System.out.println(page.hasPrevious());
	}

3.4 delete

• 简单删除

	// 简单的条件查询删除
	@Test
	public void testDeleteByMap() {
		HashMap<String, Object> map = new HashMap<>();
		map.put("name", "kc");
		map.put("age", 24);
		int result = userMapper.deleteByMap(map);
		System.out.println(result);
	}

3.5 逻辑删除

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

• 实体类添加deleted 字段

    @TableLogic  // 逻辑删除标志
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;

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

// 逻辑删除
this.setFieldValByName("deleted", 0, 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();
    }

• 执行测试

4. 自动填充

使用MyBatis Plus的自动填充功能，完成创建时间，更新时间的赋值工作

• 在实体类上添加注解
  1. @TableField(fill = FieldFill.INSERT)
  2. @TableField(fill = FieldFill.INSERT_UPDATE)

@Data
public class User {

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

    private String name;
    private Integer age;
    private String email;

    // create_time
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    // update_time
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

• 实现元对象处理器接口

import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class MyHanndler implements MetaObjectHandler {

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


        // 逻辑删除
        this.setFieldValByName("deleted", 0, metaObject);
    }

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

5. 乐观锁

适用场景：实现线程安全的数据更新；
基本思想：

• 在实体类中设置一个字段 version
• 取出记录时，获取当前version；更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

扩展：

• 悲观锁：当多个事务并发执行时，某个事务对数据应用了锁，则其他事务只能等该事务执行完了，才能进行对该数据进行修改操作。

实现步骤：

• 实体类添加version字段

    @Version  // 乐观锁版本号
    @TableField(fill = FieldFill.INSERT)
    private Integer version;

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

// 乐观锁版本号
this.setFieldValByName("version", 1, metaObject);

• 在 MybatisPlusConfig 中注册 Bean

@Configuration  //配置类
@EnableTransactionManagement   // 开启事务支持后
@MapperScan("com.mybatispulse.mapper")
public class MybatisPulseConfig {

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

6. 性能分析

• 性能分析拦截器，用于输出每条 SQL 语句及其执行时间

• SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题

• 在 MybatisPlusConfig 中配置

    // SQL执行性能分析插件
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(500);//ms，超过此处设置的ms则sql不执行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

• Spring Boot 中设置dev环境（application.properties）

# 设置程序运行的环境
spring.profiles.active=dev

7. 条件构造器（wrapper）

• UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL

@Test
public void testDelete() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper
 		.isNull("name")
 		.ge("age", 12)
 		.isNotNull("email");
	int result = userMapper.delete(queryWrapper);
	System.out.println("delete return count = " + result);
}

• SELECT COUNT(1) FROM user WHERE deleted=0 AND age BETWEEN ? AND ?

@Test
public void testSelectCount() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper.between("age", 20, 30);
	Integer count = userMapper.selectCount(queryWrapper);
	System.out.println(count);
}

• SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ?

@Test
public void testSelectMaps() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper
 		.notLike("name", "e")
 		.likeRight("email", "t");
	List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);//返回值是Map列表
	maps.forEach(System.out::println);
}

8. 创建MP代码生成器

• 根据数据库，自动创建 controller、service、mapper、entity

public class GetCode {

    @Test
    public void Getcode(){
        // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");  // 获取当前位置
        System.out.println(projectPath);
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("kc");
        gc.setOpen(false); //生成后是否打开资源管理器
        gc.setFileOverride(false); //重新生成时文件是否覆盖
        /*
         * mp生成service层代码，默认接口名称第一个字母有 I
         * UcenterService
         * */
        gc.setServiceName("%sService"); //去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主键策略
        gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
        gc.setSwagger2(true);//开启Swagger2模式
        mpg.setGlobalConfig(gc);

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

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("serviceedu"); //模块名
        pc.setParent("com.kc");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);
        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("edu_course","edu_course_description","edu_chapter","edu_video");
        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();
    }
}