MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,它在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
MyBatis-Plus 的特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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、引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
2、修改配置文件
spring.datasource.driverClassName = com.mysql.cj.jdbc.Driver
spring.datasource.url = jdbc:mysql://localhost:3306/demo?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.username = root
spring.datasource.password = 123456
3、定义表结构
4、定义实体类
@Data
@TableName("user")
public class User implements Serializable {
@TableId(value = "id", type = IdType.AUTO)
private Integer userId;
@TableField("name")
private String userName;
private Integer type;
@TableField("create_time")
private LocalDateTime createTime;
private static final long serialVersionUID = 1L;
}
5、mapper层CRUD通用接口
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
6、service层通用CRUD接口
6.1、接口
public interface UserService extends IService<User> {
User getUserById(Integer userId);
User getUserByName(String name);
void insertUser(User user);
}
6.2、实现类
@Service
@Transactional
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
@Autowired
private UserMapper userMapper;
@Override
@Transactional
public User getUserById(Integer userId) {
return userMapper.selectById(userId);
}
@Override
@Transactional
public User getUserByName(String name) {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", name);
return userMapper.selectOne(wrapper);
}
@Override
@Transactional
public void insertUser(User user) {
userMapper.insert(user);
}
}
BaseMapper
接口定义了一些通用的操作数据库方法,单表大部分 CRUD 操作都能直接搞定,相比原生的 mybatis,效率提高了很多。
public interface BaseMapper<T> extends Mapper<T> {
int insert(T entity);
int deleteById(Serializable id);
int deleteByMap(@Param("cm") Map<String, Object> columnMap);
int delete(@Param("ew") Wrapper<T> queryWrapper);
int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);
int updateById(@Param("et") T entity);
int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);
T selectById(Serializable id);
List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);
List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);
T selectOne(@Param("ew") Wrapper<T> queryWrapper);
Integer selectCount(@Param("ew") Wrapper<T> queryWrapper);
List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);
List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);
List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);
<E extends IPage<T>> E selectPage(E page, @Param("ew") Wrapper<T> queryWrapper);
<E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param("ew") Wrapper<T> queryWrapper);
}
7、添加分页
7.1、添加配置类
@Configuration
public class MybatisPlusPageConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 添加分页插件
PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor();
// 设置请求的页面大于最大页后操作,true调回到首页,false继续请求。默认false
pageInterceptor.setOverflow(false);
// 单页分页条数限制,默认无限制
pageInterceptor.setMaxLimit(500L);
// 设置数据库类型
pageInterceptor.setDbType(DbType.MYSQL);
interceptor.addInnerInterceptor(pageInterceptor);
return interceptor;
}
}
7.2、使用示例
@Override
@Transactional
public List<User> search(Integer currentPage, Integer size, User user){
Page<User> page = new Page<>(currentPage, size);
QueryWrapper<User> queryWrapper = new QueryWrapper<>(user);
Page<User> result = userMapper.selectPage(page, queryWrapper);
return result.getRecords();
}
8、QueryWrapper
QueryWrapper是Mybatis plus中实现查询的对象封装操作类。
常用方法:
8.1、模糊查询
SQL实现:
select * from user
where del_flag = 0
<if test ="name!=null and ''!=name">
and name like concat('%',#{name},'%')
</if>
order by create_time desc
QueryWrapper实现:
//构建一个查询的wrapper
QueryWrapper<User> wrapper = new QueryWrapper<User>();
//name不为空时,组装模糊查询条件
wrapper.like(StringUtils.isNotBlank(name),"name",name);
//未删除
wrapper.eq("del_flag",0);
//创建时间降序
wrapper.orderByDesc("create_time");
List<User> list = userMapper.selectList(wrapper);
8.2、范围查询
SQL实现
select * from user
where age between 20 and 30
QueryWrapper实现:
//构建一个查询的wrapper
QueryWrapper<User> wrapper = new QueryWrapper<User>();
//年龄20-30之间的
wrapper.between("age",20,30);
List<User> list = userMapper.selectList(wrapper);
8.3、时间段查询
SQL实现:
select * from user
where DATE(create_time) >= STR_TO_DATE('2022-08-01','%Y-%m-%d')
AND DATE(create_time) <= STR_TO_DATE('2022-08-10','%Y-%m-%d')
QueryWrapper实现:
//构建一个查询的wrapper
QueryWrapper<User> wrapper = new QueryWrapper<User>();
//查询条件为创建时间
wrapper.apply(StringUtils.isNotBlank(startTime),"DATE(create_time) >= STR_TO_DATE('"+startTime+"','%Y-%m-%d')");
wrapper.apply(StringUtils.isNotBlank(endTime),"DATE(create_time) <= STR_TO_DATE('"+endTime+"','%Y-%m-%d')");
List<User> list = userMapper.selectList(wrapper);
8.4、集合范围查询
SQL实现:
select * from user
where id in(1,2,3)
QueryWrapper实现:
//构建一个查询的wrapper
QueryWrapper<User> wrapper = new QueryWrapper<User>();
if(StringUtils.isNotBlank(ids)){
//字符串转数组再转List
Collection<String> collection = Arrays.asList(ids.split(","));
//in方法
wrapper.in(collection.size()>0,"id",collection);
}
List<User> list = userMapper.selectList(wrapper);
8.5、查询字段
SQL实现:
select name, age from user
where name like '%e%'
and email like '5%'
QueryWrapper实现:
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.select("name", "age")
.like("name", "e")
.likeRight("email", "5");
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
8.6、联表查询
SQL实现:
SELECT
u.id,
u.name,
u.sex,
u.head_img,
ud.tel,
ud.address AS user_address
FROM
user u
LEFT JOIN user_detail ud on u.id = ud.user_id
WHERE u.sex = 1 AND ud.address LIKE "%海淀%"
QueryWrapper实现:
Lambda形式用法(MPJLambdaWrapper)
MPJLambdaWrapper< UserDO > wrapper = new MPJLambdaWrapper<UserDO>()
.selectAll(UserDO.class)
.select(UserDetailDO::getTel)
.selectAs(UserDetailDO::getAddress, UserDTO::getUserAddress)
.leftJoin(UserDetailDO.class, UserDetailDO::getUserId, UserDO::getId)
.eq(UserDO::getSex, 1)
.like(UserDetailDO::getAddress, "海淀")
//列表查询
List<UserDTO> list = userMapper.selectJoinList(UserDTO.class, wrapper);
//分页查询 (需要启用 mybatis plus 分页插件)
List<UserDTO> listPage = userMapper.selectJoinPage(new Page<>(1, 10), UserDTO.class, wrapper);
说明:
- UserDTO.class 查询结果返回类(resultType)
- selectAll() 查询指定实体类的全部字段
- select() 查询指定的字段,支持可变参数,同一个select只能查询相同表的字段
- selectAs() 字段别名查询,用于数据库字段与业务实体类属性名不一致时使用
- leftJoin() 参数说明
第一个参数:参与连表的实体类class
第二个参数:连表的ON字段,这个属性必须是第一个参数实体类的属性
第三个参数:参与连表的ON的另一个实体类属性
- 默认主表别名是t,其他的表别名以先后调用的顺序使用t1,t2,t3…
- 条件查询,可以查询主表以及参与连接的所有表的字段,全部调用mp原生的方法,正常使用没有sql注入风险
String形式用法(MPJQueryWrapper)
MPJQueryWrapper wrapper = new MPJQueryWrapper<UserDO>()
.selectAll(UserDO.class)
.select("ud.tel", "ud.address as user_address")
.leftJoin("user_detail ud on t.id = ud.user_id")
.eq("t.sex", "1")
.like("ud.address", "海淀");
//列表查询
List<UserDTO> list = userMapper.selectJoinList(UserDTO.class, wrapper);
//分页查询 (需要启用 mybatis plus 分页插件)
List<UserDTO> listPage = userMapper.selectJoinPage(new Page<>(1, 10), UserDTO.class, wrapper);
- UserDTO.class 查询结果类(resultType)
- selectAll(UserDO.class) 查询主表全部字段(主表实体类)默认主表别名 “t”
- select() mp的select策略是覆盖,以最后一次为准,这里的策略是追加,可以一直select
- 主表字段可以用lambda,会自动添加表别名,主表别名默认是 t ,非主表字段必须带别名查询
- leftJoin() rightJoin() innerJoin() 传sql片段 格式 (表 + 别名 + 关联条件)
- 条件查询,可以查询主表以及参与连接的所有表的字段,全部调用mp原生的方法,正常使用没有sql注入风险
9、UpdateWrapper
QueryWrapper是Mybatis plus中实现update的对象封装操作类。
有两种方式可以实现update操作:
1、将需要更新的字段,设置到entity 中
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.eq("id","123");
User user = new User();
user.setAge(18);
Integer rows = userMapper.update(user, updateWrapper);
2、将entity设置为 null ,使用set或者setSql方法将需要更新的字段设置到 UpdateWrapper 中
set函数:
//column 表字段,val 值 ,condition表示该条件是否加入最后生成的sql中
set(String column, Object val)
set(boolean condition, String column, Object val)
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.set("age","18")eq("id","123");
Integer rows = userMapper.update(null, updateWrapper);
setSql函数:
setSql(String sql)
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
// 设置sql语句部分
updateWrapper.setSql("age = 18");
updateWrapper.eq("id","123");
userService.update(updateWrapper);