Spring Boot与MyBatis的整合指南

2024 年 02 月 12 日

99 次浏览

2991字数

Spring Boot与MyBatis的整合是Java开发中常见的一种实践，它将Spring Boot的简便、快捷与MyBatis的强大持久层框架优势结合起来，为开发人员提供了一种高效、灵活的数据访问方案。本指南旨在提供一个清晰、易于理解的步骤，帮助你实现Spring Boot与MyBatis的顺利整合。

准备工作

在开始整合之前，确保你的开发环境已经安装了Java和Maven。Spring Boot与MyBatis的整合主要依赖于Maven来管理项目依赖。

创建Spring Boot项目

首先，使用Spring Initializr（https://start.spring.io/）创建一个新的Spring Boot项目。在依赖选择中，至少需要包括 Spring Web和 MyBatis Framework。这将自动生成项目框架，并包含必要的依赖。

添加MyBatis依赖

在 pom.xml文件中，确保已经添加了MyBatis的依赖项。如果未自动添加，你可以手动加入以下依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>

确保版本号与你的Spring Boot版本兼容。

配置数据源

在 src/main/resources/application.properties文件中，配置你的数据库连接。例如，如果你使用的是MySQL数据库，配置可能如下所示：

spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

配置MyBatis

在同一配置文件中，添加MyBatis的配置项，指定mapper文件的位置和别名包：

mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.type-aliases-package=your.package.model

这告诉MyBatis你的mapper XML文件存放的路径以及实体类别名所在的包。

编写Mapper接口和XML文件

Mapper接口是MyBatis中用于定义数据库操作的方法。创建一个接口，并使用 @Mapper注解标记，如下所示：

@Mapper
public interface UserMapper {
    User selectUserById(int id);
}

接下来，创建一个XML文件（例如 UserMapper.xml），在 src/main/resources/mapper/目录下，定义上述接口方法的SQL语句：

<mapper namespace="your.package.mapper.UserMapper">
    <select id="selectUserById" resultType="your.package.model.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

集成到Spring Boot中

在Spring Boot的主类或配置类中，使用 @MapperScan注解扫描Mapper接口所在的包：

@SpringBootApplication
@MapperScan("your.package.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

测试

编写一个简单的Controller或Service来调用Mapper接口，验证整合是否成功。

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/user/{id}")
    public User getUserById(@PathVariable int id) {
        return userMapper.selectUserById(id);
    }
}

通过访问对应的URL，你应该能够查询到数据库中的数据。