特性
基本CRUD
BaseMapper
MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现,我们可以直接使用
插入数据
//添加功能
@Test
public void testInsert() {
User user = new User(null, "卤鸭", 22, "9936@gamil.com");
//INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
int result = userMapper.insert(user);
System.out.println("受影响的行数:"+result);
//1828417153977618434
System.out.println("id自动生成:"+user.getId());
}
MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id
删除数据
通过id删除记录
//根据Id删除数据
@Test
public void testDelete(){
//DELETE FROM user WHERE id=?
int result = userMapper.deleteById(1828417153977618434L);
System.out.println("受影响的行数:"+result);
}
通过id批量删除记录
//>通过id批量删除记录
@Test
public void testDeleteByIds(){
//通过多个id批量删除
//DELETE FROM user WHERE id IN ( ? , ? , ? )
List<Long> list = Arrays.asList(1L, 2L, 3L);
int result = userMapper.deleteBatchIds(list);
System.out.println("受影响的行数:"+result);
}
通过map条件删除记录
//通过map条件删除记录
@Test
public void testDeleteMap(){
//根据map集合中所设置的条件删除记录
//DELETE FROM user WHERE name = ? AND age = ?
HashMap<String, Object> map = new HashMap<>();
map.put("name","Sandy");
map.put("age",21);
int result = userMapper.deleteByMap(map);
System.out.println("受影响的行数:"+result);
}
修改数据
根据id修改数据
@Test
public void testUpdateById(){
//UPDATE user SET name=?, age=? WHERE id=?
User user = new User(5L,"卤鸭",22,"huluya@gmail.com");
int result = userMapper.updateById(user);
System.out.println("受影响的行数:"+result);
}
查询数据
>根据id查询用户信息
//>根据id查询用户信息
@Test
public void selectById(){
//SELECT id,name,age,email FROM user WHERE id=?
User user = userMapper.selectById(5L);
System.out.println(user);
}
>根据多个id查询多个用户信息
//>根据多个id查询多个用户信息
@Test
public void selectByIds(){
//根据多个id查询多个用户信息
//SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
List<Long> list = Arrays.asList(5L, 6L, 7L);
List<User> users = userMapper.selectBatchIds(list);
for (User user : users) {
System.out.println(user);
}
}
>通过map条件查询用户信息
//查询所有数据
@Test
public void selectAll(){
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
查询所有数据
//>通过map条件查询用户信息
@Test
public void selectByMap(){
HashMap<String, Object> map = new HashMap<>();
//SELECT id,name,age,email FROM user WHERE age = ?
map.put("age",22);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
自定义功能
其实就是自己定义Mapper接口方法,在xml映射文件中实现SQL语句功能,跟Mybatis中代码实现一样,就称为自定义功能
BaseMapper中的方法,大多方法中都有Wrapper类型的形参,此为条件构造器,可针对于SQL语
句设置不同的条件,若没有条件,则可以为该形参赋值null,即查询(删除/修改)所有数据
通用Service
说明: 通用 Service CRUD 封装IService接口,进一步封装 CRUD 采用 get 查询单行 remove删除 list查询集合 page分页 前缀命名方式区分 Mapper 层避免混淆
泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能,请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
>IService
MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl,封装了常见的业务层逻辑 详情查看源码IService和ServiceImpl
//* UserService继承IService模板提供的基础功能
public interface UserService extends IService<User> {
}
/**
* ServiceImpl实现了IService,提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求,则可以使用自定的UserService定义方法,并在实现类中实现
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
测试查询记录数
@Autowired
private UserService userService;
@Test
public void testGetCount(){
long count = userService.count();
System.out.println("总记录数:"+count);
}
测试批量插入
@Test
public void testSaveBatch(){
// SQL长度有限制,海量数据插入单条SQL无法实行,
//因此MP将批量插入放在了通用Service中实现,而不是通用Mapper
ArrayList<User> usersList = new ArrayList<>();
for (int i = 0; i < 5; i++) {
User user = new User();
user.setName("hyk"+i);
user.setAge(20+i);
usersList.add(user);
}
//SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? )
boolean b = userService.saveBatch(usersList);
System.out.println(b);
}
常用注解
将表user更名为t_user,测试查询功能 程序抛出异常,Table 'mybatis_plus.user' doesn't exist,因为现在的表名为t_user,而默认操作 的表名和实体类型的类名一致,即user表
@TableName(标识实体类对应的表)
在实体类类型上添加@TableName("t_user"),标识实体类对应的表,即可成功执行SQL语句
@TableName("t_user")
@TableName("t_user")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
通过全局配置解决问题
即实体类所对应的表都有固定的前缀,例如t_或tbl_ 此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就 不需要在每个实体类上通过@TableName标识实体类对应的表
global-config:
db-config:
# 配置MyBatis-Plus操作表的默认前缀
table-prefix: t_
@TableId
MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认 基于雪花算法的策略生成id
若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主 键列吗?
实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId //将属性所对应的字段指定为主键
private Long uid;
private String name;
private Integer age;
private String email;
}
@TableId的value属性(指定主键)
若实体类中主键对应的属性为id,而表中表示主键的字段为uid,此时若只在属性id上添加注解 @TableId,则抛出异常Unknown column 'id' in 'field list',即MyBatis-Plus仍然会将id作为表的 主键操作,而表中表示主键的是字段uid
需要通过@TableId注解的value属性,指定表中的主键字段,@TableId("uid")或 @TableId(value="uid")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
//@TableId(value = "uid") //将属性所对应的字段指定为主键
@TableId("uid")
private Long id;
private String name;
private Integer age;
private String email;
}
@TableId的type属性(定义主键策略)
type属性用来定义主键策略
@TableId(value = "uid",type = IdType.AUTO)
配置全局主键策略
global-config:
db-config:
# 配置MyBatis-Plus操作表的默认前缀
table-prefix: t_
# 配置MyBatis-Plus的主键策略
id-type: auto
雪花算法
雪花算法是由Twitter公布的分布式主键生成算法,它能够保证不同表的主键的不重复性,以及相同表的 主键的有序性。
@TableField(设置属性对应的字段名)
情况1
若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格
例如实体类属性userName
表中字段user_name 此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格
相当于在MyBatis中配置
情况2
若实体类中的属性和表中的字段不满足情况1
例如实体类属性name,表中字段user_name
此时需要在实体类属性上使用@TableField("user_name")设置属性所对应的字段名
@TableField("user_name")
private String name;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
//@TableId(value = "uid") //将属性所对应的字段指定为主键
@TableId(value = "uid",type = IdType.AUTO)
private Long id;
@TableField("user_name")
private String name;
private Integer age;
private String email;
}
@TableLogic(回收站功能)
物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据
逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库 中仍旧能看到此条数据记录
使用场景:可以进行数据恢复
//逻辑删除字段
@TableLogic
private Integer isDeleted;
查询所有数据
测试删除功能,真正执行的是修改
UPDATE t_user SET is_deleted=1 WHERE id=? AND is_deleted=0
测试查询功能,被逻辑删除的数据默认不会被查询
SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0
条件构造器和常用接口
wapper介绍
Wrapper:条件构造抽象类,最顶端父类
AbstractWrapper :用于查询条件封装,生成 sql 的 where 条件
QueryWrapper : 查询条件封装
UpdateWrapper : Update 条件封装
AbstractLambdaWrapper : 使用Lambda 语法
LambdaQueryWrapper :用于Lambda语法使用的查询
Wrapper LambdaUpdateWrapper : Lambda 更新封装Wrapper
QueryWrapper
组装查询条件
@Test
public void test(){
//查询用户名包含a,年龄在20到30之间,并且邮箱不为null的用户信息
//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE
//is_deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("user_name","a") //模糊查询
.between("age",20,30) //区间查询
.isNotNull("email"); //邮箱不为空
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
运行测试
组装排序条件
@Test
public void test2(){
//按年龄降序查询用户,如果年龄相同则按id升序排列
//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE
//is_deleted=0 ORDER BY age DESC,id ASC
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByDesc("age") //排序——降序 根据年龄
.orderByAsc("id"); //年龄相同:根据id 升序
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
测试
组装删除条件
@Test
public void test3(){
//删除email为空的用户
//DELETE FROM t_user WHERE (email IS NULL)
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("email");
//条件构造器也可以构建删除语句的条件
int result = userMapper.delete(queryWrapper);
System.out.println("受影响的行数:"+result);
}
组装修改功能
@Test
public void test4(){
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
//修改条件
queryWrapper.gt("age",20)
.like("user_name","a")
.or() //或
.isNull("email");
//修改字段内容
User user = new User();
user.setName("大牛马");
user.setAge(19);
user.setEmail("120");
int result = userMapper.update(user,queryWrapper);
System.out.println("受影响的行数:"+result);
}
条件的优先级
@Test
public void test5(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
//UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("user_name","a")
//lambda表达式内的逻辑优先运算
//(年龄大于20或邮箱为null)
.and(i ->i.gt("age",20).or().isNull("email"));
User user = new User();
user.setName("大牛马aaa");
user.setAge(18);
user.setEmail("10086");
int result = userMapper.update(user, queryWrapper);
System.out.println("受影响的行数:"+result);
}
组装select子句
@Test
public void test6(){
//查询用户信息的username和age字段
//SELECT user_name,age FROM t_user
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.select("user_name","age");
//selectMaps()返回Map集合列表,通常配合select()使用,避免User对象中没有被查询到的列值为null
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
maps.forEach(System.out::println);
}
实现子查询
@Test
public void test7(){
//查询id小于等于10的用户信息
//SELECT id,username AS name,age,email,is_deleted FROM t_user
//WHERE (id IN(select id from t_user where id <= 10))
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.inSql("uid","select uid from t_user where uid <= 10");
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
UpdateWrapper
@Test
public void test8(){
//将(年龄大于20或邮箱为null)并且用户名中包含有a的用户信息修改
//组装set子句以及修改条件
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.set("age",18)
.set("email","111222")
.like("user_name","a")
.and(i->i.gt("age",20).or().isNull("email"));
//这里必须要创建User对象,否则无法应用自动填充。如果没有自动填充,可以设置为null
//UPDATE t_user SET username=?, age=?,email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
//User user = new User();
//user.setName("张三");
//int result = userMapper.update(user, updateWrapper);
//UPDATE t_user SET age=?,email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
int result = userMapper.update(null, updateWrapper);
System.out.println("受影响的行数:"+result);
}
condition
在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因 此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若 没有选择则一定不能组装,以免影响SQL执行的结果
方案一
@Test
public void test08() {
//定义查询条件,有可能为null(用户未输入或未选择)
String username = "a";
Integer ageBegin = null;
Integer ageEnd = 24;
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
if(StringUtils.isNotBlank(username)){
queryWrapper.like("user_name","a");
}
if(ageBegin != null){
queryWrapper.ge("age", ageBegin);
}
if(ageEnd != null){
queryWrapper.le("age", ageEnd);
}
//SELECT uid AS id,user_name AS name,age,email,is_deleted
// FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
方案二
上面的实现方案没有问题,但是代码比较复杂,我们可以使用带condition参数的重载方法构建查 询条件,简化代码的编写
@Test
public void test09(){
String username = "a";
Integer ageBegin = null;
Integer ageEnd = 24;
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
queryWrapper.like(StringUtils.isNotBlank(username),"user_name","a")
.ge(ageBegin != null,"age",ageBegin)
.le(ageEnd != null,"age",ageEnd);
//SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user
// WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
LambdaQueryWrapper
LambdaQueryWrapper
是 MyBatis-Plus 提供的一个用于构建查询条件的辅助类。它的作用主要是帮助你以更加类型安全和优雅的方式构建 SQL 查询条件,避免使用字符串字面量的方式来指定字段,减少拼写错误和代码维护的复杂度。
主要特点:
类型安全:LambdaQueryWrapper
使用了 Java 的 Lambda 表达式,可以确保在构建查询条件时,字段名是通过实体类的 getter 方法引用的,而不是手动输入的字符串,这样可以在编译时发现错误。
@Test
public void test10(){
String username = "a";
Integer ageBegin = null;
Integer ageEnd = 24;
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.like(StringUtils.isNotBlank(username), User::getName,username)
.ge(ageBegin != null,User::getAge,ageBegin)
.le(ageEnd != null,User::getAge,ageEnd);
//SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user
// WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
LambdaUpdateWrapper
LambdaUpdateWrapper
是 MyBatis-Plus 提供的另一个辅助类,用于构建更新操作的条件。它与 LambdaQueryWrapper
类似,使用 Lambda 表达式来构建 SQL 的更新条件和更新内容,确保类型安全,减少字符串操作引发的错误。
主要特点:
类型安全:使用 Lambda 表达式指定字段,避免手动输入字段名,降低拼写错误的风险。
@Test
public void test11() {
//组装set子句
LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
updateWrapper.set(User::getAge,18)
.set(User::getEmail,"9936@qq.com")
.like(User::getName,"a")
.and(i ->i.lt(User::getAge,20).or().isNull(User::getEmail));//lambda表达式内的逻辑优先运算
User user = new User();
int result = userMapper.update(user, updateWrapper);
System.out.println("受影响的行数:" + result);
}
插件
分页插件
MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能
添加配置类
// @Configuration 表示这是一个Spring配置类,用于配置bean
@Configuration
// @MapperScan 注解用于扫描指定包路径下的所有 Mapper 接口,将其注入到 Spring 容器中。
@MapperScan("com.example.mybatis_plus_demo.mapper")
public class MybatisPlusConfig {
/**
* @Bean 注解表示这个方法的返回值将作为一个 Bean 注入到 Spring 容器中。
* 该方法用于配置 Mybatis-Plus 的插件拦截器。
*
* @return MybatisPlusInterceptor 是 Mybatis-Plus 提供的插件管理器,用于处理各种拦截器的链式调用。
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
// 创建 MybatisPlusInterceptor 对象,这是 Mybatis-Plus 的拦截器链入口
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 创建 PaginationInnerInterceptor 对象,这是一个分页插件,用于处理分页查询
// DbType.MYSQL 指定了数据库类型为 MySQL,不同数据库有不同的分页语法,MyBatis-Plus 需要知道具体数据库类型以生成正确的分页 SQL
PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
// 将分页拦截器添加到 MybatisPlusInterceptor 的拦截器链中
interceptor.addInnerInterceptor(paginationInterceptor);
// 返回配置好的MybatisPlusInterceptor实例
return interceptor;
}
}
测试
@SpringBootTest
public class MyBatisPluginsTest {
@Autowired
private UserMapper userMapper;
@Test
public void testPage() {
// 创建一个分页对象,参数分别为:当前页码为1,每页显示3条记录
Page<User> page = new Page<>(1, 3);
// 调用分页查询方法,第二个参数为查询条件,这里传入 null 表示无条件查询
userMapper.selectPage(page, null);
// 获取分页查询结果的记录列表
List<User> list = page.getRecords();
list.forEach(System.out::println); // 输出每条记录
// 打印分页信息
System.out.println("当前页:" + page.getCurrent());
System.out.println("每页显示的条数:" + page.getSize());
System.out.println("总记录数:" + page.getTotal());
System.out.println("总页数:" + page.getPages());
System.out.println("是否有上一页:" + page.hasPrevious());
System.out.println("是否有下一页:" + page.hasNext());
}
}
xml自定义分页
UserMapper中定义接口方法
/**
* 根据年龄查询用户列表,分页显示
* @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位
* @param age 年龄
* @return
*/
Page<User> selectPageOv(@Param("page") Page<User> page,@Param("age") Integer age);
UserMapper.xml中编写SQL
#配置类型别名所对应的包
type-aliases-package: com.example.mybatis_plus_demo.pojo
<select id="selectPageOv" resultType="User">
select uid,user_name,age,email from t_user where age > #{age}
</select>
测试
@Test
public void testSelectPageVo(){
//设置分页参数
Page<User> page = new Page<>(1, 5);
userMapper.selectPageOv(page, 20);
//获取分页数据
List<User> list = page.getRecords();
list.forEach(System.out::println);
System.out.println("当前页:"+page.getCurrent());
System.out.println("每页显示的条数:"+page.getSize());
System.out.println("总记录数:"+page.getTotal());
System.out.println("总页数:"+page.getPages());
System.out.println("是否有上一页:"+page.hasPrevious());
System.out.println("是否有下一页:"+page.hasNext());
}
Preparing:
select uid,user_name,age,email from t_user where age > ? LIMIT ?
乐观锁
乐观锁实现流程
数据库中添加version字段
取出记录时,获取当前version
SELECT id,`name`,price,`version` FROM product WHERE id=1
更新时,version + 1,如果where语句中的version版本不对,则更新失败
UPDATE product SET price=price+50, `version`=`version` + 1 WHERE id=1 AND `version`=1
Mybatis-Plus实现乐观锁
修改实体类
@Data
public class Product {
private Long id;
private String name;
private Integer price;
@Version
private Integer version;
}
添加乐观锁插件配置
//添加乐观锁插件配置
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
测试
优化流程
@Test
public void test() {
//1、小李
Product p1 = productMapper.selectById(1L);
System.out.println("小李取出的价格" + p1.getPrice());
//2、小王
Product p2 = productMapper.selectById(1L);
System.out.println("小王取出的价格" + p2.getPrice());
//3、小李将价格加了50元,存入了数据库
p1.setPrice(p1.getPrice() + 50);
int r1 = productMapper.updateById(p1);
System.out.println("小李修改了结果" + r1);
//4、小王将商品减了30元,存入了数据库
p2.setPrice(p2.getPrice() - 30);
int r2 = productMapper.updateById(p2);
if (r2 == 0) {
System.out.println("操作失败请重试");
Product pp2 = productMapper.selectById(1L);
pp2.setPrice(pp2.getPrice() - 30);
int rr2 = productMapper.updateById(pp2);
System.out.println("小王修改了结果" + rr2);
}
//最后的结果:120
Product p3 = productMapper.selectById(1L);
System.out.println("最后的结果:" + p3.getPrice());
}
通用枚举
表中的有些字段值是固定的,例如性别(男或女),此时我们可以使用MyBatis-Plus的通用枚举来实现
数据库表添加字段sex
创建通用枚举类型
@Getter
public enum SexEnum {
MALE(1,"男"),
FEMALE(2,"女");
@EnumValue //将注解所标识的属性的值存储到数据库中
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
实体类中添加属性
private SexEnum sex;
测试
@SpringBootTest
public class MyBatisPlusEnums {
@Autowired
private UserMapper userMapper;
@Test
public void test1(){
User user = new User();
user.setName("Jenny");
user.setEmail("Jenny@163.com");
user.setAge(19);
user.setSex(SexEnum.FEMALE);
// INSERT INTO t_user ( user_name, age, sex, email ) VALUES ( ?, ?, ?, ? )
int insert = userMapper.insert(user);
System.out.println(insert);
}
}
代码生成器
引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
-
MyBatis-Plus Generator(
mybatis-plus-generator
)- 作用: MyBatis-Plus Generator 是 MyBatis-Plus 提供的代码生成器。它能够根据数据库表结构自动生成对应的 Java 实体类、Mapper 接口、Service 类、Controller 类等代码,减少手动编写的工作量,提高开发效率。
- 使用场景: 通常用于项目初期,根据数据库设计快速生成基础代码,也可以在项目中途增加新的表时使用,以保持代码的一致性。
-
FreeMarker(
freemarker
)- 作用: FreeMarker 是一个 Java 模板引擎,允许你定义模板并使用它们生成输出文本(如 HTML、配置文件、源代码等)。在 MyBatis-Plus Generator 中,FreeMarker 通常用于定制代码生成的模板,使得生成的代码更符合项目的需求和规范。
- 使用场景: 当你需要自定义代码生成器生成的文件格式或内容时,会通过 FreeMarker 定义模板,使生成的代码更加灵活和符合项目的实际需求。
使用官网提供的代码生成器
package com.example.mybatis_plus_demo;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.Collections;
/**
* @author hyk~
* @description 这是一个使用 MyBatis-Plus Generator 进行代码自动生成的示例类
*/
@SpringBootTest
public class FastAutoGeneratorTest {
public static void main(String[] args) {
// 创建 FastAutoGenerator 对象,并指定数据库连接信息
FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false",
"root", "123456")
.globalConfig(builder -> {
// 全局配置
builder.author("hyk") // 设置生成文件的作者名
//.enableSwagger() // 开启 Swagger 模式,用于生成 API 文档注解
.fileOverride() // 如果生成的文件已存在,重新生成时会覆盖原文件
.outputDir("D:\\ideaProject\\MybatisPlus\\mybatis_plus_demo"); // 指定生成文件的输出目录
})
.packageConfig(builder -> {
// 包配置
builder.parent("com.example") // 设置父包名
.moduleName("mybatis_plus_demo") // 设置父包模块名,生成的代码会放在这个模块下
// 设置 Mapper XML 文件的生成路径
.pathInfo(Collections.singletonMap(OutputFile.mapperXml,
"D:\\ideaProject\\MybatisPlus\\mybatis_plus_demo"));
})
.strategyConfig(builder -> {
// 策略配置
builder.addInclude("t_user") // 设置要生成代码的表名,这里是 t_user 表
.addTablePrefix("t_", "c_"); // 设置过滤表前缀,生成的类名会去掉这些前缀
})
// 配置使用 FreeMarker 引擎模板,默认情况下使用 Velocity 引擎模板
.templateEngine(new FreemarkerTemplateEngine())
.execute(); // 执行代码生成操作
}
}
运行
目录下会生成文件
生成的映射文件
多数据源
适用于多种场景:纯粹多库、 读写分离、 一主多从、 混合模式等
目前我们就来模拟一个纯粹多库的一个场景,其他场景类似
场景说明: 我们创建两个库,分别为:mybatis_plus(以前的库不动)与mybatis_plus_1(新建),将 mybatis_plus库的product表移动到mybatis_plus_1库,这样每个库一张表,通过一个测试用例 分别获取用户数据与商品数据,如果获取到说明多库模拟成功
1.创建数据库及表
CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus_1`;
CREATE TABLE product
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称',
price INT(11) DEFAULT 0 COMMENT '价格',
version INT(11) DEFAULT 0 COMMENT '乐观锁版本号',
PRIMARY KEY (id)
);
添加测试数据
INSERT INTO product (id, NAME, price) VALUES (1, '外星人笔记本', 100)
删除mybatis_plus库product表
use mybatis_plus;
DROP TABLE IF EXISTS product;
2.引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
3.配置多数据源
注释掉之前的数据库连接,添加新配置
spring:
# 配置数据源信息
datasource:
dynamic:
# 设置默认的数据源或者数据源组,默认值即为master
primary: master
# 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源
strict: false
datasource:
master:
url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
slave_1:
url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
4.创建用户service
public interface UserService extends IService<User> {
}
@DS("master") //指定所操作的数据源
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
5.创建商品service
public interface ProductService extends IService<Product> {
}
@DS("save_1")
@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapper, Product> implements ProductService {
}
6.测试
@Autowired
private UserService userService;
@Autowired
private ProductService productService;
@Test
public void testDynamicDataSource(){
System.out.println(userService.getById(1L));
System.out.println(productService.getById(1L));
}
小结
在yml中配置数据源信息
@DS注解
MyBatisX插件
MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率
MyBatisX一款基于 IDEA 的快速开发插件,为效率而生。
MyBatisX插件用法:https://baomidou.com/pages/ba5b24/
右键数据库表可快速生成代码