从零开始学Spring Boot系列-集成mybatis

在Spring Boot的应用开发中，MyBatis是一个非常盛行的持久层框架，它支持定制化SQL、存储过程以及高级映射。在本篇文章中，我们将学习如安在Spring Boot项目中集成MyBatis，以便通过MyBatis举行数据库操作。
添加MyBatis依赖

首先，我们必要在项目中添加MyBatis的依赖。在Spring Boot中，我们通常会利用Gradle或Maven作为构建工具来管理项目依赖。这里，我们将以Gradle为例，展示如何添加MyBatis的依赖。
打开项目的build.gradle文件，我们必要添加MyBatis Spring Boot Starter的依赖项。这个依赖项会帮助我们更容易地将MyBatis集成到Spring Boot应用中。

1. plugins {
2. id 'java'
3. id 'org.springframework.boot' version '3.2.3'
4. id 'io.spring.dependency-management' version '1.1.4'
5. }
7. group = 'cn.daimajiangxin'
8. version = '0.0.1-SNAPSHOT'
10. java {
11. sourceCompatibility = '17'
12. targetCompatibility = '17'
13. }
15. repositories {
16.         maven { url 'https://maven.aliyun.com/repository/jcenter' }
17.         maven { url 'https://maven.aliyun.com/repository/google' }
18.         maven { url 'https://maven.aliyun.com/repository/central' }
19.         maven { url 'https://maven.aliyun.com/repository/gradle-plugin' }
20. }
22. dependencies {
23. implementation 'org.springframework.boot:spring-boot-starter-web'
24. compileOnly 'org.projectlombok:lombok'
25. annotationProcessor 'org.projectlombok:lombok'
26. implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
27. runtimeOnly 'mysql:mysql-connector-java:8.0.17'
28. implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:3.0.3'
29. }

复制代码

在上面的build.gradle文件中，我们添加了以下依赖项：

• spring-boot-starter-web：Spring Boot Web Starter，它包含了构建Web应用所需的基本依赖。
  
• mybatis-spring-boot-starter：MyBatis Spring Boot Starter，它提供了MyBatis和Spring Boot集成的简化设置。
  
• mysql-connector-java：MySQL数据库驱动，用于毗连MySQL数据库。
  

设置数据源和MyBatis

设置好依赖后，你可以通过Gradle的命令行工具来同步项目依赖，或者在IDE中自动同步。一旦依赖同步完成，你就可以开始编写Mapper接口和XML映射文件，并利用MyBatis来操作数据库了。
请确保你的application.properties或application.yml文件中已经设置了正确的数据库毗连信息，例如：

1. # datasource 配置
2. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
3. spring.datasource.url=jdbc:mysql://localhost:3306/你的数据库名?useSSL=false&serverTimezone=UTC&useLegacyDatetimeCode=false&allowPublicKeyRetrieval=true
4. spring.datasource.username=你的数据库用户名
5. spring.datasource.password=你的数据库密码
6. spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect
7. spring.jpa.show-sql=true
9. # MyBatis 配置
10. mybatis.mapper-locations=classpath:mapper/*.xml
11. mybatis.type-aliases-package=cn.daimajiangxin.springboot.learning.model

复制代码

创建实体

参考上一篇文章，从零开始学Spring Boot系列-集成MySQL中创建的User类。
创建Mapper接口和XML文件

在项目的src/main/java目次下，创建mapper 的一个package ，再创建Mapper接口。例如，创建一个UserMapper.java接口：

1. package cn.daimajiangxin.springboot.learning.mapper;
3. import cn.daimajiangxin.springboot.learning.model.User;
4. import org.apache.ibatis.annotations.Mapper;
6. import java.util.List;
8. @Mapper
9. public interface UserMapper {
10.     List<User> findAllUsers();
11. }

复制代码

同时，在src/main/resources/mapper/目次下创建对应的XML映射文件，如UserMapper.xml：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE mapper
3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
5. <mapper namespace="cn.daimajiangxin.springboot.learning.mapper.UserMapper">
7.     <resultMap id="BaseResultMap" type="cn.daimajiangxin.springboot.learning.model.User">
8.             <id property="id" column="id" jdbcType="BIGINT"/>
9.             <result property="name" column="name" jdbcType="VARCHAR"/>
10.             <result property="email" column="email" jdbcType="VARCHAR"/>
11.             <result property="age" column="age" jdbcType="INTEGER"/>
12.             <result property="remark" column="remark" jdbcType="VARCHAR"/>
13.     </resultMap>
15.     <sql id="Base_Column_List">
16.         id,name,email,
17.         age,remark
18.     </sql>
19.   
20.     <select id="findAllUsers"  resultMap="BaseResultMap">
21.      select
22.        <include refid="Base_Column_List"></include>
23.      from user
24.     </select>
25. </mapper>

复制代码

利用Mapper

在你的Service类中，可以通过注入Mapper接口来利用MyBatis的功能。例如，在UserService.java中：

1. package cn.daimajiangxin.springboot.learning.service;
3. import cn.daimajiangxin.springboot.learning.mapper.UserMapper;
4. import cn.daimajiangxin.springboot.learning.model.User;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.stereotype.Service;
8. import java.util.List;
10. @Service
11. public class UserService {
12.     private final UserMapper userMapper;
14.     @Autowired
15.     public UserService(UserMapper userMapper) {
16.         this.userMapper = userMapper;
17.     }
19.     public List<User> getAllUsers() {
20.         return userMapper.findAllUsers();
21.     }
23.     // 添加其他业务逻辑方法...
24. }

复制代码

创建Controller

参考上一篇文章，从零开始学Spring Boot系列-集成MySQL中创建的UserController 类。
测试集成效果

运行你的Spring Boot应用程序，并通过调用UserService的findAllUsers方法来测试MyBatis的集成效果。你可以通过编写单元测试或利用Postman或apipost等工具来发送HTTP请求，访问来http://localhost:8080/users检察所有用户的列表。

总结

通过以上步调，我们成功地在Spring Boot项目中集成了MyBatis，并通过编写Mapper接口和XML映射文件，实现了数据库的操作。这只是集成MyBatis的基础示例，你可以进一步探索MyBatis的高级特性，如动态SQL、效果映射等，以满足更复杂的业务需求。同时，联合Spring Boot的其他功能，你可以构建出功能强盛且易于维护的应用程序。
我是代码匠心，和我一起学习更多精彩知识！！！扫描二维码！关注我，实时获取推送。

源文来自：https://daimajiangxin.cn

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。