Mybatis-Plus 快速入门

一、why

不做重复的 CRUD 操作

问题1：EmployeeMapper 没有写 crud 方法，为什么在测试类中可以使用？

因为 EmployMapper 接口继承 BaseMapper 接口 ，该接口定义了一系列 crud 方法

问题2：代码不需要写 crud sql 语句，那为什么可以进行 crud 数据操作？

因为 Mybatis-Plus 在项目启动的时候执行 sql 解析

1. 获取 BaseMapper 接口中指定的 Employee 泛型

2. 解析泛型数据，得到 employee 的字节码对象

3. 使用内省方法解析 employee 字节码对象，得到类和属性名

4. Mybatis-Plus 以类名作为表名，属性名作为列名，进行 sql 拼接，最终得到对应 sql

二、what

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

框架结构

三、how

添加依赖

 
        org.springframework.boot
        spring-boot-starter-parent
        2.4.3
    

    

        
            com.baomidou
            mybatis-plus-boot-starter
            3.4.0
        

        
            com.alibaba
            druid-spring-boot-starter
            1.1.17
        

        
            mysql
            mysql-connector-java
            8.0.22
        

        
            org.springframework.boot
            spring-boot-starter-test
        

        
            org.projectlombok
            lombok
            1.18.16
            provided
        
    

Mysql 8 注意时区问题，配置文件的 url 加上 serverTimezone=UTC

application.properties

#mysql
spring.datasource.url=jdbc:mysql:///mybatis-plus_demo?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8
spring.datasource.username=admin
spring.datasource.password=admin
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

日志

在 application.properties 中有两种配置 sql 打印日志方式

第一种：

logging.level.cn.jere.plus.mapper=debug

第二种：

# 推荐使用,会自动换行,看 sql 语句比较舒服
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

1、常用注解

@TableName

作用：指定当前实体类映射哪张数据库表， 默认是跟实体类名一致

@TableName("t_employee")
public class Employee {
  //.....
}

@TableField

作用：指定当前属性映射数据库表哪一列， 默认是跟属性名一致

@TableName("employee")
public class Employee {
    
    @TableField(value="eName",exist = false)
    private String name;
}

exist 属性表示当前属性是否映射数据库列。实体类中若该属性在数据库没有的对应的列，要加exist=false

@TableId

作用：标记当前属性映射表主键。

@TableName("employee")
public class Employee {
    @TableId(type = IdType.AUTO) // IdType.AUTO 数据库ID自增
    private Long id;

IdType.ASSIGN_UUID 默认的 id 策略，使用雪花算法生成 long 类型的唯一 id（雪花算法用于分布式微服务）

@Version

作用：用于标记乐观锁操作字段

2、通用 Mapper 接口

insert

/**
 * 插入一条记录
 *
 * @param entity 实体对象
 */
int insert(T entity);

update

1. updateById （要注意有没有基本数据类型字段）

   使用场景：1. 条件是 id 是更新操作；2. 全量更新

// 需求： 将id=1用户名字修改为jere
   @Test
   public void updateById() {
       Employee employee = new Employee();
       employee.setId(1L);
       employee.setName("jere");
       employeeMapper.updateById(employee);
   }

sql : UPDATE employee SET name=?, age=?, admin=? WHERE id=?

tips : updateById 在拼接 sql 时，把所有非 null 字段都进行 set 拼接

2. update

   使用场景：1. 条件不仅仅是 id 更新场景（多条件）；2. 部分字段更新

   @Test
   public void update() {
       UpdateWrapper wrapper = new UpdateWrapper<>();
       wrapper.eq("id",1L);
       wrapper.set("name","jere24");
       employeeMapper.update(null,wrapper); // 
}

sql : UPDATE employee SET name=? WHERE (id = ?)

wrapper.条件 .set更新字段

delete

1. deleteById(id)

   // 需求：删除id=20的员工信息
   @Test
   public void deleteById() {
       employeeMapper.deleteById(20L); // DELETE FROM employee WHERE id=?
   }
   

2. deleteBatchIds(idList)

   // 需求：删除 id=20，id=21 的员工信息
   @Test
   public void deleteBatchIds() {
       employeeMapper.deleteBatchIds(Arrays.asList("20L","21L")); 
       // DELETE FROM employee WHERE id IN ( ? , ? )
   }
   

3. deleteByMap(map)

