MyBatisPlus讲解


转载于:https://mp.weixin.qq.com/s/wyymQUcK1QeCRfoxhd_d7w

1 简介

MyBatis-plus 是一款 Mybatis 增强工具,用于简化开发,提高效率。下文使用缩写 mp来简化表示 MyBatis-plus,本文主要介绍 mp 搭配 Spring Boot 的使用

官方网站:https://mp.baomidou.com/

1.1 核心注解

MyBatis-plus 一共提供了8个注解,这些注解是用在Java的实体类上面的:

  • @TableName
    注解在类上,指定类和数据库表的映射关系。实体类的类名(转成小写后)和数据库表名相同时,可以不指定该注解
  • @TableId
    注解在实体类的某一字段上,表示这个字段对应数据库表的主键。当主键名为id时(表中列名为id,实体类中字段名为id),无需使用该注解显式指定主键,mp会自动关联。若类的字段名和表的列名不一致,可用value属性指定表的列名。另,这个注解有个重要的属性type,用于指定主键策略。
  • @TableField
    注解在某一字段上,指定Java实体类的字段和数据库表的列的映射关系。这个注解有如下几个应用场景。
  1. 排除非表字段
    Java实体类中某个字段,不对应表中的任何列,它只是用于保存一些额外的,或组装后的数据,则可以设置exist属性为false,这样在对实体对象进行插入时,会忽略这个字段。排除非表字段也可以通过其他方式完成,如使用static或transient关键字,不做赘述
  2. 字段验证策略
    通过insertStrategyupdateStrategywhereStrategy属性进行配置,可以控制在实体对象进行插入,更新,或作为WHERE条件时,对象中的字段要如何组装到SQL语句中。
  3. 字段填充策略
    通过fill属性指定,字段为空时会进行自动填充
  • @Version
    乐观锁注解
  • @EnumValue
    注解在枚举字段上
  • @TableLogic
    逻辑删除
  • KeySequence
    序列主键策略(oracle)
  • InterceptorIgnore
    插件过滤规则

1.2 CRUD接口

mp封装了一些最基础的CRUD方法,只需要直接继承mp提供的接口,无需编写任何SQL,即可食用。mp提供了两套接口,分别是Mapper CRUD接口和Service CRUD接口。并且mp还提供了条件构造器Wrapper,可以方便地组装SQL语句中的WHERE条件

1.2.1 mapper接口

只需定义好实体类,然后创建一个接口,继承mp提供的BaseMapper,即可食用。mp会在mybatis启动时,自动解析实体类和表的映射关系,并注入带有通用CRUD方法的mapper
BaseMapper里提供的方法,部分列举如下:

  • insert(T entity) 插入一条记录
  • deleteById(Serializable id) 根据主键id删除一条记录
  • delete(Wrapper<T> wrapper) 根据条件构造器wrapper进行删除
  • selectById(Serializable id) 根据主键id进行查找
  • selectBatchIds(Collection idList) 根据主键id进行批量查找
  • selectByMap(Map<String,Object> map) 根据map中指定的列名和列值进行等值匹配查找
  • selectMaps(Wrapper<T> wrapper) 根据 wrapper 条件,查询记录,将查询结果封装为一个MapMapkey为结果的列,value为值
  • selectList(Wrapper<T> wrapper) 根据条件构造器wrapper进行查询
  • update(T entity, Wrapper<T> wrapper) 根据条件构造器wrapper进行更新
  • updateById(T entity)

主要方法介绍,如下:

1.2.1.2 selectMaps

BaseMapper接口还提供了一个selectMaps方法,这个方法会将查询结果封装为一个MapMapkey为结果的列,value为值
该方法的使用场景如下:

  1. 只查部分列
    当某个表的列特别多,而SELECT的时候只需要选取个别列,查询出的结果也没必要封装成Java实体类对象时(只查部分列时,封装成实体后,实体对象中的很多属性会是null),则可以用selectMaps,获取到指定的列后,再自行进行处理即可
    比如
