【第30章】MyBatis-Plus之使用配置

---

前言

MyBatis-Plus 提供了丰富的配置选项，以满足不同用户的需求。这些配置中，一部分继承自 MyBatis 原生支持的配置，另一部分则是 MyBatis-Plus 特有的扩展配置。

---

一、使用方式

1.Spring Boot 配置

在 Spring Boot 项目中，可以通过 application.yml 或 application.properties 文件来配置 MyBatis-Plus。

mybatis-plus:
  configuration:
    # MyBatis 配置
    map-underscore-to-camel-case: true
  global-config:
    # 全局配置
    db-config:
      # 数据库配置
      id-type: auto

2.Spring MVC 配置

在传统的 Spring MVC 项目中，可以通过 XML 配置文件来配置 MyBatis-Plus。

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="mapperLocations" value="classpath*:mapper/**/*.xml"/>
    <property name="typeAliasesPackage" value="com.your.domain"/>
    <!-- 其他配置 -->
</bean>

二、常用配置

1.Base

1.1 configLocation

• 类型：String
• 默认值：null

指定 MyBatis 配置文件的位置。如果有单独的 MyBatis 配置文件，应将其路径配置到 configLocation。

配置示例：

mybatis-plus:
  config-location: classpath:/mybatis-config.xml

1.2 mapperLocations

• 类型：String[]
• 默认值：["classpath*:/mapper/**/*.xml"]

指定 MyBatis Mapper 对应的 XML 文件位置。如果在 Mapper 中有自定义方法，需要配置此项。

配置示例：

mybatis-plus:
  mapper-locations: classpath:/mapper/**.xml

注意
对于 Maven 多模块项目，扫描路径应以 classpath*: 开头，以加载多个 JAR 包中的 XML 文件。

1.3 typeAliasesPackage

• 类型：String
• 默认值：null

指定 MyBatis 别名包扫描路径，用于给包中的类注册别名。注册后，在 Mapper 对应的 XML 文件中可以直接使用类名，无需使用全限定类名。

配置示例：

mybatis-plus:
  type-aliases-package: com.your.domain

1.4 typeAliasesSuperType

• 类型：Class<?>
• 默认值：null

与 typeAliasesPackage 一起使用，仅扫描指定父类的子类。

配置示例：

mybatis-plus:
  type-aliases-super-type: com.your.domain.BaseEntity

1.5 typeHandlersPackage

• 类型：String
• 默认值：null

指定 TypeHandler 扫描路径，用于注册自定义类型转换器。

配置示例：

mybatis-plus:
  type-handlers-package: com.your.typehandlers

提示
TypeHandler 用于自定义类型转换。

2. Configuration

MyBatis-Plus 的 Configuration 配置继承自 MyBatis 原生支持的配置，这意味着您可以通过 MyBatis XML 配置文件的形式进行配置，也可以通过 Spring Boot 或 Spring MVC 的配置文件进行设置。

2.1 mapUnderscoreToCamelCase

• 类型：boolean
• 默认值：true

开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN（下划线命名） 到经典 Java 属性名 aColumn（驼峰命名） 的类似映射。

配置示例：

mybatis-plus:
  configuration:
    map-underscore-to-camel-case: true

提示
在 MyBatis-Plus 中，此属性也将用于生成最终的 SQL 的 select body。如果您的数据库命名符合规则，无需使用 @TableField 注解指定数据库字段名。

---

总结

回到顶部
更多使用配置请访问官方网站