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

MyBatis-Plus 混合使用 XML 和注解

news 来源：原创 2025/6/13 9:36:33

mybatisplus代码生成器：

版本匹配是个比较麻烦的问题，这是我的配置：

       <dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.2</version></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.5.2</version></dependency><dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>2.3.31</version> <!-- 推荐版本 --></dependency>
CodeGenerator：
package com.neuedu.hisweb.utils;import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import com.baomidou.mybatisplus.annotation.FieldFill; // 引入正确的枚举类
import org.apache.commons.lang3.StringUtils;import java.util.Collections;
import java.util.Scanner;public class CodeGenerator {private static final String URL = "jdbc:mysql://localhost:3306/his02?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=true";private static final String USERNAME = "root";private static final String PASSWORD = "1";private static final String AUTHOR = "xj";private static final String PARENT_PACKAGE = "com.neuedu.hisweb";private static final String OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/java";public static String scanner(String tip) {Scanner scanner = new Scanner(System.in);System.out.println("请输入" + tip + "：");if (scanner.hasNext()) {String ipt = scanner.next();if (StringUtils.isNotBlank(ipt)) {return ipt;}}throw new MybatisPlusException("请输入正确的" + tip + "！");}public static void main(String[] args) {// 获取需要生成的表名String tables = scanner("表名，多个英文逗号分割");FastAutoGenerator.create(URL, USERNAME, PASSWORD).globalConfig(builder -> {builder.author(AUTHOR).outputDir(OUTPUT_DIR).fileOverride().disableOpenDir().dateType(DateType.ONLY_DATE).commentDate("yyyy-MM-dd");}).packageConfig(builder -> {builder.parent(PARENT_PACKAGE).entity("entity").service("service").serviceImpl("service.impl").mapper("mapper").controller("controller").pathInfo(Collections.singletonMap(OutputFile.xml,System.getProperty("user.dir") + "/src/main/resources/mapper"));}).strategyConfig(builder -> {builder.addInclude(tables.split(",")).entityBuilder().enableLombok().naming(NamingStrategy.underline_to_camel).columnNaming(NamingStrategy.underline_to_camel).logicDeleteColumnName("deleted").versionColumnName("version").addTableFills(new Column("create_time", FieldFill.INSERT),  // 修改为正确的枚举值new Column("update_time", FieldFill.INSERT_UPDATE)  // 修改为正确的枚举值).controllerBuilder().enableRestStyle().formatFileName("%sController").serviceBuilder().formatServiceFileName("%sService").formatServiceImplFileName("%sServiceImpl").mapperBuilder().formatMapperFileName("%sMapper").formatXmlFileName("%sMapper");}).templateEngine(new FreemarkerTemplateEngine()).execute();}
}

MyBatis-Plus 混合使用 XML 和注解配置

一、配置原则

  1. 优先级：XML 配置会覆盖注解配置。
  2. 最佳实践：
    • 简单的 CRUD 操作可以使用注解（如 @Select、@Insert 等）。
    • 复杂的 SQL 查询（如多表关联、动态 SQL）建议使用 XML 配置。
  3. XML 文件位置：默认放在 resources/mapper 目录下，文件名与 Mapper 接口名对应。

二、具体配置方法

1. 基础配置

确保 application.yml 或 application.properties 中正确配置 MyBatis-Plus：

# application.yml
mybatis-plus:# Mapper XML 文件路径mapper-locations: classpath:mapper/*.xml# 实体扫描，多个package用逗号或者分号分隔type-aliases-package: com.neuedu.hisweb.entityconfiguration:# 开启驼峰命名map-underscore-to-camel-case: true
2. 混合使用示例

Mapper 接口：

package com.neuedu.hisweb.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.neuedu.hisweb.entity.User;
import org.apache.ibatis.annotations.*;import java.util.List;public interface UserMapper extends BaseMapper<User> {// 1. 使用注解实现简单查询@Select("SELECT * FROM user WHERE age > #{age}")List<User> selectByAge(int age);// 2. 使用注解实现带参数的插入@Insert("INSERT INTO user(name, age) VALUES(#{name}, #{age})")@Options(useGeneratedKeys = true, keyProperty = "id")int insertUser(User user);// 3. 使用 XML 实现复杂查询（XML 文件中定义该方法）List<User> selectUserWithDepartment();
}

对应的 XML 文件（resources/mapper/UserMapper.xml）：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.neuedu.hisweb.mapper.UserMapper"><!-- 实现 UserMapper 接口中定义的 selectUserWithDepartment 方法 --><select id="selectUserWithDepartment" resultType="com.neuedu.hisweb.entity.User">SELECT u.*, d.name as dept_name FROM user uLEFT JOIN department d ON u.dept_id = d.idWHERE u.deleted = 0</select><!-- 可以添加更多复杂 SQL -->
</mapper>

三、注意事项

  1. 方法名匹配：XML 文件中的 id 必须与 Mapper 接口中的方法名一致。
  2. 参数处理：
    • 注解方式：使用 @Param 注解为参数命名。
    • XML 方式：可以直接使用参数名或索引。
  3. 冲突处理：
    • 如果同一方法在 XML 和注解中都有定义，XML 配置会覆盖注解配置。
  4. XML 文件路径：
    • 确保 mapper-locations 配置正确指向 XML 文件。
    • 推荐使用 classpath:mapper/*.xml 或 classpath*:mapper/**/*.xml。

四、动态 SQL 示例

对于复杂的动态 SQL，XML 方式更加灵活：