@Test
   public void test3() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.select("user_id","user_name","user_address").likeRight("user_name","黄");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
   }

在这里插入图片描述
2. 数据统计
按照直属上级进行分组,查询每组的平均年龄,最大年龄,最小年龄

@Test
    public void test4() {
     QueryWrapper<UserInfoEntity> wrapper = new QueryWrapper<>();
     wrapper.select("user_id", "avg(user_age) avg_age", "min(user_age) min_age", "max(user_age) max_age")
       .groupBy("user_id").having("sum(user_age) < {0}", 25);
       //或者这样 having("sum(user_age) <  10")--->having sum(age) > 10
     List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
     System.out.println("==============");
     maps.forEach(System.out::println);
    }

在这里插入图片描述

1.2.1.3 selectObjs

只会返回第一个字段(第一列)的值,其他字段会被舍弃

@Test
 public void test3() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.select("id", "name").like("name", "黄");
  List<Object> objects = userMapper.selectObjs(wrapper);
  objects.forEach(System.out::println);
 }

在这里插入图片描述

1.2.1.4 selectCount

查询满足条件的总数,注意,使用这个方法,不能调用QueryWrapperselect方法设置要查询的列了。这个方法会自动添加select count(1)

@Test
 public void test3() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.like("name", "黄");

  Integer count = userMapper.selectCount(wrapper);
  System.out.println(count);
 }

在这里插入图片描述

1.2.2 service接口

