SpringBoot整合mybatis-plus

官网：MyBatis-Plus

依赖

    com.baomidou
    mybatis-plus-boot-starter
    3.5.1

配置

配置 MapperScan 注解

@SpringBootApplication
@MapperScan("com.mybatisplus.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

配置application.yml

mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
    auto-mapping-behavior: full
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  # 逻辑删除配置
  global-config:
    db-config:
      logic-delete-value: 1
      logic-not-delete-value: 0

其他参数参照：基本配置

使用

实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value = "user")//和实体类名不一致
public class User {
    //标记该属性为主键。value:属性名和列名不一样
    @TableId(value = "id")
    private Integer id;
    @TableField(value = "name")
    private String name;
 
    private Integer age;
 
    private String email;
}

注解

@TableName

表名注解，标识实体类对应的表，用在实体类上。

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMap	String	否	""	xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludeProperty	String[]	否	{}	需要排除的属性名 @since 3.3.1

@TableId

实体类主键字段

属性	类型	必须指定	默认值	描述
value	String	否	""	主键字段名
type	Enum	否	IdType.NONE	指定主键类型

IdType

值	描述
AUTO	数据库 ID 自增
NONE	无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）
INPUT	insert 前自行 set 主键值
ASSIGN_ID	分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID	分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)

@TableField

字段注解（非主键）

属性	类型	必须指定	默认值	描述
value	String	否	""	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}
update	String	否	""	字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性）
insertStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_NULL insert into table_a(column) values (#{columnProperty})
updateStrategy	Enum	否	FieldStrategy.DEFAULT	举例：IGNORED update table_a set column=#{columnProperty}
whereStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_EMPTY where column=#{columnProperty}
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC 类型 (该默认值不代表会按照该值生效)
typeHandler	Class	否	UnknownTypeHandler.class	类型处理器 (该默认值不代表会按照该值生效)
numericScale	String	否	""	指定小数点后保留的位数

FieldStrategy

值	描述
IGNORED	忽略判断
NOT_NULL	非 NULL 判断
NOT_EMPTY	非空判断(只对字符串类型字段,其他类型字段依然为非 NULL 判断)
DEFAULT	追随全局配置
NEVER	不加入SQL

FieldFill

值	描述
DEFAULT	默认不处理
INSERT	插入时填充字段
UPDATE	更新时填充字段
INSERT_UPDATE	插入和更新时填充字段

@Version

乐观锁注解、标记 @Version 在字段上

@EnumValue

普通枚举类注解(注解在枚举字段上)

@TableLogic

表字段逻辑处理注解（逻辑删除）

属性	类型	必须指定	默认值	描述
value	String	否	""	逻辑未删除值
delval	String	否	""	逻辑删除值

@KeySequence

序列主键策略 oracle

属性	类型	必须指定	默认值	描述
value	String	否	""	序列名
dbType	Enum	否	DbType.OTHER	数据库类型，未配置默认使用注入 IKeyGenerator 实现，多个实现必须指定

@InterceptorIgnore

value 值为 1 | yes | on 视为忽略，例如 @InterceptorIgnore(tenantLine = "1")

value 值为 0 | false | off | 空值不变 视为正常执行。

@OrderBy

内置 SQL 默认指定排序，优先级低于 wrapper 条件查询

属性	类型	必须指定	默认值	描述
isDesc	boolean	否	true	是否倒序查询
sort	short	否	Short.MAX_VALUE	数字越小越靠前

Service CRUD 接口

参考官网接口，官网：CRUD 接口

1、service接口-继承Iservice

public interface IUserService extends IService {
}

2、接口实现类

@Service
public class IUserServiceImpl extends ServiceImpl implements IUserService {
}

Mapper CRUD 接口

参考

MyBatis-Plus 之selectMaps、selectObjs、selectCount、selectOne的使用 - Python技术站

MyBatis-Plus 之selectMaps、selectObjs、selectCount、selectOne的使用_java_脚本之家

//BaseMapper接口中提供了单表的所有操作，连表不行，需要自己实现
@Repository
public interface UserMapper extends BaseMapper {
}

新增

int insert(T entity); // 插入一条记录，entity 为 实体对象

修改

int update(T entity, Wrapper updateWrapper); // 根据 whereEntity 条件，更新记录

int updateById(T entity); // 根据 ID 修改

删除

int delete(Wrapper wrapper); // 根据 entity 条件，删除记录，wrapper 可以为 null

int deleteBatchIds(Collection idList); // 根据ID 批量删除

int deleteById(Serializable id); // 根据 ID 删除

int deleteByMap(Map map); // 根据 columnMap 条件，删除记录

查询

T selectById(Serializable id); // 根据 ID 查询

T selectOne(Wrapper queryWrapper); // 根据 entity 条件，查询一条记录

List selectBatchIds(Collection idList); // 根据ID 批量查询

List selectList(Wrapper queryWrapper); // 根据 entity 条件，查询全部记录

List selectByMap(Map columnMap); // 根据 columnMap 条件

List> selectMaps(Wrapper queryWrapper); // 根据 Wrapper 条件，查询全部记录

List