<select id="selectUserByCondition" resultType="com.neuedu.hisweb.entity.User">SELECT * FROM user<where><if test="name != null and name != ''">AND name LIKE CONCAT('%', #{name}, '%')</if><if test="age != null">AND age &gt;= #{age}</if><if test="deptId != null">AND dept_id = #{deptId}</if></where>ORDER BY create_time DESC
</select>

五、常见问题

  1. XML 文件未被加载：

    • 检查 mapper-locations 配置是否正确。
    • 确保 XML 文件在 resources 目录下的正确位置。

  2. 方法找不到：

    • 检查 XML 中的 namespace 是否与 Mapper 接口的全限定名一致。
    • 检查方法名（id）是否匹配。

  3. 依赖问题：

    • 确保项目中包含 MyBatis-Plus 和 MyBatis 的依赖： 

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

@MapperScan 与 mapper-locations 的功能的兼容性

  • @MapperScan 负责让 Spring 容器识别 Mapper 接口。
  • mapper-locations 负责让 MyBatis-Plus 加载 XML 中的 SQL 定义。
    只要两者的路径配置与实际文件位置一致，即可同时使用，不会产生冲突。

一、两者的核心功能区别

  1. @MapperScan("com.neuedu.hisweb.mapper") 的作用

    • 扫描 Mapper 接口：告诉 Spring 容器去哪里查找 MyBatis-Plus 的 Mapper 接口（如 PatientcostsMapper），并将这些接口注册为 Spring Bean。
    • 必须配置：如果没有该注解或未通过其他方式扫描 Mapper 接口，Spring 将无法识别这些接口，导致依赖注入失败（如 @Autowired UserMapper 会报错）。

  2. mapper-locations: classpath:mapper/*.xml 的作用

    • 指定 XML 映射文件路径：告诉 MyBatis-Plus 去哪里查找 XML 格式的 SQL 映射文件（如 PatientcostsMapper.xml）。
    • 可选配置：如果 Mapper 接口中所有方法都使用注解（如 @Select）定义 SQL，则无需配置；若存在 XML 定义的 SQL，则必须配置正确路径。

二、为什么需要同时使用？

  • 场景示例：

    • Mapper 接口 PatientcostsMapper 继承自 BaseMapper<Patientcosts>，自动获得 CRUD 方法（无需 XML）。
    • 若该接口中定义了自定义方法（如 selectByCondition），且该方法的 SQL 在 PatientcostsMapper.xml 中实现，则必须通过 mapper-locations 配置 XML 路径，否则 MyBatis-Plus 无法找到对应的 SQL 语句。


  • @MapperScan 解决的是 Mapper 接口的注册问题，mapper-locations 解决的是 XML 映射文件的加载问题，两者功能独立，可同时使用。

三、目录结构建议

为避免混淆，建议按以下规范组织文件：

  1. Mapper 接口位置：

    src/main/java/com/neuedu/hisweb/mapper/PatientcostsMapper.java
     

    （与 @MapperScan("com.neuedu.hisweb.mapper") 扫描路径一致）

  2. XML 映射文件位置：

    src/main/resources/mapper/PatientcostsMapper.xml
     

    （与 mapper-locations: classpath:mapper/*.xml 配置路径一致）

四、可能的冲突场景与解决方案

1. XML 与注解的 SQL 定义冲突
  • 问题：若 Mapper 接口的某个方法同时通过注解（如 @Select）和 XML 定义 SQL，则 XML 配置优先级更高，会覆盖注解中的 SQL。
  • 解决方案：同一方法的 SQL 定义只能选择一种方式（注解或 XML），避免重复定义。
2. Mapper 接口未被扫描
  • 问题：若 @MapperScan 扫描路径错误（如写成 @MapperScan("com.neuedu.hisweb.dao")），则 Spring 无法找到 PatientcostsMapper，导致启动时报错。
  • 解决方案：确保 @MapperScan 的包路径与 Mapper 接口实际路径一致。

五、验证配置是否生效

  1. 启动应用：若控制台无 NoSuchBeanDefinitionException 或 Invalid bound statement 错误，说明配置正确。
  2. 查看日志：
    • 若配置了 mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl，执行 SQL 时会打印 XML 或注解中的 SQL 语句，可验证是否正确加载。

相关文章：

  • 一个教学项目pom.xml杂记
  • DevOps软件开发流程规范
  • 【笔记】NVIDIA AI Workbench 中安装 PyTorch
  • 山东大学软件学院项目实训-基于大模型的模拟面试系统-面试对话标题自动总结
  • 【计算机存储架构】层次化存储架构
  • JAVA-springboot Filter过滤器
  • Amazon Linux 2023 系统上 Radius 部署文档
  • 1Panel 部署 OpenResty + Redis 实现 IP 动态封禁教程
  • gbase8s数据库获取jdbc/odbc协议的几种方式
  • 合同管理登记台账是什么？合同管理登记台账有哪些功能？
  • 基于GA遗传优化的PID控制器最优控制参数整定matlab仿真
  • Matlab解决无法读取路径中的空格
  • 前端实战：用 HTML+JS 打造可拖动图像对比滑块，提升视觉交互体
  • 硬件行业职业规划四篇
  • （功能测试Charles）如何抓取手机http的报文
  • 软件测试之基于博客系统项目的功能测试
  • 解锁Flink CDC：实时数据同步秘籍
  • 速盾：高防CDN可以加速数据库吗？
  • 使用spring-ai-alibaba接入大模型
  • SAP学习笔记 - 开发32 - 前端Fiori开发 Content Density（内容密度）
  • wordpress ux theme/上海有哪些优化网站推广公司
  • ev123建站/百度搜索推广和信息流推广
  • 甘肃省嘉峪关建设局网站/营销方案推广
  • 上海做网站公司哪家好/软件推广怎么赚钱
  • 怎么用h5网站做动效/曲靖seo建站
  • 开发微网站和小程序/seo网站推广排名