注解
@TableName
表名注解,当数据库中的表名和实体类名之间不能完全匹配时,需要使用这个注解进行绑定。
如:数据库表中的数据库表名为 t_student
,而实体类的类名为: Student
,则需要在该类上增加注解:
@TableName(value = "t_student")
public class Student {
private Long stuId;
}
全局设置数据库表前缀
当数据库表中的所有表名前有前缀时,需要每次指定 @TableName
注解,很麻烦,需要使用全局配置:
mybatis-plus:
global-config:
db-config:
table-prefix: "t_"
@TableId
主键注解,当数据库中的主键和实体类中主键属性不同时,使用这个注解进行绑定。 如:数据库表中的主键是 id
,而实体类中的属性值是 stuId
,那么就在实体类主键属性上加上注解
public class Student {
@TableId(value = "id")
private Long stuId;
}
IdType
@TableId
注解还有一个属性配置是主键的主键类型,具体可选值如下,默认值为:IdType.NONE
值 | 描述 |
AUTO | 数据库自增 |
INPUT | 自行输入 |
ID_WORKER | 分布式全局唯一ID 长整型类型 |
UUID | 32位UUID字符串 |
NONE | 无状态(默认) |
IDWORKERSTR | 分布式全局唯一ID 字符串类型 |
全局设置设置注解策略
设置主键策略,默认值:ID_WORKER
mybatis-plus:
global-config:
db-config:
id-type: AUTO
全局设置驼峰功能
mybatisPlus 有一个全局的配置策略,可以实现数据库表中的列名字段是下划线分割,自动对应实体类中驼峰名:
如:数据库中的 stu_address
字段与实体类中的 stuAddress
属性字段相对应。
mybatis-plus:
global-config:
db-config:
table-underline: true
# 表名、是否使用下划线命名(默认 true:默认数据库表下划线命名)
在 Springboot 中,可以通过设置 map-underscore-to-camel-case
属性为 true 来开启驼峰功能。因此 mybatisPlus 也继承了这种配置,默认为 true:
mybatis-plus:
configuration:
map-underscore-to-camel-case: true
@TableField
value
当显示配置的时候,则按设置的值为准。
exist
标识该字段是数据库表字段,当实体类中有属性字段不在数据库表中的时候,就需要在数据库操作时忽略这些字段,因此可以配置 exist=false
属性配置,如果不配置,默认为:true
BaseMapper
BaseMapper 接口是专门用来进行通用增删改查的接口,通过指定泛型可以对数据实体对象进行通用的CIUD操作,大致可以分为四类:
Insert
intinsert(T entity)
insert 方法会将实体对象中的非空属性值映射到数据库,进行插入操作,也就是说有多少非空属性,执行的SQL语句中才插入多少,和 mybatis 中的 insertSeletive 一样,有值才操作。
亮点:
插入成功默认返回主键,mybatis Plus 插入数据之后,实体类中的主键会返回给实体类,相比 mybatis 原生的默认不返回要很多繁琐的配置:
id="insert" useGeneratedKeys="true" keyProperty="stuId" parameterType="org.woodwhales.king.Student">
insert into student(userName, password, comment)
values(#{userName}, #{password}, #{comment})
其中: keyProperty
中配置的是实体类中的属性字段,用来接收数据库表返回的主键值。
Update
根据主键更新
intupdateById(T entity)
带条件的更新
intupdate(T entity,Wrapper<T>updateWrapper)
如:更新姓名为 Tom
且年龄为 28 的学生数据:
LambdaQueryWrapper<Student> lambdaQueryWrapper = new QueryWrapper<Student>().lambda()
.eq(Student::getName, "Tom")
.eq(Student::getAge, 28);
Student student = Student.builder()
.name("woodwhales")
.age(20)
.email("woodwhales@woodwhales.com").build();
int row = studentMapper.update(student, lambdaQueryWrapper);
SQL脚本执行日志:
==> Preparing: UPDATE student SET name=?, age=?, email=? WHERE name = ? AND age = ?
==> Parameters: woodwhales(String), 20(Integer), woodwhales@woodwhales.com(String), Tom(String), 28(Integer)
<== Updates: 1
Select
Delete
条件构造器
EntityWapper
注意:条件构造器中使用的是数据列名,而不是实体类对象属性。
分页查询(带条件)
对于条件构造器的编写,可以使用最原始写法:
QueryWrapper<User> queryWrapper = new QueryWr