14、《SpringBoot+MyBatis集成(2)——进阶配置XML与注解的灵活运用》


SpringBoot+MyBatis集成进阶配置 - XML与注解的灵活运用


前言

在Spring Boot与MyBatis的集成开发中,开发者常面临XML映射文件注解 两种SQL定义方式的选择,以及复杂场景下的动态SQL、多数据源等进阶需求。本文将从核心配置的灵活性出发,对比XML与注解的适用场景,详解动态SQL的实现技巧,并结合ResultMaptypeAliases等高级特性,最终通过多数据源配置实战演示企业级解决方案。无论你是希望优化现有项目,还是应对复杂业务逻辑,本文均能提供清晰的实践路径。


一、XML与注解:如何选择?
1. 注解的简洁与局限

通过@Select@Insert等注解直接在Mapper接口中编写SQL,适合简单、静态的SQL场景,例如:

java 复制代码
@Select("SELECT * FROM user WHERE id = #{id}")
User findById(Long id);

优点

  • 代码简洁,无需维护XML文件。
  • 适合快速开发小型项目。

缺点**:

  • 复杂SQL可读性差(如动态条件、关联查询)。
  • 无法直接使用MyBatis的动态SQL标签。

2. XML的动态与强大

XML映射文件通过<if><foreach>等标签支持动态SQL,适合复杂查询和批量操作:

xml 复制代码
<select id="findUsers" resultType="User">
  SELECT * FROM user
  <where>
    <if test="name != null">AND name = #{name}</if>
    <if test="status != null">AND status = #{status}</if>
  </where>
</select>

优点

  • 动态SQL灵活,易于维护复杂逻辑。
  • 支持结果集映射(ResultMap)和关联查询。

缺点

  • 需额外维护XML文件,项目结构稍显复杂。

结论简单查询用注解,复杂逻辑用XML,二者可混合使用!


二、动态SQL实战:提升代码灵活性
1. 条件分支与循环
  • <if>标签:根据参数动态拼接条件。
  • <foreach>标签:实现批量插入或IN查询:
xml 复制代码
<insert id="batchInsert">
  INSERT INTO user (name, email) VALUES
  <foreach item="user" collection="list" separator=",">
    (#{user.name}, #{user.email})
  </foreach>
</insert>
2. 多表关联查询与ResultMap

通过ResultMap定义嵌套结果集,解决一对多关联查询:

xml 复制代码
<resultMap id="OrderWithItems" type="Order">
  <id property="id" column="order_id"/>
  <collection property="items" ofType="OrderItem">
    <id property="id" column="item_id"/>
    <result property="product" column="product_name"/>
  </collection>
</resultMap>

三、核心配置优化:typeAliases与mapperLocations
1. 简化实体类引用

application.yml中配置type-aliases-package,避免XML中写全类名:

yaml 复制代码
mybatis:
  type-aliases-package: com.example.entity
  mapper-locations: classpath:mapper/*.xml
2. 自动扫描Mapper接口

通过@MapperScan注解指定Mapper接口路径,避免逐个添加@Mapper

java 复制代码
@SpringBootApplication
@MapperScan("com.example.mapper")
public class Application { ... }

四、多数据源配置实战
场景需求

同时连接主库(写操作)从库(读操作),需独立配置数据源与MyBatis会话。

1. 主数据源配置
java 复制代码
@Configuration
@MapperScan(basePackages = "com.example.mapper.primary", sqlSessionFactoryRef = "primarySqlSessionFactory")
public class PrimaryDataSourceConfig {

    @Bean(name = "primaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "primarySqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("primaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/primary/*.xml"));
        return bean.getObject();
    }
}
2. 从数据源配置
java 复制代码
@Configuration
@MapperScan(basePackages = "com.example.mapper.secondary", sqlSessionFactoryRef = "secondarySqlSessionFactory")
public class SecondaryDataSourceConfig {

    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "secondarySqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("secondaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/secondary/*.xml"));
        return bean.getObject();
    }
}
3. 配置文件(application.yml)
yaml 复制代码
spring:
  datasource:
    primary:
      url: jdbc:mysql://localhost:3306/primary_db
      username: root
      password: 123456
      driver-class-name: com.mysql.cj.jdbc.Driver
    secondary:
      url: jdbc:mysql://localhost:3306/secondary_db
      username: root
      password: 123456
      driver-class-name: com.mysql.cj.jdbc.Driver

五、总结与最佳实践
  1. XML与注解混合使用:简单CRUD用注解,动态SQL和关联查询用XML。
  2. 动态SQL提升灵活性 :善用<if><foreach>处理复杂业务逻辑。
  3. 配置优化技巧type-aliases-package简化代码,mapperLocations规范路径。
  4. 多数据源方案 :通过独立配置DataSourceSqlSessionFactory实现读写分离。

避坑指南

  • 多数据源场景下,需明确指定@MapperScansqlSessionFactoryRef属性。
  • 避免在多数据源中重复扫描同一Mapper接口路径。

欢迎在评论区留言讨论你在MyBatis配置中遇到的难题!

相关推荐
cg50178 小时前
Spring Boot 的配置文件
java·linux·spring boot
程序猿熊跃晖8 小时前
解决 MyBatis-Plus 中 `update.setProcInsId(null)` 不生效的问题
数据库·tomcat·mybatis
Hars、Wlgb9 小时前
mybatis 自带的几个插入接口的区别
mybatis
橘猫云计算机设计11 小时前
基于springboot的考研成绩查询系统(源码+lw+部署文档+讲解),源码可白嫖!
java·spring boot·后端·python·考研·django·毕业设计
有一只柴犬11 小时前
深入Spring AI:6大核心概念带你入门AI开发
spring boot·后端
向阳25611 小时前
SpringBoot+vue前后端分离整合sa-token(无cookie登录态 & 详细的登录流程)
java·vue.js·spring boot·后端·sa-token·springboot·登录流程
XiaoLeisj12 小时前
【MyBatis】深入解析 MyBatis XML 开发:增删改查操作和方法命名规范、@Param 重命名参数、XML 返回自增主键方法
xml·java·数据库·spring boot·sql·intellij-idea·mybatis
风象南12 小时前
SpringBoot实现数据库读写分离的3种方案
java·spring boot·后端
CryptoPP12 小时前
springboot 对接马来西亚数据源API等多个国家的数据源
spring boot·后端·python·金融·区块链
清风絮柳13 小时前
52.个人健康管理系统小程序(基于springboot&vue)
vue.js·spring boot·毕业设计·前后端分离·健康管理系统·个人健康管理系统·个人健康管理小程序