另外一套CRUDService层的,只需要编写一个接口,继承IService,并创建一个接口实现类,即可食用。(这个接口提供的CRUD方法,和Mapper接口提供的功能大同小异,比较明显的区别在于IService支持了更多的批量化操作,如saveBatchsaveOrUpdateBatch等方法。
使用示例如下:
首先,新建一个接口,继承IService

public interface UserInfoService extends IService<UserInfoEntity> {
	//自己定义sql
	List<UserInfoEntity> queryAllBySelf();
}

创建这个接口的实现类,并继承ServiceImpl,最后打上@Service注解,注册到Spring容器中,即可使用

@Service
public class UserInfoServiceImpl extends ServiceImpl<UserInfoMapper, UserInfoEntity> implements UserInfoService {

	@Autowired
	UserInfoMapper mapper;
	@Override
	public List<UserInfoEntity> queryAllBySelf() {
		// TODO Auto-generated method stub
		return mapper.queryAllBySelf(); 
	}
}

测试例子:

@Autowired
    private UserService userService;
    @Test
    public void testGetOne() {
     LambdaQueryWrapper<UserInfoEntity> wrapper = Wrappers.<UserInfoEntity>lambdaQuery();
     wrapper.gt(User::getAge, 28);
     User one = userService.getOne(wrapper, false); // 第二参数指定为false,使得在查到了多行记录时,不抛出异常,而返回第一条记录
     System.out.println(one);
    }

1.2.2.1 链式调用

链式调用查询:

@Test
    public void testChain() {
    
     List<UserInfoEntity> list = userService.lambdaQuery()
       .gt(UserInfoEntity::getUserAge, 39)
       .likeRight(UserInfoEntity::getUserName, "王")
       .list();
     list.forEach(System.out::println);
    }

链式调用更新:

@Test
    public void testChainUpdate() {
     userService.lambdaUpdate()
       .gt(UserInfoEntity::getUserAge, 39)
       .likeRight(UserInfoEntity::getUserName, "王")
       .set(UserInfoEntity::getUserAccount, "w39@baomidou.com")
       .update();
    }

链式调用删除:

@Test
    public void testChainDelete() {
     userService.lambdaUpdate()
       .like(UserInfoEntity::getUserName, "王")
       .remove();
    }

1.3 条件构造器

mp让我觉得极其方便的一点在于其提供了强大的条件构造器Wrapper,可以非常方便的构造WHERE条件。条件构造器主要涉及到3个类,AbstractWrapperQueryWrapperUpdateWrapper,它们的类关系如下
在这里插入图片描述
AbstractWrapper中提供了非常多的方法用于构建WHERE条件,而QueryWrapper针对SELECT语句,提供了select()方法,可自定义需要查询的列,而UpdateWrapper针对UPDATE语句,提供了set()方法,用于构造set语句。条件构造器也支持lambda表达式

1.3.1 AbstractWrapper

下面对AbstractWrapper中用于构建SQL语句中的WHERE条件的方法进行部分列举

  • eq:equals,等于
  • allEq:all equals,全等于
  • ne:not equals,不等于
  • gt:greater than ,大于 >
  • ge:greater than or equals,大于等于≥
  • lt:less than,小于<
  • le:less than or equals,小于等于≤
  • between:相当于SQL中的BETWEEN
  • notBetween
  • like:模糊匹配。like("name","黄"),相当于SQL的name like '%黄%'
  • likeRight:模糊匹配右半边。likeRight("name","黄"),相当于SQL的name like '黄%'
  • likeLeft:模糊匹配左半边。likeLeft("name","黄"),相当于SQL的name like '%黄'
  • notLike:notLike("name","黄"),相当于SQL的name not like '%黄%'
  • isNull
  • isNotNull
  • in
  • and:SQL连接符AND
  • or:SQL连接符OR
  • apply:用于拼接SQL,该方法可用于数据库函数,并可以动态传参

使用示例:

示例先展示需要完成的SQL语句,后展示Wrapper的写法

// 1. 名字中包含佳,且年龄小于25
// SELECT * FROM user WHERE user_name like '%佳%' AND user_age < 25
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like("user_name", "佳").lt("user_age", 25);
List<User> users = userMapper.selectList(wrapper);
// 下面展示SQL时,仅展示WHERE条件;展示代码时, 仅展示Wrapper构建部分

// 2. 姓名为黄姓,且年龄大于等于20,小于等于40,且email字段不为空
// user_name like '黄%' AND user_age BETWEEN 20 AND 40 AND user_email is not null
wrapper.likeRight("user_name","黄").between("user_age", 20, 40).isNotNull("user_email");

// 3. 姓名为黄姓,或者年龄大于等于40,按照年龄降序排列,年龄相同则按照id升序排列
// user_name like '黄%' OR user_age >= 40 order by user_age desc, user_id asc
wrapper.likeRight("user_name","黄").or().ge("user_age",40).orderByDesc("user_age").orderByAsc("user_id");

// 4.创建日期为2021年3月22日,并且直属上级的名字为李姓
// date_format(create_time,'%Y-%m-%d') = '2021-03-22' AND user_id IN (SELECT id FROM user WHERE name like '李%')
wrapper.apply("date_format(create_time, '%Y-%m-%d') = {0}", "2021-03-22") // 建议采用{index}这种方式动态传参, 可防止SQL注入
    .inSql("user_id", "SELECT user_id FROM user WHERE user_name like '李%'");
// 上面的apply, 也可以直接使用下面这种方式做字符串拼接,但当这个日期是一个外部参数时,这种方式有SQL注入的风险
wrapper.apply("date_format(create_time, '%Y-%m-%d') = '2021-03-22'");

// 5. 名字为王姓,并且(年龄小于40,或者邮箱不为空)
// user_name like '王%' AND (user_age < 40 OR user_email is not null)
wrapper.likeRight("user_name", "王").and(q -> q.lt("user_age", 40).or().isNotNull("user_email"));

// 6. 名字为王姓,或者(年龄小于40并且年龄大于20并且邮箱不为空)
// user_name like '王%' OR (user_age < 40 AND age > 20 AND user_email is not null)
wrapper.likeRight("user_name", "王").or(
    q -> q.lt("user_age",40)
      .gt("user_age",20)
      .isNotNull("user_email")
  );

// 7. (年龄小于40或者邮箱不为空) 并且名字为王姓
// (user_age < 40 OR user_email is not null) AND user_name like '王%'
wrapper.nested(q -> q.lt("user_age", 40).or().isNotNull("user_email"))
    .likeRight("user_name", "王");

// 8. 年龄为30,31,34,35
// user_age IN (30,31,34,35)
wrapper.in("user_age", Arrays.asList(30,31,34,35));
// 或
wrapper.inSql("user_age","30,31,34,35");

// 9. 年龄为30,31,34,35, 返回满足条件的第一条记录
// user_age IN (30,31,34,35) LIMIT 1
wrapper.in("user_age", Arrays.asList(30,31,34,35)).last("LIMIT 1");

// 10. 只选出id, name 列 (QueryWrapper 特有)
// SELECT user_id, user_name FROM user;
wrapper.select("user_id", "user_name");

// 11. 选出id, name, age, email, 等同于排除 user_id 和 create_time
// 当列特别多, 而只需要排除个别列时, 采用上面的方式可能需要写很多个列, 可以采用重载的select方法,指定需要排除的列
wrapper.select(User.class, info -> {
   String columnName = info.getColumn();
   return !"create_time".equals(columnName) && !"user_id".equals(columnName);
  });

1.3.2 使用condition

条件构造器的诸多方法中,均可以指定一个boolean类型的参数condition,用来决定该条件是否加入最后生成的WHERE语句中,比如

String name = "黄"; // 假设name变量是一个外部传入的参数
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like(StringUtils.hasText(name), "name", name);
// 仅当 StringUtils.hasText(name) 为 true 时, 会拼接这个like语句到WHERE中
// 其实就是对下面代码的简化
if (StringUtils.hasText(name)) {
 wrapper.like("name", name);
}

1.3.3 实体对象作为条件

调用构造函数创建一个Wrapper对象时,可以传入一个实体对象。后续使用这个Wrapper时,会以实体对象中的非空属性,构建WHERE条件(默认构建等值匹配的WHERE条件,这个行为可以通过实体类里各个字段上的@TableField注解中的condition属性进行改变)
示例如下

@Test
 public void test3() {
  User user = new User();
  user.setName("黄主管");
  user.setAge(28);
  QueryWrapper<User> wrapper = new QueryWrapper<>(user);
  List<User> users = userMapper.selectList(wrapper);
  users.forEach(System.out::println);
 }

例如:

@TableField(condition = SqlCondition.LIKE) // 配置该字段使用like进行拼接
 private String name;

1.3.4 allEq

allEq方法传入一个map,用来做等值匹配
allEq方法传入的Map中有valuenull的元素时,默认会设置为is null

@Test
 public void test3() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  Map<String, Object> param = new HashMap<>();
  param.put("age", 40);
  param.put("name", "黄飞飞");
  wrapper.allEq(param);
  List<User> users = userMapper.selectList(wrapper);
  users.forEach(System.out::println);
 }

