Mybatis-Plus-常用的注解：@TableName、@TableId、@TableField、@TableLogic

<think>我们正在配置MyBatis-Plus，需要设置`mapper-locations`和`global-config`参数。这两个参数分别用于指定Mapper XML文件的位置和全局配置。 根据引用[1]和引用[2]中的信息，我们可以这样配置： 1. **mapper-locations**：用于指定MyBatis Mapper XML文件的位置。在Spring Boot项目中，我们通常在application.yml（或application.properties）中进行配置。 2. **global-config**：用于设置MyBatis-Plus的全局配置，例如表前缀、主键生成策略等。 下面是一个配置示例（以application.yml为例）： ```yaml mybatis-plus: # 配置Mapper XML文件的位置 mapper-locations: classpath*:mapper/**/*.xml global-config: # 全局配置设置 db-config: # 全局表前缀 table-prefix: tbl_ # 全局主键类型 id-type: auto ``` 解释： - `mapper-locations: classpath*:mapper/**/*.xml`：表示在classpath路径下（包括jar文件内）的所有mapper目录及其子目录中查找所有以.xml结尾的文件作为Mapper XML文件。 - `global-config.db-config.table-prefix: tbl_`：设置全局表前缀为`tbl_`，这样在实体类上不需要使用`@TableName`指定表名时，会自动将实体类名转换为小写并在前面加上`tbl_`作为表名。例如，实体类`User`对应的表名是`tbl_user`。 - `global-config.db-config.id-type: auto`：设置主键生成策略为数据库自增（如MySQL的AUTO_INCREMENT）。 另外，引用[3]提醒我们，在配置中如果使用占位符（如`${...}`），需要确保该占位符在配置文件中已经定义，并且注意配置文件加载顺序。但在这个配置中，我们没有使用占位符，所以不用担心。 如果使用application.properties配置，则如下： ```properties # Mapper XML文件位置 mybatis-plus.mapper-locations=classpath*:mapper/**/*.xml # 全局配置 mybatis-plus.global-config.db-config.table-prefix=tbl_ mybatis-plus.global-config.db-config.id-type=auto ``` 注意：在配置`id-type`时，常用的值有： - `auto`：数据库自增 - `none`：无状态，该类型为未设置主键类型（跟随全局） - `input`：用户输入ID - `assign_id`：分配ID（主键类型为Number(Long和Integer)或String），使用接口`IdentifierGenerator`的方法`nextId`（默认实现类为`DefaultIdentifierGenerator`雪花算法） - `assign_uuid`：分配UUID（主键类型为String） 请根据实际需求选择。 最后，确保你的Mapper接口被正确扫描，通常使用`@MapperScan`注解在启动类上指定Mapper接口所在的包，例如： ```java @SpringBootApplication @MapperScan("com.example.mapper") public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 这样，MyBatis-Plus就能找到Mapper接口和对应的XML文件，并应用全局配置。 §§相关问题§§ 1. MyBatis-Plus中如何配置多个mapper-locations路径？ 2. global-config除了表前缀和主键类型，还有哪些常用配置？ 3. 如何为不同的表设置不同的主键生成策略？ 4. 在MyBatis-Plus中，如何自定义ID生成器？</think>### MyBatis-Plus 配置参数详解 #### 1. **mapper-locations 参数配置** **作用**：指定 MyBatis Mapper XML 文件的路径位置，支持通配符匹配多个文件。 **配置示例**（YAML 格式）： ```yaml mybatis-plus: mapper-locations: classpath*:mapper/**/*.xml ``` **说明**： - `classpath*:`：从所有类路径（包括依赖的 JAR 包）中搜索 - `mapper/**/*.xml`：匹配 `mapper` 目录下所有子目录的 `.xml` 文件 - 支持多个路径，用逗号分隔（如：`classpath:mapper1/*.xml, classpath:mapper2/*.xml`） #### 2. **global-config 参数配置** **作用**：配置全局策略，包含数据库表前缀、主键生成策略等。 **配置示例**（YAML 格式）： ```yaml mybatis-plus: global-config: db-config: table-prefix: tbl_ # 全局表前缀 id-type: auto # 主键策略（auto: 数据库自增） logic-delete-field: deleted # 逻辑删除字段名 logic-delete-value: 1 # 删除状态值 logic-not-delete-value: 0 # 未删除状态值 ``` **关键子配置说明**： | 参数 | 说明 | 可选值 | |------------------------|----------------------------------------------------------------------|---------------------------------| | `table-prefix` | 自动给所有表名添加前缀（如 `user` → `tbl_user`） | 任意字符串 | | `id-type` | 主键生成策略 | `auto`(自增),`assign_id`(雪花ID)| | `logic-delete-field` | 逻辑删除字段名（需在表中存在） | 如 `is_deleted` | | `logic-delete-value` | 删除状态值 | 数字/字符串 | | `logic-not-delete-value`| 未删除状态值 | 数字/字符串 | #### 3. **完整配置示例** ```yaml mybatis-plus: mapper-locations: classpath*:com/example/mapper/**/*.xml global-config: db-config: table-prefix: sys_ id-type: assign_id logic-delete-field: is_deleted logic-delete-value: 1 logic-not-delete-value: 0 configuration: map-underscore-to-camel-case: true # 开启驼峰命名转换 ``` #### 4. **注意事项** 1. **路径通配符规则**： - `*` 匹配单层目录 - `**` 匹配多层目录 - 示例：`classpath*:mappers/**/postgresql/*Mapper.xml` 2. **优先级规则**： - 实体类注解（如 `@TableName`）> 全局配置 > 数据库表名 - 例如：若实体类有 `@TableName("user")`，则忽略全局 `table-prefix` 3. **逻辑删除配置**： ```java @TableLogic private Integer isDeleted; // 需与global-config中的字段名一致 ``` 4. **多模块项目**： ```yaml mapper-locations: - classpath*:module1/mapper/*.xml - classpath*:module2/mapper/**/*.xml ``` [^1]: 关于 MyBatis-Plus 的基本配置路径定义，详见官方文档 [^2]: 全局表前缀配置的实际应用效果示例