在 Spring Boot 中使用 MyBatis 通常涉及以下步骤:
1. **添加 MyBatis 依赖**:
在你的 `pom.xml`(如果使用 Maven)或 `build.gradle`(如果使用 Gradle)文件中添加 MyBatis 和数据库相关依赖。
2. **创建 MyBatis 全局配置文件**(可选):
如果你需要全局配置 MyBatis,如设置日志、事务管理器、类型别名等,可以创建一个 `mybatis-config.xml` 文件。这个文件通常放在 `src/main/resources` 目录下。
3. **创建 MyBatis 映射文件**:
映射文件(Mapper 文件)定义了 SQL 语句和结果映射。这些文件也放在 `src/main/resources` 目录下,通常放在一个特定的包路径下,如 `resources/mapper`。
4. **配置 application.yml 或 application.properties**:
在 Spring Boot 的配置文件中,你可以指定 MyBatis 全局配置文件的位置和映射文件的位置。例如,在 `application.yml` 中配置如下:
```yaml
mybatis:
mapper-locations: classpath:mapper/*.xml # 映射文件位置
configuration:
map-underscore-to-camel-case: true # 开启下划线到驼峰命名法的转换
```
5. **创建 Mapper 接口**:
在 Java 代码中,创建 Mapper 接口,并使用 MyBatis 注解或 XML 来定义 SQL 映射。Spring Boot 会自动扫描这些接口并将它们注册为 Bean。
6. **创建 Service 层**:
Service 层包含业务逻辑,并调用 Mapper 接口中定义的方法。
7. **创建 Controller 层**:
Controller 层处理 HTTP 请求,调用 Service 层的方法,并返回响应。
8. **调用流程**:
当一个 HTTP 请求到达时,Controller 层处理请求并调用 Service 层的方法。Service 层再调用 Mapper 接口的方法,Mapper 接口通过 MyBatis 执行 SQL 语句并与数据库交互。
这是一个典型的 Spring Boot + MyBatis 的使用流程。Spring Boot 的自动配置特性简化了 MyBatis 的配置过程,使得开发者可以快速开始开发数据库交互功能。在 Spring Boot 中,你不需要显式地配置数据源和 SQL 会话,因为 Spring Boot 会自动配置一个适合大多数应用的数据源和事务管理器。此外,通过 MyBatis 的自动映射特性,你可以轻松地将数据库查询结果映射到 Java 对象上。
例子:
让我们通过一个具体的例子来展示如何在 Spring Boot 应用中使用 MyBatis。这个例子将包括创建一个全局配置文件、一个 Mapper 文件、一个 Service 类、一个 Controller 类,以及相应的配置。
### 1. MyBatis 全局配置文件 (`mybatis-config.xml`)
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 开启下划线到驼峰命名法的自动转换 -->
<settings>
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings> <!-- 配置 Mapper 文件的位置 -->
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
```这个全局配置文件指定了 MyBatis 的一些全局设置,例如开启下划线到驼峰命名法的自动转换,并指明了 Mapper 文件的位置。
### 2. MyBatis 映射文件 (`UserMapper.xml`)
```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="BaseResultMap" type="com.example.entity.User">
<id column="id" property="id"/>
<result column="username" property="username"/>
<result column="email" property="email"/>
</resultMap> <!-- 查询用户 -->
<select id="findUserById" resultMap="BaseResultMap">
SELECT * FROM users WHERE id = #{id}
</select> <!-- 插入用户 -->
<insert id="insertUser" parameterType="com.example.entity.User">
INSERT INTO users (username, email) VALUES (#{username}, #{email})
</insert> <!-- 更新用户 -->
<update id="updateUser" parameterType="com.example.entity.User">
UPDATE users SET username = #{username}, email = #{email} WHERE id = #{id}
</update> <!-- 删除用户 -->
<delete id="deleteUser" parameterType="java.lang.Integer">
DELETE FROM users WHERE id = #{id}
</delete></mapper>
```映射文件定义了与数据库交互的 SQL 语句,包括查询、插入、更新和删除操作。`namespace` 属性指定了对应的 Mapper 接口的完全限定名。
### 3. Service 类 (`UserService.java`)
```java
package com.example.service;import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class UserService { private final UserMapper userMapper;
@Autowired
public UserService(UserMapper userMapper) {
this.userMapper = userMapper;
} public User findUserById(Integer id) {
return userMapper.findUserById(id);
} // 其他业务方法...
}
```Service 类包含业务逻辑,并调用 Mapper 接口的方法。这里我们注入了 `UserMapper` 并提供了一个方法来根据用户 ID 查询用户。
### 4. Controller 类 (`UserController.java`)
```java
package com.example.controller;import com.example.entity.User;
import com.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;@RestController
@RequestMapping("/users")
public class UserController { private final UserService userService;
@Autowired
public UserController(UserService userService) {
this.userService = userService;
} @GetMapping("/{id}")
public User getUserById(@PathVariable Integer id) {
return userService.findUserById(id);
} // 其他控制器方法...
}
```Controller 类处理 HTTP 请求,并调用 Service 类的方法。这里我们定义了一个 GET 请求的处理器方法,它接受一个用户 ID 并返回对应的用户信息。
### 5. Spring Boot 配置 (`application.yml`)
```yaml
mybatis:
mapper-locations: classpath:mapper/*.xml # 指定 Mapper 文件的位置
configuration:
map-underscore-to-camel-case: true # 开启下划线到驼峰命名法的转换
```在 `application.yml` 配置文件中,我们指定了 Mapper 文件的位置,并设置了一些 MyBatis 配置选项。
### 6. 实体类 (`User.java`)
```java
package com.example.entity;import javax.persistence.*;
@Entity
@Table(name = "users")
public class User { @Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
private String username;
private String email; // 省略 getter 和 setter 方法...
}
```
实体类 `User` 映射了数据库中的 `users` 表。
通过这些组件,Spring Boot 应用可以利用 MyBatis 进行数据库操作。Controller 接收 HTTP 请求,Service 层调用 Mapper 接口的方法,Mapper 接口通过 SQL 映射文件与数据库交互。这种分层架构使得代码更加清晰,易于维护。