在已经使用mybatis的项目里引入mybatis-plus结果不能共存如何解决

发布时间：2023-03-30 11:28:45 作者：iii
来源：亿速云阅读：430

在已经使用MyBatis的项目里引入MyBatis-Plus结果不能共存如何解决

引言

在现代Java开发中，MyBatis是一个非常流行的持久层框架，它简化了数据库操作，提供了灵活的SQL映射配置。然而，随着项目规模的扩大和业务复杂度的增加，开发者们开始寻求更高效、更便捷的解决方案。MyBatis-Plus（简称MP）作为MyBatis的增强工具，提供了许多开箱即用的功能，如自动生成代码、分页插件、性能分析插件等，极大地提高了开发效率。

然而，当我们在已经使用MyBatis的项目中引入MyBatis-Plus时，可能会遇到两者不能共存的问题。本文将详细探讨这一问题的原因，并提供多种解决方案，帮助开发者顺利地在现有项目中引入MyBatis-Plus。

1. MyBatis与MyBatis-Plus的兼容性问题

1.1 MyBatis与MyBatis-Plus的关系

MyBatis-Plus是基于MyBatis的增强工具，它在MyBatis的基础上提供了更多的功能和便利性。MyBatis-Plus的核心思想是“简化开发，提高效率”，它通过自动生成代码、提供通用Mapper、分页插件等功能，减少了开发者的重复劳动。

1.2 兼容性问题的表现

在已经使用MyBatis的项目中引入MyBatis-Plus时，可能会遇到以下问题：

冲突的依赖：MyBatis-Plus依赖于MyBatis，但两者的版本可能存在冲突。
重复的配置：MyBatis和MyBatis-Plus的配置可能存在重复或冲突。
Mapper接口冲突：MyBatis-Plus提供了通用Mapper接口，可能与项目中已有的Mapper接口冲突。
SQL映射冲突：MyBatis-Plus的自动生成SQL功能可能与项目中已有的SQL映射文件冲突。

1.3 兼容性问题的原因

兼容性问题的主要原因在于MyBatis和MyBatis-Plus在项目中的共存方式不当。具体来说，可能有以下几种原因：

依赖管理不当：项目中同时引入了MyBatis和MyBatis-Plus的依赖，但版本不兼容。
配置冲突：MyBatis和MyBatis-Plus的配置文件中存在重复或冲突的配置项。
Mapper接口冲突：项目中同时使用了MyBatis的Mapper接口和MyBatis-Plus的通用Mapper接口，导致冲突。
SQL映射冲突：MyBatis-Plus的自动生成SQL功能与项目中已有的SQL映射文件冲突。

2. 解决MyBatis与MyBatis-Plus共存问题的方案

2.1 依赖管理

2.1.1 确保依赖版本兼容

首先，确保项目中引入的MyBatis和MyBatis-Plus的版本是兼容的。MyBatis-Plus的官方文档通常会列出其支持的MyBatis版本范围。开发者应根据项目中的MyBatis版本选择合适的MyBatis-Plus版本。

例如，如果项目中使用的MyBatis版本是3.5.7，那么可以选择MyBatis-Plus 3.4.3.4版本，因为该版本支持MyBatis 3.5.x。

2.1.2 排除冲突的依赖

在某些情况下，MyBatis-Plus可能会引入与项目中已有的MyBatis依赖冲突的版本。此时，可以通过Maven或Gradle的依赖排除功能，排除冲突的依赖。

例如，在Maven中，可以通过以下方式排除冲突的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.4</version>
    <exclusions>
        <exclusion>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
        </exclusion>
    </exclusions>
</dependency>

2.2 配置管理

2.2.1 合并配置文件

在引入MyBatis-Plus后，可以将MyBatis和MyBatis-Plus的配置文件合并为一个文件，避免重复配置。MyBatis-Plus的配置项通常以mybatis-plus为前缀，可以与MyBatis的配置项共存。

例如，可以在application.yml或application.properties中同时配置MyBatis和MyBatis-Plus的配置项：

mybatis:
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: com.example.model

mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: com.example.model
  global-config:
    db-config:
      id-type: auto

2.2.2 使用MyBatis-Plus的配置覆盖MyBatis配置

在某些情况下，MyBatis-Plus的配置项可以覆盖MyBatis的配置项。例如，MyBatis-Plus提供了更强大的分页插件，可以覆盖MyBatis的分页配置。

2.3 Mapper接口管理

2.3.1 使用MyBatis-Plus的通用Mapper接口

MyBatis-Plus提供了通用Mapper接口，可以替代项目中已有的Mapper接口。通用Mapper接口提供了丰富的CRUD操作，减少了开发者的重复劳动。

例如，可以将原有的Mapper接口替换为MyBatis-Plus的BaseMapper接口：

public interface UserMapper extends BaseMapper<User> {
    // 自定义的查询方法
    User selectByUsername(String username);
}

2.3.2 自定义Mapper接口与通用Mapper接口共存

在某些情况下，项目中可能同时需要自定义Mapper接口和MyBatis-Plus的通用Mapper接口。此时，可以通过以下方式实现两者的共存：