1.3.5 lambda条件构造器

lambda条件构造器,支持lambda表达式,可以不必像普通条件构造器一样,以字符串形式指定列名,它可以直接以实体类的方法引用来指定列。示例如下

@Test
 public void testLambda() {
  LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
  wrapper.like(User::getName, "黄").lt(User::getAge, 30);
  List<User> users = userMapper.selectList(wrapper);
  users.forEach(System.out::println);
 }

像普通的条件构造器,列名是用字符串的形式指定,无法在编译期进行列名合法性的检查,这就不如lambda条件构造器来的优雅
另外,还有个链式lambda条件构造器,使用示例如下

@Test
 public void testLambda() {
  LambdaQueryChainWrapper<User> chainWrapper = new LambdaQueryChainWrapper<>(userMapper);
  List<User> users = chainWrapper.like(User::getName, "黄").gt(User::getAge, 30).list();
  users.forEach(System.out::println);
 }

1.4 更新操作

上面介绍的都是查询操作,现在来讲更新和删除操作
BaseMapper中提供了2个更新方法

1.4.1 updateById(T entity)

根据入参entityid(主键)进行更新,对于entity中非空的属性,会出现在UPDATE语句的SET后面,即entity中非空的属性,会被更新到数据库,示例如下

@RunWith(SpringRunner.class)
  @SpringBootTest
  public class UpdateTest {
   @Autowired
   private UserMapper userMapper;
   @Test
   public void testUpdate() {
    User user = new User();
    user.setId(2L);
    user.setAge(18);
    userMapper.updateById(user);
   }
  }