   // 需求：删除name=jere并且age=18的员工信息
   @Test
   public void testDeleteByMap() {
       HashMap map = new HashMap();
       map.put("name","jere");
       map.put("age",18);
       employeeMapper.deleteByMap(map); // DELETE FROM employee WHERE name = ? AND age = ?
   }
   

4. delete(wrapper)

   //需求：删除name=dafei并且age=18的员工信息
   @Test
   public void testDeleteWrapper() {
       UpdateWrapper wrapper = new UpdateWrapper<>();
       wrapper.eq("name","dafei").eq("age",18);
       employeeMapper.delete(wrapper); // DELETE FROM employee WHERE (name = ? AND age = ?)
   }
   

select

1. selectById(id)

2. selectBatchIds(idList)

   // 需求：查询id=1，id=2的员工信息
   @Test
   public void testSelectBatchIds(){
       employeeMapper.selectBatchIds(Arrays.asList(1L,2L)); 
       // SELECT id,name,password,email,age,admin,dept_id FROM employee WHERE id IN ( ? , ? )
   }
   

3. selectByMap(map)

   // 需求： 查询name=dafei， age=18的员工信息
   @Test
   public void testSelectByMap(){
       HashMap map = new HashMap<>();
       map.put("name","dafei");
       map.put("age",18);
       employeeMapper.selectByMap(map); 
       // SELECT id,name,password,email,age,admin,dept_id FROM employee WHERE name = ? AND age = ?
   }
   

4. selectCount(wrapper)

   // 需求： 查询满足条件的所有的员工个数
   @Test
   public void testSelectCount(){
       QueryWrapper wrapper = new QueryWrapper();
       employeeMapper.selectCount(wrapper); // SELECT COUNT( 1 ) FROM employee
       employeeMapper.selectCount(null); // 查询全部 SELECT COUNT( 1 ) FROM employee 
   }
   

5. selectList(wrapper)

   //需求： 查询满足条件的所有的员工信息， 返回List
   @Test
   public void testSelectList(){
       QueryWrapper wrapper = new QueryWrapper();
       employeeMapper.selectList(wrapper).forEach(System.err::println); 
       // SELECT id,name,password,email,age,admin,dept_id FROM employee
   }
   

问题：什么时候使用 selectList ? 什么时候使用 selectMaps ?

如果sql执行完之后的列能封装成实体对象，选用 selectList，如果不能则使用 selectMaps

6. selectMaps(wrapper)

   用了 group by 返回的列没办法封装到实体对象中，不能用selectList（它的返回值是泛型为实体类的List集合），所以只能用selectMaps

   可以看成：对象即 Map ， Map 即对象

   //需求： 查询满足条件的所有的员工信息， 返回List>  底层将每条数据封装成HashMap
   @Test
   public void testSelectMap(){
       QueryWrapper wrapper = new QueryWrapper();
       employeeMapper.selectMaps(wrapper);
   }
   

7. selectPage(page, wrapper)

   // 需求：查询第二页员工数据， 每页显示3条， （分页返回的数据是实体对象）
   @Test
   public void testSelectPage(){
       QueryWrapper wrapper = new QueryWrapper<>();
       //参数1：当前页， 参数2：每页显示条数
       Page page = new Page<>(2, 3);
       employeeMapper.selectPage(page, wrapper); 
       // SELECT id,name,password,email,age,admin,dept_id FROM employee LIMIT ?,?
       System.out.println("当前页：" + page.getCurrent());
       System.out.println("每页显示条数：" + page.getSize());
       System.out.println("总页数：" + page.getPages());
       System.out.println("总数：" + page.getTotal());
       System.out.println("当前页数据：" + page.getRecords());
   }
   

8. selectOne(wrapper)【拓展】

   //需求： 查询满足条件的所有的员工， 取第一条
   @Test
   public void testSelectOne(){
       QueryWrapper wrapper = new QueryWrapper<>();
       Employee employee = employeeMapper.selectOne(wrapper); 
       // 查出结果条数大于1,则抛出异常 Expected one result (or null) to be returned by selectOne(), but found: 19
       System.out.println(employee);
   }
   

9. selectObjs(wrapper)【拓展】

   //需求： 查询满足条件的所有的员工， 返回排在第一的列所有数据， 没特别指定， 一般返回时id
   @Test
   public void testSelectObjs(){
       QueryWrapper wrapper = new QueryWrapper<>();
       wrapper.select("name");  //挑选返回的列   SELECT name FROM employee
       List