3.常见注解
在刚刚的入门案例中，我们仅仅引入了依赖，继承了BaseMapper就能使用MybatisPlus，非常简单。但是问题来了： MybatisPlus如何知道我们要查询的是哪张表？表中有哪些字段呢？
大家回忆一下，UserMapper在继承BaseMapper的时候指定了一个泛型：
泛型中的User就是与数据库对应的PO.
MybatisPlus就是根据PO实体的信息来推断出表的信息，从而生成SQL的。默认情况下：
- MybatisPlus会把PO实体的类名驼峰转下划线作为表名
- MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名，并根据变量类型推断字段类型
- MybatisPlus会把名为id的字段作为主键
但很多情况下，默认的实现与实际场景不符，因此MybatisPlus提供了一些注解便于我们声明表信息。
3.1@TableName
说明：
- 描述：表名注解，标识实体类对应的表
- 使用位置：实体类
示例：
@TableName("user") public class User { private Long id; private String name; }
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 |
3.2@TableId
说明：
- 描述：主键注解，标识实体类中的主键字段
- 使用位置：实体类的主键字段
示例：
@TableName("user") public class User { @TableId private Long id; private String name; }
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 方法) |
|
分布式全局唯一 ID 长整型类型(please use ASSIGN_ID) |
|
32 位 UUID 字符串(please use ASSIGN_UUID) |
|
分布式全局唯一 ID 字符串类型(please use ASSIGN_I |
这里比较常见的有三种：
AUTO：利用数据库的id自增长INPUT：手动生成id
ASSIGN_ID：雪花算法生成Long类型的全局唯一id，这是默认的ID策略
3.3@TableField
说明：
描述：普通字段注解
示例：
@TableName("user") public class User { @TableId private Long id; private String name; private Integer age; @TableField("isMarried") private Boolean isMarried; @TableField("concat") private String concat; }
一般情况下我们并不需要给字段添加@TableField注解，一些特殊情况除外：
- 成员变量名与数据库字段名不一致
- 成员变量是以
isXXX命名，按照JavaBean的规范，MybatisPlus识别字段时会把is去除，这就导致与数据库不符。 - 成员变量名与数据库一致，但是与数据库的关键字冲突。使用
@TableField注解给字段名添加````转义
支持的其它属性如下：
属性 |
类型 |
必填 |
默认值 |
描述 |
value |
String |
否 |
"" |
数据库字段名 |
exist |
boolean |
否 |
true |
是否为数据库表字段 |
condition |
String |
否 |
"" |
字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，参考(opens new window) |
update |
String |
否 |
"" |
字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性） |
insertStrategy |
Enum |
否 |
FieldStrategy.DEFAULT |
举例：NOT_NULL insert into table_a(<if test="columnProperty != null">column</if>) values (<iftest="columnProperty != null">#{columnProperty}</if>) |
updateStrategy |
Enum |
否 |
FieldStrategy.DEFAULT |
举例：IGNORED update table_a set column=#{columnProperty} |
whereStrategy |
Enum |
否 |
FieldStrategy.DEFAULT |
举例：NOT_EMPTY where <if test="columnProperty != null andcolumnProperty!=''">column=#{columnProperty}</if> |
fill |
Enum |
否 |
FieldFill.DEFAULT |
字段自动填充策略 |
select |
boolean |
否 |
true |
是否进行 select 查询 |
keepGlobalFormat |
boolean |
否 |
false |
是否保持使用全局的 format 进行处理 |
jdbcType |
JdbcType |
否 |
JdbcType.UNDEFINED |
JDBC 类型 (该默认值不代表会按照该值生效) |
typeHandler |
TypeHander |
否 |
类型处理器 (该默认值不代表会按照该值生效) |
|
numericScale |
String |
否 |
"" |
指定小数点后保留的位数 |
4.常见配置
MybatisPlus也支持基于yaml文件的自定义配置，详见官方文档：
大多数的配置都有默认值，因此我们都无需配置。但还有一些是没有默认值的，例如:
- 实体类的别名扫描包
- 全局id类型
mybatis-plus: type-aliases-package: com.itheima.mp.domain.po global-config: db-config: id-type: auto # 全局id类型为自增长
需要注意的是，MyBatisPlus也支持手写SQL的，而mapper文件的读取地址可以自己配置：
mybatis-plus: mapper-locations: "classpath*:/mapper/**/*.xml" # Mapper.xml文件地址，当前这个是默认值。
可以看到默认值是classpath*:/mapper/**/*.xml，也就是说我们只要把mapper.xml文件放置这个目录下就一定会被加载。
例如，我们新建一个UserMapper.xml文件：
然后在其中定义一个方法：
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.itheima.mp.mapper.UserMapper"> <select id="queryById" resultType="User"> SELECT * FROM user WHERE id = #{id} </select> </mapper>
然后在测试类UserMapperTest中测试该方法：
@Test void testQuery() { User user = userMapper.queryById(1L); System.out.println("user = " + user); }
