整合 MyBatis 到 Spring 或 Spring Boot 项目中，可以极大地简化开发流程，尤其是当使用 Spring Boot 时，它提供了自动配置功能，使得集成更加简便。
在 Spring Boot 中整合 MyBatis
1. 添加依赖
首先，在 pom.xml 文件中添加必要的依赖项。对于 Spring Boot 项目，你可以使用 spring-boot-starter-mybatis：
<dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.2.0</version> <!-- 请根据需要调整版本 -->
</dependency><!-- 数据库驱动 -->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope>
</dependency>
2. 配置数据源
在 application.yml 或 application.properties 文件中配置数据库连接信息：
spring:datasource:url: jdbc:mysql://localhost:3306/mydb?useSSL=false&serverTimezone=UTCusername: rootpassword: passworddriver-class-name: com.mysql.cj.jdbc.Drivermybatis:mapper-locations: classpath:mapper/*.xml # XML 映射文件的位置type-aliases-package: com.example.demo.model # 实体类所在的包
3. 创建实体类和 Mapper 接口
假设我们有一个用户表 users，我们需要创建对应的实体类和 Mapper 接口。
User.java
package com.example.demo.model;public class User {private Long id;private String name;private Integer age;// Getters and Setters...
}
UserMapper.java
package com.example.demo.mapper;import com.example.demo.model.User;
import org.apache.ibatis.annotations.*;@Mapper // 标记这是一个 MyBatis 的 Mapper 接口
public interface UserMapper {@Select("SELECT * FROM users WHERE id = #{id}")User findById(@Param("id") Long id);@Insert("INSERT INTO users(name, age) VALUES(#{name}, #{age})")void insert(User user);
}
4. 使用 Mapper
在服务层或控制器中注入并使用 UserMapper：
UserService.java
package com.example.demo.service;import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class UserService {@Autowiredprivate UserMapper userMapper;public User getUserById(Long id) {return userMapper.findById(id);}public void createUser(User user) {userMapper.insert(user);}
}
5. 运行应用程序
确保你的数据库已经准备好，并且与配置中的数据库名称、用户名和密码相匹配。然后运行 Spring Boot 应用程序，尝试调用服务方法来验证是否能够正常工作。
在传统 Spring 项目中整合 MyBatis
如果你正在使用传统的 Spring 项目而非 Spring Boot，则需要手动进行更多的配置。
1. 添加依赖
在 pom.xml 文件中添加 MyBatis 和 Spring 的相关依赖：
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.7</version>
</dependency>
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis-spring</artifactId><version>2.0.6</version>
</dependency>
2. 配置 SqlSessionFactoryBean
在 Spring 配置文件中配置 SqlSessionFactoryBean：
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations" value="classpath:mapper/*.xml"/>
</bean><bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"><property name="mapperInterface" value="com.example.mapper.UserMapper"/><property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
3. 编写 Mapper XML 文件
在 src/main/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.example.mapper.UserMapper"><select id="findById" parameterType="long" resultType="com.example.model.User">SELECT * FROM users WHERE id = #{id}</select><insert id="insert" parameterType="com.example.model.User">INSERT INTO users(name, age) VALUES(#{name}, #{age})</insert>
</mapper>
4. 注入并使用 Mapper
在服务层或其他地方通过 Spring 注解或 XML 配置注入并使用 Mapper。
无论是 Spring Boot 还是传统的 Spring 项目，MyBatis 提供了灵活的接口和配置选项来满足不同的需求。Spring Boot 由于其自动配置特性，通常会使集成过程更为简洁快速。希望这些示例能帮助你更好地理解和实施 MyBatis 与 Spring/Spring Boot 的整合。
MyBatis-Plus 简介
MyBatis-Plus 是 MyBatis 的增强工具，旨在简化开发、提高效率的同时不损失灵活性。它在 MyBatis 的基础上只做增强而不做改变，为简化开发工作、提高效率而生。下面将详细介绍 MyBatis-Plus 的核心功能、使用方法以及与 Spring Boot 的整合。
核心特性
- 无侵入：引入 MyBatis-Plus 不会对现有的 MyBatis 结构造成任何影响。
- 低损耗：启动即会自动注入基本 CURD，性能几乎无损耗，直接面向对象操作。
- 通用 CRUD：内置通用 Mapper、通用 Service，仅需简单配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。
- 多种主键策略：支持多达 7 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题。
- 支持 Lambda 形式调用：通过 Lambda 表达式，方便地编写查询条件，无需担心字段名写错。
- 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作。
- 代码生成器：支持根据数据库表结构自动生成实体类、Mapper、Service、Controller 等相关代码，减少重复劳动。
- 自定义全局通用操作：支持通用接口注入，可以在不修改原有代码的情况下扩展功能。
快速入门
1. 添加依赖
在 pom.xml 文件中添加 MyBatis-Plus 的依赖：
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.4.2</version> <!-- 请根据需要调整版本 -->
</dependency>
2. 配置数据源
在 application.yml 中配置数据源信息：
spring:datasource:url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghaiusername: rootpassword: your_passworddriver-class-name: com.mysql.cj.jdbc.Drivermybatis-plus:mapper-locations: classpath:/mapper/*.xmltype-aliases-package: com.your.package.model
3. 创建实体类和 Mapper 接口
假设有一个用户表 users，我们可以创建对应的实体类和继承了 BaseMapper 的 Mapper 接口。
User.java
package com.example.model;import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;@TableName("users")
public class User {@TableIdprivate Long id;private String name;private Integer age;// Getters and Setters...
}
UserMapper.java
package com.example.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.model.User;
import org.apache.ibatis.annotations.Mapper;@Mapper
public interface UserMapper extends BaseMapper<User> {// 继承 BaseMapper 后已经包含了基本的 CRUD 方法，无需额外定义
}
4. 使用 Mapper
在服务层或控制器中注入并使用 UserMapper：
UserService.java
package com.example.service;import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.mapper.UserMapper;
import com.example.model.User;
import org.springframework.stereotype.Service;@Service
public class UserService extends ServiceImpl<UserMapper, User> {// 直接继承 ServiceImpl 即可获得基础的 CRUD 能力
}
5. 测试
可以通过编写测试用例来验证是否能够正常进行数据库操作：
@Autowired
private UserService userService;@Test
void testCRUD() {// 新增User user = new User();user.setName("John");user.setAge(25);userService.save(user);// 查询User retrievedUser = userService.getById(user.getId());System.out.println(retrievedUser.getName());// 更新retrievedUser.setAge(26);userService.updateById(retrievedUser);// 删除userService.removeById(user.getId());
}
高级功能
条件构造器（Wrapper）
MyBatis-Plus 提供了强大的条件构造器 QueryWrapper 和 UpdateWrapper，可以用来构建复杂的查询和更新条件。
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "John").gt("age", 20);
List<User> userList = userService.list(queryWrapper);
分页插件
MyBatis-Plus 内置了分页插件，使用起来非常方便。
Page<User> page = new Page<>(currentPage, pageSize);
IPage<User> userPage = userService.page(page, queryWrapper);
System.out.println("总记录数：" + userPage.getTotal());
System.out.println("当前页数据：" + userPage.getRecords());
自动填充功能
对于创建时间、更新时间等字段，可以使用自动填充功能来避免手动设置。
首先，在实体类中使用注解指定填充策略：
@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;
然后，创建一个处理器类实现 MetaObjectHandler 接口，并重写相应的方法：
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());}@Overridepublic void updateFill(MetaObject metaObject) {this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());}
}
