MyBatis-Plus 和通用mapper结合使用

<think>我们正在讨论的是MyBatis-Plus与通用Mapper（这里指的是早期流行的tk.mybatis.mapper）的结合使用问题。但请注意，MyBatis-Plus自身已经提供了强大的通用Mapper功能（即BaseMapper），通常不需要再集成tk.mybatis的通用Mapper。然而，有些项目可能因为历史原因需要同时使用两者，或者用户误将两者混为一谈。 根据引用[2]和[3]，MyBatis-Plus自身已经封装了通用的CRUD方法（通过BaseMapper接口），并且提供了条件构造器（Wrapper）来解决复杂条件查询问题。因此，如果用户已经使用了MyBatis-Plus，那么通常不需要再引入tk.mybatis的通用Mapper。 但是，如果用户确实需要将两者结合使用（例如，项目中原先使用了tk.mybatis，后来引入了MyBatis-Plus，需要共存），那么需要注意以下问题： ### 1. 避免同时继承两个Mapper接口 通常情况下，一个Mapper接口不能同时继承两个不同的通用Mapper接口（如`BaseMapper`和`tk.mybatis.mapper.common.Mapper`）。因为Java不支持多继承（接口可以多继承，但两个父接口如果有相同方法签名，会导致冲突）。 **解决方案：** - 如果必须使用两者，可以创建两个不同的Mapper接口，分别继承不同的父接口，然后在Service层分别注入使用。 - 或者，只使用其中一个。MyBatis-Plus的功能已经非常强大，通常可以替代tk.mybatis的通用Mapper。 ### 2. 配置冲突 两者都需要在Spring Boot中进行配置，可能会产生冲突。 **MyBatis-Plus配置示例：** ```java @Configuration @MapperScan("com.example.mapper") // 扫描MyBatis-Plus的Mapper接口 public class MybatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } } ``` **tk.mybatis配置示例（如果同时使用）：** ```java @Configuration @MapperScan( basePackages = "com.example.tkmapper", // 注意：这里扫描的包路径要不同于MyBatis-Plus的Mapper路径 markerInterface = Mapper.class, // 指定标记接口 sqlSessionFactoryRef = "sqlSessionFactory" ) public class TkMapperConfig { // 配置tk.mybatis的SqlSessionFactory等 } ``` ### 3. 注解冲突 两者都提供了一些注解（如@Table, @Id等），如果同时使用，要注意避免注解混用。建议统一使用MyBatis-Plus的注解（如`@TableName`, `@TableId`）或tk.mybatis的注解（如`@Table`, `@Id`），不要在一个实体类中混用。 ### 4. 代码生成器冲突 两者都有自己的代码生成器，如果同时使用，需要分别配置生成。 ### 5. 常见问题：Parameter 'xxx' not found 这个问题通常出现在自定义方法中，尤其是在同时使用MyBatis-Plus和tk.mybatis时，可能因为参数传递问题导致。 **解决方法：** - 在自定义方法的参数上使用`@Param`注解明确指定参数名（如之前回答所述）。 - 检查XML中的SQL语句，确保参数引用正确。 ### 6. 推荐方案：仅使用MyBatis-Plus 考虑到MyBatis-Plus已经提供了非常全面的功能（包括通用CRUD、条件构造器、分页、性能分析等），而且与MyBatis原生兼容，建议新项目直接使用MyBatis-Plus，不再引入tk.mybatis。这样也可以避免很多兼容性问题。 **示例：仅使用MyBatis-Plus的Mapper** ```java // UserMapper.java import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.example.entity.User; public interface UserMapper extends BaseMapper<User> { // 这里已经包含了基本的CRUD方法 // 如果需要自定义方法，可以添加 User selectUserById(@Param("id") Long id); } ``` 然后在XML中编写自定义SQL： ```xml <select id="selectUserById" resultType="User"> SELECT * FROM user WHERE id = #{id} </select> ``` ### 总结 1. **避免混合使用**：除非有特殊原因，否则不要同时使用MyBatis-Plus和tk.mybatis的通用Mapper。 2. **迁移方案**：如果项目原先使用tk.mybatis，可以逐步迁移到MyBatis-Plus。MyBatis-Plus提供了与tk.mybatis类似的功能，且更加强大。 3. **配置分离**：如果必须共存，务必通过不同的包路径和配置类进行隔离。 4. **参数问题**：在自定义方法中，务必使用`@Param`注解明确参数名称，避免出现参数找不到的问题。 如果用户遇到特定的错误信息（如BindingException），请参考之前的回答进行排查。 §§相关问题§§ 1. MyBatis-Plus 与 tk.mybatis 的通用 Mapper 主要区别是什么？ 2. 如何将项目从 tk.mybatis 迁移到 MyBatis-Plus？ 3. MyBatis-Plus 的 BaseMapper 已经提供了哪些方法？</think>### MyBatis-Plus 与通用 Mapper 结合使用指南 根据引用内容，MyBatis-Plus 自身已内置强大的通用 Mapper 功能（通过 `BaseMapper` 接口），无需额外集成第三方通用 Mapper 库（如 tk.mybatis）。以下是正确使用方法和常见问题解决方案： --- #### 一、MyBatis-Plus 通用 Mapper 的正确使用方式 1. **继承 BaseMapper 接口**（引用[3][4]） ```java @Repository public interface UserMapper extends BaseMapper<User> { // 自动获得所有CRUD方法 // 无需手动编写基础SQL } ``` 2. **实体类注解配置**（引用[3]） ```java @TableName("sys_user") // 指定表名 public class User { @TableId(type = IdType.AUTO) // 主键策略 private Long id; @TableField("user_name") // 字段映射 private String username; } ``` 3. **Service 层调用示例** ```java @Service public class UserService { @Autowired private UserMapper userMapper; public User getById(Long id) { return userMapper.selectById(id); // 直接调用内置方法 } } ``` --- #### 二、常见问题解决方案 1. **参数绑定异常**（如 `Parameter 'id' not found`） **原因**：自定义方法中未使用 `@Param` 注解 **解决**： ```java // Mapper接口 User selectCustom(@Param("id") Long id, @Param("ew") Wrapper<User> wrapper); ``` ```xml <!-- XML映射 --> <select id="selectCustom" resultType="User"> SELECT * FROM user WHERE id = #{id} AND ${ew.customSqlSegment} </select> ``` 2. **内置方法被覆盖** **现象**：自定义方法与 MyBatis-Plus 内置方法同名（如 `selectList`） **解决**：重命名自定义方法 ```java // 错误：覆盖内置方法 List<User> selectList(@Param("status") Integer status); // 正确：使用自定义名称 List<User> selectByStatus(@Param("status") Integer status); ``` 3. **Wrapper 条件构造器使用问题**（引用[3]） **正确用法**： ```java QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("status", 1) .like("name", "张"); List<User> users = userMapper.selectList(wrapper); ``` --- #### 三、高级集成方案 若需兼容历史遗留的通用 Mapper（如 tk.mybatis），需配置 Mapper 扫描隔离： ```java @Configuration @MapperScan( basePackages = "com.example.plusmapper", markerInterface = com.baomidou.mybatisplus.core.mapper.BaseMapper.class ) @MapperScan( basePackages = "com.example.tkmapper", markerInterface = tk.mybatis.mapper.common.Mapper.class ) public class MultiMapperConfig { // 隔离不同Mapper实现 } ``` --- #### 四、性能优化建议 1. **启用二级缓存**（引用[1]） ```yaml mybatis-plus: configuration: cache-enabled: true ``` 2. **分页插件配置** ```java @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); return interceptor; } ``` --- #### 总结对比（引用[2]） | **功能** | MyBatis-Generator | 通用 Mapper | MyBatis-Plus | |------------------|-------------------|-------------------|----------------------------| | CRUD 方法生成 | 需手动调用 | 自动生成 | 自动生成 + 条件构造器 | | 条件构造 | 不支持 | 有限支持 | 强大的 Wrapper API | | 注解配置 | 有限 | 完善 | 全面增强 | | 分页插件 | 需手动集成 | 需手动集成 | 内置支持 | > 提示：MyBatis-Plus 已包含通用 Mapper 的核心功能，推荐直接使用其内置的 `BaseMapper` 接口，避免集成复杂度[^2][^3]。