当前位置：首页 > news >正文

mybatis过渡到mybatis-plus过程中需要注意的地方

news 2025/8/25 10:17:35

将 MyBatis 升级为 MyBatis-Plus（简称 MP）是一个平滑过渡的过程，因为 MP 是 MyBatis 的增强工具（而非替代），但仍有一些关键注意事项需要关注，以确保升级后功能兼容且能充分利用 MP 的特性：

1. 依赖管理与版本兼容

替换依赖：移除原 MyBatis 的依赖（如mybatis、mybatis-spring），引入 MyBatis-Plus 的核心依赖（mybatis-plus-boot-starter 或 mybatis-plus）。
示例（Maven）：

<!-- 移除旧依赖 -->
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis-spring</artifactId>
</dependency><!-- 引入MP依赖 -->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.3.1</version> <!-- 选择稳定版本，需与Spring Boot版本兼容 -->
</dependency>

版本兼容：确保 MP 版本与 Spring Boot、数据库驱动（如 MySQL Connector）兼容（参考 MP 官方文档的版本适配表）。

2. 核心配置调整

SqlSessionFactory 配置：
原 MyBatis 的SqlSessionFactory需替换为 MP 的MybatisSqlSessionFactoryBean（自动集成 MyBatis 的功能，同时添加 MP 增强）。
若使用 Spring Boot，默认自动配置可无需手动修改；若手动配置，需调整：
```
// 旧配置（MyBatis）
// SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();// 新配置（MP）
MybatisSqlSessionFactoryBean sessionFactory = new MybatisSqlSessionFactoryBean();
```
全局配置：MP 支持全局配置（如主键策略、驼峰命名映射等），可通过MybatisConfiguration或配置文件（application.yml）设置，替代原 MyBatis 的mybatis-config.xml部分配置。
示例（YAML）：
```
mybatis-plus:configuration:map-underscore-to-camel-case: true # 驼峰命名映射（默认开启）global-config:db-config:id-type: AUTO # 全局主键策略（需与数据库主键生成策略匹配）
```

3. Mapper 接口与 XML 适配

继承 BaseMapper：MP 的BaseMapper<T>提供了 CRUD 通用方法（如selectById、insert），原有 Mapper 接口可继承它以减少重复代码：

// 旧：自定义CRUD方法
public interface UserMapper {User selectById(Long id);int insert(User user);
}// 新：继承BaseMapper，直接使用通用方法（可保留自定义方法）
public interface UserMapper extends BaseMapper<User> {// 保留原自定义方法（如复杂查询）List<User> selectByAge(int age);
}

注意：若原有方法名与BaseMapper冲突（如selectById），需确保逻辑一致，或重命名自定义方法。

XML 映射文件：
原有 XML 文件可直接复用，但需注意：
- 避免与BaseMapper的通用方法重复（如无需再写selectById的 XML 实现）；
- MP 的条件构造器（QueryWrapper）可替代部分动态 SQL，减少 XML 复杂度。

4. 实体类注解适配

MP 通过注解实现实体与数据库表的映射，需在原有实体类上添加必要注解：

@TableName("t_user")：指定数据库表名（若类名与表名不一致）；
@TableId(type = IdType.AUTO)：指定主键字段及生成策略（需与全局配置或数据库策略匹配）；
@TableField("user_name")：指定字段名（若属性名与字段名不一致，或排除非表字段@TableField(exist = false)）。

示例：

@TableName("t_user") // 表名
public class User {@TableId(type = IdType.AUTO) // 主键自增private Long id;@TableField("user_name") // 字段名映射private String userName;@TableField(exist = false) // 非表字段private String tempData;
}

5. 插件与扩展功能适配

分页插件：MP 自带分页插件（MybatisPlusInterceptor），替代原 MyBatis 的 PageHelper 等插件，需单独配置：

java

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // 分页插件return interceptor;
}