mybatis-plus是基于mybatis,相对于mybatis,他有许多特性是比较好用的,比如分页查询、表字段自动转换为实体类属性等,使用mybatis-plus与Spring Data JPA有点相似的地方,个人觉得mybatis-plus的分页比JPA的分页好用。其实在mybatis-plus官网上已经有很详细的教程了,在这里写博客也是为了自己能够更好的整理思路。先上一下官网基于springboot教程地址:Mybatis-Plus
1.添加pom引用
maven的引用很简单,官方已经给出starter,不需要我们考虑它的依赖关系了,此处使用的是2.3版本。
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>2.3</version>
</dependency>
2.配置
官方已经提供了基于springboot的配置,将其拷贝过来放在application.yml中即可使用,此处只是将官方部分的配置删减过一些。其中column-underline: true特别好用,会自动将下划线格式的表字段,转换为以驼峰格式命名的属性。
mybatis-plus:
global-config:
db-config:
id-type: auto
field-strategy: not_empty
#驼峰下划线转换
column-underline: true
#逻辑删除配置
logic-delete-value: 0
logic-not-delete-value: 1
db-type: mysql
refresh: false
configuration:
map-underscore-to-camel-case: true
cache-enabled: false
3.使用
1.创建实体类,创建实体类与JPA特别相似,其中@TableName注解是为了指定此实体类对应数据库的哪一张表;@TableId指定的是主键,type属性指定的是该主键自增的方式,AUTO代表自增,UUID代表使用UUID增加主键;还有一个注解@TableFiled,此注解主要用在非主键实体属性上,下面是官方给出的此注解所有属性。
值 | 描述 |
---|---|
value | 字段值(驼峰命名方式,该值可无) |
update | 预处理 set 字段自定义注入 |
condition | 预处理 WHERE 实体条件自定义运算规则 |
el | 详看注释说明 |
exist | 是否为数据库表字段( 默认 true 存在,false 不存在 ) |
strategy | 字段验证 ( 默认 非 null 判断,查看 com.baomidou.mybatisplus.enums.FieldStrategy ) |
fill | 字段填充标记 ( FieldFill, 配合自动填充使用 ) |
生成一个实体类实例
@TableName("t_patrol_task")
public class PatrolTaskEntity {
@TableId(value = "id",type = IdType.AUTO)
private Integer id;
private Integer jobId;
Getter…
Setter….
}
2.创建mapper,与JPA有相像之处。使用@Mapper为了把mapper这个DAO交給Spring管理,且可以不再写mapper映射文件;继承BaseMapper可以方便使用mybatis-plus方法,泛型需要写对用的实体类。此处直接使用slelect * from,mybatis-plus会根据实体类自动驼峰转下划线映射到表的字段中。
@Mapper
public interface PatrolTaskMapper extends BaseMapper<PatrolTaskEntity> {
@Select("select * from t_patrol_task where id = #{id} and deleted_at is null")
PatrolTaskEntity queryByIdAndDeletedAtIsNull(@Param(“id”) Integer id);
}
4.条件构造器
1.查询单条数据,非主键查询,只要在一个实体内写入属性,然后再用mybatis-plus自带的selectOne()方法即可查询(注意:查询的限制条件必须此条数据是唯一的,不然查询后会报错)。个人觉得此种查询使用不便,不如直接使用nativeSql进行查询来的利索。