发布时间:2024-03-31 17:01
MyBatis-Plus是一个Mybatis增强版工具,在MyBatis上扩充了其它功能没有改变基本功能,也就是只做封装增强不做改变,为了简化开发提交效率而存在,不需要写XML等sql语句就可实现
官方文档:https://mp.baomidou.com/guide/
需要java开发环境(JDK)以及响应的开发工具(IDEA)
需要maven(用来下载相关的jar包)
使用Springboot整合Mybatis-Plus
IDEA安装Mybatis-Plus插件
方式一:去官网https://start.spring.io/初始化一个,然后导入IDEA工具即可
方式二:直接使用IDEA工具创建一个。Spring Initializer。
org.springframework.boot
spring-boot-starter-parent
2.3.5.RELEASE
org.projectlombok
lombok
1.18.10
com.baomidou
mybatis-plus-boot-starter
3.4.1
mysql
mysql-connector-java
runtime
org.apache.velocity
velocity-engine-core
2.2
create table `user_test1` (
`id` int (11),
`username` varchar (60),
`age` int (11),
`tel` int (11),
`create_time` timestamp ,
`update_time` timestamp ,
`version` int (11)
);
insert into `user_test1` (`id`, `username`, `age`, `tel`, `create_time`, `update_time`, `version`) values('1','张三','18','180',NULL,NULL,NULL);
insert into `user_test1` (`id`, `username`, `age`, `tel`, `create_time`, `update_time`, `version`) values('2','李四','20','137',NULL,NULL,NULL);
insert into `user_test1` (`id`, `username`, `age`, `tel`, `create_time`, `update_time`, `version`) values('3','王五','22','138',NULL,NULL,NULL);
spring:
datasource:
# 驱动
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/educationapp?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
password: root
username: root
#控制台打印sql
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
注意:如果最后测试发现实体类无法映射数据信息 自行加上get set方法
@Data //使用lombok 简化getset方法
public class UserTest {
private int id;
private String username;
private int age;
private int tel;
private Date create_time;
private Date update_time;
private int version;
}
直接继承BaseMapper,这是mybatis-plus封装好的类
启动类添加MapperScan注解。指定mapper扫描路径。指定后就不要在mapper层写@Mapper注解了
这里不用单元测试了,直接使用控制层映射路径测试
/**
* 测试连接Mybatis-plus
*/
@RestController
@RequestMapping("api/v1/test/my")
public class TestMyController {
//如果出现红色下划线不影响运行,可以设置idea不报红
@Autowired
private UserTestMapper userTestMapper;
/**
* 查询所有用户信息
*/
@GetMapping("list")
public Dto test(){
//直接调用BaseMapper封装好的CRUD方法,就可实现无条件查询数据
List list = userTestMapper.selectList(null);
//循环获取用户数据
for (UserTest userTest:list){
//获取用户名称
System.out.println(userTest.getUsername());
}
return DtoUtil.returnDataSuccess(list);
}
}
【@TableName 】 作用于类上
@TableName 用于定义表名
注:
常用属性:
value 用于定义表名
【@TableId】 作用于属性上
@TableId 用于定义表的主键
注:
常用属性:
value 用于定义主键字段名
type 用于定义主键类型(主键策略 IdType)
主键策略:
IdType.AUTO 主键自增,系统分配,不需要手动输入
IdType.NONE 未设置主键
IdType.INPUT 需要自己输入 主键值。
IdType.ASSIGN_ID 系统分配 ID,用于数值型数据(Long,对应 mysql 中 BIGINT 类型)。
IdType.ASSIGN_UUID 系统分配 UUID,用于字符串型数据(String,对应 mysql 中 varchar(32) 类型)。
【@TableField】 作用与属性上
@TableField 用于定义表的非主键字段。
注:
常用属性:
value 用于定义非主键字段名
exist 用于指明是否为数据表的字段, true 表示是,false 为不是。
fill 用于指定字段填充策略(FieldFill)。
字段填充策略:(一般用于填充 创建时间、修改时间等字段)
FieldFill.DEFAULT 默认不填充
FieldFill.INSERT 插入时填充
FieldFill.UPDATE 更新时填充
FieldFill.INSERT_UPDATE 插入、更新时填充。
【@TableLogic】
@TableLogic 用于定义表的字段进行逻辑删除(非物理删除)
注:
常用属性:
value 用于定义未删除时字段的值
delval 用于定义删除时字段的值
【@Version】 作用于属性上
@Version 用于字段实现乐观锁
/**
* 用户测试类
*/
//指定数据库表名称 user_test1
@TableName(value = "user_test1")
public class UserTest {
/**
* 主键id 设置自增长策略
*/
@TableId(value = "id",type = IdType.AUTO)
private int id;
/**
* 用户名称
*/
@TableField(value = "username")
private String username;
/**
* 年龄
*/
@TableField(value = "age")
private int age;
/**
* 电话
*/
@TableField(value = "tel")
private int tel;
/**
* 创建时间
*/
@TableField(value = "create_time")
private Date create_time;
/**
* 最后修改时间
*/
@TableField(value = "update_time")
private Date update_time;
/**
* 版本号(用于乐观锁,默认为1)
* @return
*/
//@Version
@TableField(value = "version")
private int version;
}
public interface UserTestMapper extends BaseMapper {
}
BaseMapper 接口中封装了一系列 CRUD 常用操作,可以直接使用,而不用自定义 xml 与 sql 语句进行 CRUD 操作(当然根据实际开发需要,自定义 sql 还是有必要的)。
复制代码
【添加数据:(增)】
int insert(T entity); // 插入一条记录
注:
T 表示任意实体类型
entity 表示实体对象
【删除数据:(删)】
int deleteById(Serializable id); // 根据主键 ID 删除
int deleteByMap(@Param(Constants.COLUMN_MAP) Map 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) Map columnMap); // 根据表字段条件查询
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 根据实体类封装对象 查询一条记录
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询记录的总条数
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录(返回 entity 集合)
List
IService 内部进一步封装了 BaseMapper 接口的方法(当然也提供了更详细的方法)。
使用时,可以通过 生成的 mapper 类进行 CRUD 操作,也可以通过 生成的 service 的实现类进行 CRUD 操作。(当然,自定义代码执行也可,不选择继承IService)
public interface UserTestService extends IService {
List LikeListUser(String username);
}
【添加数据:(增)】
default boolean save(T entity); // 调用 BaseMapper 的 insert 方法,用于添加一条数据。
boolean saveBatch(Collection entityList, int batchSize); // 批量插入数据
注:
entityList 表示实体对象集合
batchSize 表示一次批量插入的数据量,默认为 1000
【添加或修改数据:(增或改)】
boolean saveOrUpdate(T entity); // id 若存在,则修改, id 不存在则新增数据
default boolean saveOrUpdate(T entity, Wrapper updateWrapper); // 先根据条件尝试更新,然后再执行 saveOrUpdate 操作
boolean saveOrUpdateBatch(Collection entityList, int batchSize); // 批量插入并修改数据
【删除数据:(删)】
default boolean removeById(Serializable id); // 调用 BaseMapper 的 deleteById 方法,根据 id 删除数据。
default boolean removeByMap(Map columnMap); // 调用 BaseMapper 的 deleteByMap 方法,根据 map 定义字段的条件删除
default boolean remove(Wrapper queryWrapper); // 调用 BaseMapper 的 delete 方法,根据实体类定义的 条件删除对象。
default boolean removeByIds(Collection extends Serializable> idList); // 用 BaseMapper 的 deleteBatchIds 方法, 进行批量删除。
【修改数据:(改)】
default boolean updateById(T entity); // 调用 BaseMapper 的 updateById 方法,根据 ID 选择修改。
default boolean update(T entity, Wrapper updateWrapper); // 调用 BaseMapper 的 update 方法,根据 updateWrapper 条件修改实体对象。
boolean updateBatchById(Collection entityList, int batchSize); // 批量更新数据
【查找数据:(查)】
default T getById(Serializable id); // 调用 BaseMapper 的 selectById 方法,根据 主键 ID 返回数据。
default List listByIds(Collection extends Serializable> idList); // 调用 BaseMapper 的 selectBatchIds 方法,批量查询数据。
default List listByMap(Map columnMap); // 调用 BaseMapper 的 selectByMap 方法,根据表字段条件查询
default T getOne(Wrapper queryWrapper); // 返回一条记录(实体类保存)。
Map getMap(Wrapper queryWrapper); // 返回一条记录(map 保存)。
default int count(Wrapper queryWrapper); // 根据条件返回 记录数。
default List list(); // 返回所有数据。
default List list(Wrapper queryWrapper); // 调用 BaseMapper 的 selectList 方法,查询所有记录(返回 entity 集合)。
default List
简介: 上面介绍的 接口方法的参数中,会出现各种 wrapper,比如 queryWrapper、updateWrapper 等。wrapper 的作用就是用于定义各种各样的查询条件(where)。
Wrapper 条件构造抽象类
-- AbstractWrapper 查询条件封装,用于生成 sql 中的 where 语句。
-- QueryWrapper Entity 对象封装操作类,用于查询。
-- UpdateWrapper Update 条件封装操作类,用于更新。
-- AbstractLambdaWrapper 使用 Lambda 表达式封装 wrapper
-- LambdaQueryWrapper 使用 Lambda 语法封装条件,用于查询。
-- LambdaUpdateWrapper 使用 Lambda 语法封装条件,用于更新
【通用条件:】
【比较大小: ( =, <>, >, >=, <, <= )】
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
service实现类
/**
* 测试用户实现类
*/
@Service
public class UserTestServiceImpl implements UserTestService {
@Autowired
UserTestMapper userTestMapper;
/**
* 模糊查询用户信息
* @param username 用户名称
* @return
*/
@Override
public List LikeListUser(String username) {
// Step1:创建一个 QueryWrapper 对象
QueryWrapper queryWrapper = new QueryWrapper<>();
// Step2:构造查询条件
queryWrapper
.select("username","age") //需要查询得字段
//.eq("age","20") //查询条件
.like("username",username); //模糊查询
// Step3:执行查询
List userTestList = userTestMapper.selectList(queryWrapper);
return userTestList;
}
}
Controller控制层
/**
* CRUD操作测试 查询用户信息
*/
@GetMapping("CrudTestUser")
public Dto CrudTestUser(@RequestParam("username") String username){
//Dto和DtoUtil是我自己封装的工具类 同志们直接返回List就行
return DtoUtil.returnDataSuccess(userTestService.LikeListUser(username));
}
编写一个 配置类,内部使用 @Bean 注解将 PaginationInterceptor 交给 Spring 容器管理。
public interface UserTestService{
List pagelist(int current,int size);
}
编写分页代码。
直接 new 一个 Page 对象,对象需要传递两个参数(当前页,每页显示的条数)。
调用 mybatis-plus 提供的分页查询方法,其会将 分页查询的数据封装到 Page 对象中。
@Service
public class UserTestServiceImpl implements UserTestService {
@Autowired
UserTestMapper userTestMapper;
@Override
public List pagelist(int current, int size) {
// Step1:创建一个 Page 对象 从0条开始 每页显示5条
Page page = new Page<>(current,size);
// Page page = new Page<>(2, 5);
QueryWrapper queryWrapper = new QueryWrapper<>();
// Step2:调用 mybatis-plus 提供的分页查询方法 .getRecords取出集合数据 不取的话会返回一些其它值
List userTestList = userTestMapper.selectPage(page, null).getRecords();
// Step3:获取分页数据
System.out.println(page.getCurrent()); // 获取当前页
System.out.println(page.getTotal()); // 获取总记录数
System.out.println(page.getSize()); // 获取每页的条数 默认10
System.out.println(page.getRecords()); // 获取每页数据的集合
System.out.println(page.getPages()); // 获取总页数
System.out.println(page.hasNext()); // 是否存在下一页
System.out.println(page.hasPrevious()); // 是否存在上一页
return userTestList;
}
}
@RestController
@RequestMapping("api/v1/test/my")
public class TestMyController {
@Autowired
private UserTestService userTestService;
/**
* 分页显示用户信息
*/
@GetMapping("pagelist")
public Dto pagelist(@RequestParam("current") int current,@RequestParam("size") int size){
List userTestList = userTestService.pagelist(current,size);
return DtoUtil.returnSuccess("返回正常数据",userTestList);
}
}
添加、修改数据时,每次都会使用相同的方式进行填充。比如 数据的创建时间、修改时间等。
Mybatis-plus 支持自动填充这些字段的数据。
给大家的数据表中有创建时间和修改时间字段
先手动添加作为演示给大家看一下结果
public interface UserTestService {
/**
* 添加方法
* @param userTest
* @return
*/
int addUser(UserTest userTest);
}
/**
* 测试用户实现类
*/
@Service
public class UserTestServiceImpl implements UserTestService {
@Autowired
UserTestMapper userTestMapper;
/**
* 添加测试用户方法
* @param userTest
* @return
*/
@Override
public int addUser(UserTest userTest) {
UserTest userTest1 = new UserTest();
//添加用户姓名
userTest1.setUsername(userTest.getUsername());
//添加当前系统时间
userTest1.setCreate_time(new Date());
int num = userTestMapper.insert(userTest1);
//调取的insert返回方法是int 所以这里也返回int
return num;
}
}
@RestController
@RequestMapping("api/v1/test/my")
public class TestMyController {
@Autowired
private UserTestService userTestService;
@PostMapping("addUser")
public Dto addUser(@RequestBody UserTest userTest){
int num = userTestService.addUser(userTest);
if(num==0){
return DtoUtil.returnSuccess("添加失败");
}else {
return DtoUtil.returnSuccess("添加成功");
}
}
}
在手动添加时间参数我们看一下结果
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* 自定义填充内容,根据属性名去填充数据
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "create_time", Date.class, new Date());
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "update_time", Date.class, new Date());
}
}
@Service
public class UserTestServiceImpl implements UserTestService {
@Autowired
UserTestMapper userTestMapper;
/**
* 添加测试用户方法
* @param userTest
* @return
*/
@Override
public int addUser(UserTest userTest) {
int num = userTestMapper.insert(userTest);
return num;
}
}
删除数据,可以通过物理删除,也可以通过逻辑删除。
物理删除指的是直接将数据从数据库中删除,不保留。
逻辑删除指的是修改数据的某个字段,使其表示为已删除状态,而非删除数据,保留该数据在数据库中,但是 查询时不显示该数据(查询时过滤掉该数据)。
给数据表增加一个字段:delete_flag,用于表示该数据是否被逻辑删除。
可以定义一个自动填充规则,初始值为0,0表示未删除,1表示删除
public interface UserTestService {
/**
* 删除方法
* @param id
* @return
*/
int deleteUser(int id);
}
@Service
public class UserTestServiceImpl implements UserTestService {
@Autowired
UserTestMapper userTestMapper;
@Override
public int deleteUser(int id) {
//可能因版本不同 这里的删除方法可能不同 具体看官方文档
int num = userTestMapper.deleteById(id);
return num;
}
}
控制层正常调service接口即可,判断返回的num是0还是1,这里就跳过了,直接上结果图
可以看到数据库中数据并没有消失,而是delete_flag字段改成了0。其实再执行sql时是执行了修改语句
执行查询语句后发现,确实不存在delete_flag=1的那条数据了,因为我们在属性上定义的逻辑删除注解delval的值,可根据数据库设计定义具体值
//@TableLogic(value = "0", delval = "1")
可以看到执行的sql语句是delete,而且再次查询时也不会带上delete_flag的条件
通过version机制实现
实现思路:
1.取出数据时,获取当前version
2.更新时,带上这个version
3.执行更新时,set version = newVersion where version = oldVersion
4.如果version不对,就更新失败
@Configuration//配置类 加入这个注解后才能被Spring扫描
@Component //注入spring管理
public class MyConfig {
/**
* 乐观锁插件
* @return 乐观锁插件得实例
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
/**
* 版本号(用于乐观锁, 默认为 1)
*/
@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;
//这个方法在自动填充的类里写
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "version", Integer.class, 1);
}
@Test
public void testVersion() {
User user = new User();
user.setName("tom").setAge(20).setEmail("tom@163.com");
//先执行插入操作
userService.save(user);
//查询一次
userService.list().forEach(System.out::println);
user.setName("jarry");
//执行修改操作
userService.update(user, null);
//再查询一次
userService.list().forEach(System.out::println);
}
代码生成器这里不做演示,因为MyBatis-Plus依赖不同,许多方法都会有改变,大家可以去官网查看