MyBatis-Plus使用
一、MyBatis-Plus
（2）创建一个 SpringBoot 项目。
方式一：去官网 https://start.spring.io/ 初始化一个，然后导入 IDE 工具即可。
方式二：直接使用 IDE 工具创建一个。 Spring Initializer。
（3）添加 MyBatis-Plus 依赖（mybatis-plus-boot-starter）
xml<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>8.0.18version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<version>1.18.10version>
dependency>
（5）完整依赖文件（pom.xml）
pgsqlDROP DATABASE IF EXISTS testMyBatisPlus;
CREATE DATABASE testMyBatisPlus;
USE testMyBatisPlus;
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)
);
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');
（7）在 application.yml 文件中配置 mysql 数据源信息。
fortranpackage entity;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private int age;
private String email;
}
（9）编写操作实体类的 Mapper 类。
直接继承 BaseMapper，这是 mybatis-plus 封装好的类。
package service;
import com.baomidou.mybatisplus.extension.service.IService;
import entity.User;
/**
* 用户Service
*/
public interface UserService extends IService<User> {
}
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
（10）实体类、Mapper 类都写好了，就可以使用了。
Step1：先得在启动类里扫描 Mapper 类，即添加 @MapperScan 注解
package com.lyh.test.testmybatisplus;
import bean.User;
import mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class TestMybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
public void testSelect() {
System.out.println(("----- selectAll method test ------"));
List userList = userMapper.selectList(null);
for(User user:userList) {
System.out.println(user);
}
}
}
（11）总结：
通过以上简单操作，就能对 user 表进行 CRUD 操作，不需要去编写 xml 文件。
注：
若遇到 @Autowired 标记的变量出现 红色下划线，但是不影响 正常运行。
可以进入 Settings，找到 Inspection，并选择其中的 Spring Core -> Code -> Autowiring for Bean Class,将 Error 改为 Warning，即可。
（2）未使用自动填充时
未使用 自动填充时，每次添加、修改数据都可以手动对其进行添加。
/**
* 创建时间
*/
@TableField(fill = FieldFill.INSERT)
private Date createTime;
/**
* 最后修改时间
*/
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
Step2：
自定义一个类，实现 MetaObjectHandler 接口，并重写方法。
添加 @Component 注解，交给 Spring 去管理。
@Test
public void testAutoFill() {
User user = new User();
user.setName("tom").setAge(20).setEmail("tom@163.com");
if (userService.save(user)) {
userService.list().forEach(System.out::println);
} else {
System.out.println("添加数据失败");
}
}
（3）简单测试
使用 mybatis-plus 封装好的方法时，会自动添加逻辑删除的功能。
若是自定义的 sql 语句，需要手动添加逻辑。
@Test
public void testPage() {
// Step1：创建一个 Page 对象
Page page = new Page<>();
// Page page = new Page<>(2, 5);
// Step2：调用 mybatis-plus 提供的分页查询方法
userService.page(page, null);
// Step3：获取分页数据
System.out.println(page.getCurrent()); // 获取当前页
System.out.println(page.getTotal()); // 获取总记录数
System.out.println(page.getSize()); // 获取每页的条数
System.out.println(page.getRecords()); // 获取每页数据的集合
System.out.println(page.getPages()); // 获取总页数
System.out.println(page.hasNext()); // 是否存在下一页
System.out.println(page.hasPrevious()); // 是否存在上一页
}
Step2：
定义一个数据库字段 version。
/**
* 版本号（用于乐观锁， 默认为 1）
*/
@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "version", Integer.class, 1);
}
Step4：
简单测试一下，可以看一下 控制台 打印的 sql 语句。
【添加数据：（增）】
int insert(T entity); // 插入一条记录
注：
T 表示任意实体类型
entity 表示实体对象
【删除数据：（删）】
int deleteById(Serializable id); // 根据主键 ID 删除
int deleteByMap(@Param(Constants.COLUMN_MAP) MapObject> columnMap); // 根据 map 定义字段的条件删除
int delete(@Param(Constants.WRAPPER) Wrapper wrapper); // 根据实体类定义的 条件删除对象
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 进行批量删除
注：
id 表示 主键 ID
columnMap 表示表字段的 map 对象
wrapper 表示实体对象封装操作类，可以为 null。
idList 表示 主键 ID 集合（列表、数组），不能为 null 或 empty
【修改数据：（改）】
int updateById(@Param(Constants.ENTITY) T entity); // 根据 ID 修改实体对象。
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper); // 根据 updateWrapper 条件修改实体对象
注：
update 中的 entity 为 set 条件，可以为 null。
updateWrapper 表示实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
【查询数据：（查）】
T selectById(Serializable id); // 根据 主键 ID 查询数据
List selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 进行批量查询
List selectByMap(@Param(Constants.COLUMN_MAP) MapObject> columnMap); // 根据表字段条件查询
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 根据实体类封装对象 查询一条记录
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询记录的总条数
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 entity 集合）
ListObject>> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 map 集合）
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（但只保存第一个字段的值）
> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 entity 集合），分页
Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 map 集合），分页
注：
queryWrapper 表示实体对象封装操作类（可以为 null）
page 表示分页查询条件
（2）方法介绍
混个眼熟，用多了就记得了。
内部封装了 BaseMapper 的方法，也提供了新的方法。
比如：
添加了 批量更新 方法、更新或修改方法等。
对 查询方法 做了细化，使用 get 命名的方法查询一条数据，使用 list 命名的方法查询多条数据等。
增加了链式调用的方法。
【通用条件：】
【比较大小： ( =, <>, >, >=, <, <= )】
eq(R column, Object val); // 等价于 =，例: eq("name", "老王") ---> name = '老王'
ne(R column, Object val); // 等价于 <>，例: ne("name", "老王") ---> name <> '老王'
gt(R column, Object val); // 等价于 >，例: gt("name", "老王") ---> name > '老王'
ge(R column, Object val); // 等价于 >=，例: ge("name", "老王") ---> name >= '老王'
lt(R column, Object val); // 等价于 <，例: lt("name", "老王") ---> name < '老王'
le(R column, Object val); // 等价于 <=，例: le("name", "老王") ---> name <= '老王'
【范围：（between、not between、in、not in）】
between(R column, Object val1, Object val2); // 等价于 between a and b, 例： between("age", 18, 30) ---> age between 18 and 30
notBetween(R column, Object val1, Object val2); // 等价于 not between a and b, 例： notBetween("age", 18, 30) ---> age not between 18 and 30
in(R column, Object... values); // 等价于 字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3)
notIn(R column, Object... values); // 等价于 字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3)
inSql(R column, Object... values); // 等价于 字段 IN (sql 语句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3)
notInSql(R column, Object... values); // 等价于 字段 NOT IN (sql 语句)
【模糊匹配：（like）】
like(R column, Object val); // 等价于 LIKE '%值%'，例: like("name", "王") ---> name like '%王%'
notLike(R column, Object val); // 等价于 NOT LIKE '%值%'，例: notLike("name", "王") ---> name not like '%王%'
likeLeft(R column, Object val); // 等价于 LIKE '%值'，例: likeLeft("name", "王") ---> name like '%王'
likeRight(R column, Object val); // 等价于 LIKE '值%'，例: likeRight("name", "王") ---> name like '王%'
【空值比较：（isNull、isNotNull）】
isNull(R column); // 等价于 IS NULL，例: isNull("name") ---> name is null
isNotNull(R column); // 等价于 IS NOT NULL，例: isNotNull("name") ---> name is not null
【分组、排序：（group、having、order）】
groupBy(R... columns); // 等价于 GROUP BY 字段, ...， 例: groupBy("id", "name") ---> group by id,name
orderByAsc(R... columns); // 等价于 ORDER BY 字段, ... ASC， 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
orderByDesc(R... columns); // 等价于 ORDER BY 字段, ... DESC， 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
having(String sqlHaving, Object... params); // 等价于 HAVING ( sql语句 )， 例: having("sum(age) > {0}", 11) ---> having sum(age) > 11
【拼接、嵌套 sql：（or、and、nested、apply）】
or(); // 等价于 a or b， 例：eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王'
or(Consumer consumer); // 等价于 or(a or/and b)，or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活着")) ---> or (name = '李白' and status <> '活着')
and(Consumer consumer); // 等价于 and(a or/and b)，and 嵌套。例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着')
nested(Consumer consumer); // 等价于 (a or/and b)，普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活着")) ---> (name = '李白' and status <> '活着')
apply(String applySql, Object... params); // 拼接sql（若不使用 params 参数，可能存在 sql 注入），例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
last(String lastSql); // 无视优化规则直接拼接到 sql 的最后，可能存若在 sql 注入。
exists(String existsSql); // 拼接 exists 语句。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1)
【QueryWrapper 条件：】
select(String... sqlSelect); // 用于定义需要返回的字段。例： select("id", "name", "age") ---> select id, name, age
select(Predicate predicate); // Lambda 表达式，过滤需要的字段。
lambda(); // 返回一个 LambdaQueryWrapper
【UpdateWrapper 条件：】
set(String column, Object val); // 用于设置 set 字段值。例: set("name", null) ---> set name = null
etSql(String sql); // 用于设置 set 字段值。例: setSql("name = '老李头'") ---> set name = '老李头'
lambda(); // 返回一个 LambdaUpdateWrapper
（3）简单使用，测试一下 QueryWrapper
bashmybatis.mapper-locations=classpath*:*Mapper.xml
# 修改为
mybatis-plus.mapper-locations=classpath*:*Mapper.xml
转载链接：https://www.cnblogs.com/l-y-h/p/12859477.html