1.4.2 update(T entity, Wrapper wrapper)

根据实体entity和条件构造器wrapper进行更新,示例如下

@Test
   public void testUpdate2() {
    User user = new User();
    user.setName("王三蛋");
    LambdaUpdateWrapper<User> wrapper = new LambdaUpdateWrapper<>();
    wrapper.between(User::getAge, 26,31).likeRight(User::getName,"吴");
    userMapper.update(user, wrapper);
   }

额外演示一下,把实体对象传入Wrapper,即用实体对象构造WHERE条件的案例

@Test
   public void testUpdate3() {
    User whereUser = new User();
    whereUser.setAge(40);
    whereUser.setName("王");
  
    LambdaUpdateWrapper<User> wrapper = new LambdaUpdateWrapper<>(whereUser);
    User user = new User();
    user.setEmail("share@baomidou.com");
    user.setManagerId(10L);
  
    userMapper.update(user, wrapper);
   }

1.4.3 set更新

由于BaseMapper提供的2个更新方法都是传入一个实体对象去执行更新,这在需要更新的列比较多时还好,若想要更新的只有那么一列,或者两列,则创建一个实体对象就显得有点麻烦。针对这种情况,UpdateWrapper提供有set方法,可以手动拼接SQL中的SET语句,此时可以不必传入实体对象,示例如下

@Test
 public void testUpdate4() {
  LambdaUpdateWrapper<User> wrapper = new LambdaUpdateWrapper<>();
  wrapper.likeRight(User::getEmail, "share").set(User::getManagerId, 9L);
  userMapper.update(null, wrapper);
 }

1.5 删除操作

BaseMapper一共提供了如下几个用于删除的方法:

  • deleteById 根据主键id进行删除
  • deleteBatchIds 根据主键id进行批量删除
  • deleteByMap 根据Map进行删除(Map中的key为列名,value为值,根据列和值进行等值匹配)
  • delete(Wrapper<T> wrapper) 根据条件构造器Wrapper进行删除
    与前面查询和更新的操作大同小异,不做赘述

1.6 分页查询

BaseMapper中提供了2个方法进行分页查询,分别是selectPageselectMapsPage,前者会将查询的结果封装成Java实体对象,后者会封装成Map<String,Object>。分页查询的食用示例如下:

1.6.1 注册分页拦截器

创建mp的分页拦截器,注册到Spring容器中

package com.example.mp.config;
   import com.baomidou.mybatisplus.annotation.DbType;
   import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
   import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   public class MybatisPlusConfig {
   
       /** 新版mp **/
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
     MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
     interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
     return interceptor;
    }
       /** 旧版mp 用 PaginationInterceptor **/
   }

1.6.2 执行查询

执行分页查询

@Test
    public void testPage() {
     LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
     wrapper.ge(User::getAge, 28);
           // 设置分页信息, 查第3页, 每页2条数据
     Page<User> page = new Page<>(3, 2);
           // 执行分页查询
     Page<User> userPage = userMapper.selectPage(page, wrapper);
     System.out.println("总记录数 = " + userPage.getTotal());
     System.out.println("总页数 = " + userPage.getPages());
     System.out.println("当前页码 = " + userPage.getCurrent());
           // 获取分页查询结果
     List<User> records = userPage.getRecords();
     records.forEach(System.out::println);
    }

mapper中一般写法

IPage<Map> queryNeedByMeLaunch(IPage<Map> page, @Param("params") Map map);

在service中使用Page<Map> page = new Page<>(pageIndex,pageSize);来封装对象

1.7 AR模式

ActiveRecord模式,通过操作实体对象,直接操作数据库表。与ORM有点类似
示例如下
让实体类User继承自Model

