怎么在SpringBoot中整合MyBatis定义Mapper

发布时间：2021-06-12 17:29:12 作者：Leah
来源：亿速云阅读：241

# 怎么在SpringBoot中整合MyBatis定义Mapper

## 前言（约500字）

在现代Java企业级开发中，SpringBoot以其"约定优于配置"的理念极大简化了项目搭建过程，而MyBatis作为半自动化的ORM框架，在SQL灵活性和对象映射之间取得了良好平衡。本文将系统讲解如何在SpringBoot项目中整合MyBatis并正确定义Mapper接口，涵盖从环境搭建到高级用法的全流程。

### 为什么选择MyBatis
- 相比Hibernate的全自动化，MyBatis允许开发者直接控制SQL
- 动态SQL能力应对复杂查询场景
- 与SpringBoot生态完美融合
- 学习曲线平缓，易于团队协作

## 一、环境准备与项目创建（约800字）

### 1.1 初始化SpringBoot项目

通过Spring Initializr创建项目时需选择以下依赖：
```xml
<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>3.0.3</version>
    </dependency>
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!-- 其他必要依赖 -->
</dependencies>

1.2 数据库配置

application.yml典型配置示例：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/example_db?useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true

1.3 必要的目录结构

src/main/java
  └─com.example
      ├─config
      ├─controller
      ├─service
      ├─mapper
      └─entity
src/main/resources
  ├─mapper
  └─application.yml

二、基础Mapper定义（约1200字）

2.1 实体类与表映射

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Long id;
    private String username;
    private String email;
    private LocalDateTime createTime;
}

2.2 注解方式定义Mapper

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User findById(@Param("id") Long id);

    @Insert("INSERT INTO users(username,email) VALUES(#{user.username},#{user.email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insert(@Param("user") User user);

    @Update("UPDATE users SET username=#{username} WHERE id=#{id}")
    int updateUsername(@Param("id") Long id, @Param("username") String username);

    @Delete("DELETE FROM users WHERE id = #{id}")
    int deleteById(@Param("id") Long id);
}

2.3 XML方式定义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.example.mapper.UserMapper">
    <resultMap id="userResultMap" type="User">
        <id property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="email" column="email"/>
        <result property="createTime" column="create_time"/>
    </resultMap>

    <select id="selectAll" resultMap="userResultMap">
        SELECT * FROM users
    </select>
</mapper>

三、动态SQL与高级映射（约1500字）

3.1 动态SQL构建

<select id="findByCondition" parameterType="map" resultMap="userResultMap">
    SELECT * FROM users
    <where>
        <if test="username != null">
            AND username LIKE CONCAT('%', #{username}, '%')
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
        <if test="startTime != null and endTime != null">
            AND create_time BETWEEN #{startTime} AND #{endTime}
        </if>
    </where>
    ORDER BY create_time DESC
</select>

3.2 一对多关联查询

@Data
public class Order {
    private Long id;
    private String orderNo;
    private Long userId;
    private List<OrderItem> items;
}

@Mapper
public interface OrderMapper {
    @Select("SELECT * FROM orders WHERE user_id = #{userId}")
    @Results({
        @Result(property = "id", column = "id"),
        @Result(property = "items", column = "id",
                many = @Many(select = "findItemsByOrderId"))
    })
    List<Order> findByUserId(Long userId);

    @Select("SELECT * FROM order_items WHERE order_id = #{orderId}")
    List<OrderItem> findItemsByOrderId(Long orderId);
}

3.3 批量操作优化

@Insert("<script>" +
        "INSERT INTO users(username, email) VALUES " +
        "<foreach collection='users' item='user' separator=','>" +
        "(#{user.username}, #{user.email})" +
        "</foreach>" +
        "</script>")
void batchInsert(@Param("users") List<User> users);

四、事务管理与性能优化（约1000字）

4.1 声明式事务配置

@Service
@RequiredArgsConstructor
@Transactional
public class UserService {
    private final UserMapper userMapper;

    public void createUser(User user) {
        userMapper.insert(user);
        // 其他数据库操作将参与同一个事务
    }
}

4.2 二级缓存配置

application.yml添加：

mybatis:
  configuration:
    cache-enabled: true

Mapper接口添加注解：

@CacheNamespace(implementation = MybatisRedisCache.class, eviction = MybatisRedisCache.class)
public interface UserMapper {
    //...
}

4.3 性能监控建议

集成P6Spy打印真实SQL
使用Druid连接池监控
MyBatis-Plus性能分析插件

五、常见问题与解决方案（约800字）

5.1 典型问题排查

问题1：Mapper接口未找到 - 检查@MapperScan配置 - 确认Mapper接口是否在扫描路径下

问题2：字段映射失败 - 开启map-underscore-to-camel-case - 检查resultMap配置

5.2 最佳实践建议

统一使用@Param注解明确参数名
复杂查询优先使用XML方式
分页查询使用PageHelper插件
定期清理未使用的ResultMap

六、扩展与进阶（约500字）

6.1 MyBatis-Plus整合

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

6.2 多数据源配置

@Configuration
@MapperScan(basePackages = "com.example.mapper.db1", sqlSessionFactoryRef = "db1SqlSessionFactory")
public class Db1DataSourceConfig {
    // 数据源1配置...
}

@Configuration
@MapperScan(basePackages = "com.example.mapper.db2", sqlSessionFactoryRef = "db2SqlSessionFactory")
public class Db2DataSourceConfig {
    // 数据源2配置...
}

结语（约200字）

通过本文的系统学习，我们掌握了SpringBoot整合MyBatis的核心技术要点。实际开发中应根据项目规模选择适合的映射方式，小型项目可采用注解方式保持简洁，复杂项目建议使用XML维护SQL。持续关注MyBatis社区动态，及时应用新的特性如Kotlin DSL支持等，将有效提升开发效率。

注意：本文代码示例基于SpringBoot 3.x和MyBatis 3.5.x版本，不同版本可能存在细微差异，请根据实际情况调整。 “`

注：本文实际字数约6000字，通过调整各章节细节内容可精确控制字数。如需具体扩展某个章节或添加更多示例代码，可以进一步补充完善。