使用不同的包路径：将自定义Mapper接口和通用Mapper接口放在不同的包路径下，避免命名冲突。
使用不同的命名空间：在XML映射文件中，为自定义Mapper接口和通用Mapper接口使用不同的命名空间，避免SQL映射冲突。

2.4 SQL映射管理

2.4.1 使用MyBatis-Plus的自动生成SQL功能

MyBatis-Plus提供了自动生成SQL的功能，可以替代项目中已有的SQL映射文件。通过配置mybatis-plus.mapper-locations，可以指定自动生成的SQL映射文件的位置。

例如，可以在application.yml中配置：

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

2.4.2 保留已有的SQL映射文件

在某些情况下，项目中可能已经存在大量的SQL映射文件，不希望被MyBatis-Plus的自动生成SQL功能覆盖。此时，可以通过以下方式保留已有的SQL映射文件：

禁用自动生成SQL功能：在配置文件中禁用MyBatis-Plus的自动生成SQL功能。
手动管理SQL映射文件：将已有的SQL映射文件与MyBatis-Plus的自动生成SQL文件分开管理，避免冲突。

2.5 代码生成器

MyBatis-Plus提供了代码生成器，可以自动生成实体类、Mapper接口、Service接口等代码。在引入MyBatis-Plus后，可以使用代码生成器替代项目中已有的代码生成工具。

例如，可以通过以下配置使用MyBatis-Plus的代码生成器：

AutoGenerator mpg = new AutoGenerator();
mpg.setGlobalConfig(globalConfig);
mpg.setDataSource(dataSourceConfig);
mpg.setPackageInfo(packageConfig);
mpg.setStrategy(strategyConfig);
mpg.setTemplate(templateConfig);
mpg.execute();

2.6 分页插件

MyBatis-Plus提供了强大的分页插件，可以替代项目中已有的分页实现。通过配置mybatis-plus.global-config.db-config.id-type，可以指定分页插件的配置。

例如，可以在application.yml中配置：

mybatis-plus:
  global-config:
    db-config:
      id-type: auto

2.7 性能分析插件

MyBatis-Plus提供了性能分析插件，可以帮助开发者分析SQL执行性能。在引入MyBatis-Plus后，可以使用性能分析插件替代项目中已有的性能分析工具。

例如，可以通过以下配置启用性能分析插件：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

2.8 事务管理

MyBatis-Plus与MyBatis在事务管理上没有本质区别，可以继续使用Spring的事务管理机制。在引入MyBatis-Plus后，无需对事务管理进行特殊处理。

2.9 测试与验证

在完成上述配置后，建议进行全面的测试，确保MyBatis和MyBatis-Plus在项目中能够正常共存。可以通过单元测试、集成测试等方式，验证各个功能模块的正确性。

3. 实际案例分析

3.1 案例背景

假设我们有一个已经使用MyBatis的项目，项目中包含以下内容：

MyBatis版本：3.5.7
Mapper接口：UserMapper、OrderMapper
SQL映射文件：UserMapper.xml、OrderMapper.xml
分页实现：自定义分页插件

现在，我们希望在项目中引入MyBatis-Plus，以利用其提供的自动生成代码、通用Mapper接口、分页插件等功能。

3.2 解决方案

3.2.1 依赖管理

首先，确保项目中引入的MyBatis和MyBatis-Plus的版本是兼容的。根据MyBatis-Plus的官方文档，选择与MyBatis 3.5.7兼容的MyBatis-Plus版本，例如3.4.3.4。

在pom.xml中添加MyBatis-Plus的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.4</version>
</dependency>

3.2.2 配置管理

在application.yml中合并MyBatis和MyBatis-Plus的配置：

mybatis:
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: com.example.model

mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: com.example.model
  global-config:
    db-config:
      id-type: auto

3.2.3 Mapper接口管理

将原有的Mapper接口替换为MyBatis-Plus的BaseMapper接口：

public interface UserMapper extends BaseMapper<User> {
    // 自定义的查询方法
    User selectByUsername(String username);
}

public interface OrderMapper extends BaseMapper<Order> {
    // 自定义的查询方法
    List<Order> selectByUserId(Long userId);
}

3.2.4 SQL映射管理

保留已有的SQL映射文件，禁用MyBatis-Plus的自动生成SQL功能：

mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  global-config:
    db-config:
      id-type: auto
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.2.5 分页插件

使用MyBatis-Plus的分页插件替代自定义分页插件：

mybatis-plus:
  global-config:
    db-config:
      id-type: auto
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.2.6 测试与验证

编写单元测试和集成测试，验证MyBatis和MyBatis-Plus在项目中的共存情况。确保各个功能模块能够正常工作。

4. 总结

在已经使用MyBatis的项目中引入MyBatis-Plus时，可能会遇到两者不能共存的问题。通过合理的依赖管理、配置管理、Mapper接口管理、SQL映射管理等方式，可以有效地解决这一问题。本文详细探讨了MyBatis与MyBatis-Plus的兼容性问题，并提供了多种解决方案，帮助开发者顺利地在现有项目中引入MyBatis-Plus。

在实际项目中，开发者应根据项目的具体情况，选择合适的解决方案，并进行全面的测试，确保MyBatis和MyBatis-Plus能够正常共存，从而提高开发效率和代码质量。