package com.example.mp.po;
   
   import com.baomidou.mybatisplus.annotation.SqlCondition;
   import com.baomidou.mybatisplus.annotation.TableField;
   import com.baomidou.mybatisplus.extension.activerecord.Model;
   import lombok.Data;
   import lombok.EqualsAndHashCode;
   import java.time.LocalDateTime;
   
   @EqualsAndHashCode(callSuper = false)
   @Data
   public class User extends Model<User> {
    private Long id;
    @TableField(condition = SqlCondition.LIKE)
    private String name;
    @TableField(condition = "%s &gt; #{%s}")
    private Integer age;
    private String email;
    private Long managerId;
    private LocalDateTime createTime;
   }

直接调用实体对象上的方法

@Test
    public void insertAr() {
     User user = new User();
     user.setId(15L);
     user.setName("我是AR");
     user.setAge(1);
     user.setEmail("ar@baomidou.com");
     user.setManagerId(1L);
     boolean success = user.insert(); // 插入
     System.out.println(success);
    }

其他示例:

其他示例
// 查询
 @Test
 public void selectAr() {
  User user = new User();
        user.setId(15L);
  User result = user.selectById();
  System.out.println(result);
 }
 // 更新
 @Test
 public void updateAr() {
  User user = new User();
  user.setId(15L);
  user.setName("王全蛋");
  user.updateById();
 }
 //删除
 @Test
 public void deleteAr() {
  User user = new User();
  user.setId(15L);
  user.deleteById();
 }

1.8 主键策略

在定义实体类时,用@TableId指定主键,而其type属性,可以指定主键策略。
mp支持多种主键策略,默认的策略是基于雪花算法的自增id。全部主键策略定义在了枚举类IdType中,IdType有如下的取值

1.8.1 AUTO

数据库ID自增,依赖于数据库。在插入操作生成SQL语句时,不会插入主键这一列
User上对id属性加上注解,然后将MYSQL的user表修改其主键为自增

@EqualsAndHashCode(callSuper = false)
  @Data
  public class User extends Model<User> {
   @TableId(type = IdType.AUTO)
   private Long id;
   @TableField(condition = SqlCondition.LIKE)
   private String name;
   @TableField(condition = "%s &gt; #{%s}")
   private Integer age;
   private String email;
   private Long managerId;
   private LocalDateTime createTime;
  }

测试

@Test
   public void testAuto() {
    User user = new User();
    user.setName("我是青蛙呱呱");
    user.setAge(99);
    user.setEmail("frog@baomidou.com");
    user.setCreateTime(LocalDateTime.now());
    userMapper.insert(user);
          System.out.println(user.getId());
   }

1.8.2 NONE

未设置主键类型。若在代码中没有手动设置主键,则会根据主键的全局策略自动生成(默认的主键全局策略是基于雪花算法自增ID
MYSQLuser表中,去掉主键自增。然后修改User类(若不配置@TableId注解,默认主键策略也是NONE

@TableId(type = IdType.NONE)
  private Long id;

插入时,若实体类的主键ID有值,则使用之;若主键ID为空,则使用主键全局策略,来生成一个ID。

1.8.3 其他生成策略

  • INPUT
    需要手动设置主键,若不设置。插入操作生成SQL语句时,主键这一列的值会是nulloracle的序列主键需要使用这种方式
  • ASSIGN_ID
    当没有手动设置主键,即实体类中的主键属性为空时,才会自动填充,使用雪花算法
  • ASSIGN_UUID
    当实体类的主键属性为空时,才会自动填充,使用UUID

可以针对每个实体类,使用@TableId注解指定该实体类的主键策略,这可以理解为局部策略。若希望对所有的实体类,都采用同一种主键策略,挨个在每个实体类上进行配置,则太麻烦了,此时可以用主键的全局策略。只需要在application.yml进行配置即可。比如,配置了全局采用自增主键策略

# application.yml
mybatis-plus:
  global-config:
    db-config:
      id-type: auto

附录:mybatis-plus使用

posted @ 2021-05-30 17:15  上善若泪  阅读(644)  评论(0编辑  收藏  举报