從零搭建Spring Boot腳手架(3):整合mybatis
1. 前言
今天繼續搭建我們的kono Spring Boot腳手架,上一文集成了一些基礎的功能,比如統一返回體、統一異常處理、快速型別轉換、引數校驗等常用必備功能,並編寫了一些單元測試進行驗證,今天把國內最流行的ORM框架Mybatis也整合進去。使用的Spring Boot版本為2.3.2.RELEASE。
Gitee: https://gitee.com/felord/kono 1.0.0.MYBATIS 分支
GitHub: https://github.com/NotFound403/kono 1.0.0.MYBATIS 分支
2. 整合Mybatis的步驟
整合Mybatis的步驟並不是特別複雜,我將它們分為三個步驟,接下來進入正題。
3. 依賴整合
首先我將Mybatis的Starter加入kono-dependencies進行依賴管理,並在kono-app引入:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
通過IDEA的Maven外掛可以看出我們引入了Mybatis的Starter之後,高效能的資料來源連線池就被集成了進來。但是資料庫驅動需要我們自行引入,這裡我們直接引用MySQL
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
4. 配置
配置是最重要的部分,我們來分層次講解配置。
4.1 先配置資料來源
資料來源在application.yml
中的配置字首為spring.datasource
。那麼基本的配置如下:
spring: datasource: # 連線池實現的限定名,這裡使用hikari連線池。一般不用配置這個,會自動去類路徑下載入,這是一個可選的配置。 # type: com.zaxxer.hikari.HikariDataSource # 資料庫的驅動JDBC驅動程式的類全限定名,它其實會根據下面的url配置自動檢測,這是一個可選配置。 # driver-class-name: com.mysql.cj.jdbc.Driver # 資料庫的JDBC連結 url: jdbc:mysql://ip:port/database # 資料庫使用者名稱 username: # 資料庫密碼 password:
hikari連線池的配置可以根據需要自行通過spring.datasource.hikari
進行配置,這裡先採用預設,後續如果有需要再進行修改。
com.mysql.jdbc.Driver
已經標記為過時,現在請使用com.mysql.cj.jdbc.Driver
。
4.2 mybatis配置
mybatis的基本配置也不是特別多,你只需要讓Mybatis知道從哪裡載入你定義的Mapper
介面,從哪裡載入對應的*Mapper.xml
檔案,然後配置一些mybatis的特性,複雜的騷操作可以從我以往mybatis相關的文章去看一下。
我新建了一張表user_info
,並建立了對應的實體類UserInfo
,接著就是定義Mapper介面的位置。假如說我把所有的Mapper介面放在cn.felord.kono.mapper
包下,那麼就應該使用@MapperScan
來標識這個路徑,引導mybatis找到這些Mapper介面。
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;
/**
* mybatis configuration.
*
* @author felord.cn
*/
@MapperScan("cn.felord.kono.mapper")
@Configuration
public class MybatisConfiguration {
}
接著我們編寫UserInfo
對應的UserInfoMapper
介面,並增加一個新增方法。這裡可以根據IDE去外掛市場下載一些mybatis外掛來方便我們開發,關鍵字搜尋mybatis即可,這裡我隨便找了一個外掛安裝。通過IDEA的ALT+ENTER快捷鍵調出了一個生成UserInfoMapper
對應XML的選單,我們可以使用它來生成XML檔案以及對應方法的語句。
XML檔案的位置我們放在resources下的mapper資料夾中,編譯後就是類路徑下的mapper資料夾中,所以需要在application.yml
進行如下配置。
mybatis:
mapper-locations: classpath:mapper/*Mapper.xml
對應的UserInfoMapper.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="cn.felord.kono.mapper.UserInfoMapper">
<insert id="save" parameterType="cn.felord.kono.entity.UserInfo">
insert into user_info (name, age)
VALUES (#{name}, #{age})
</insert>
</mapper>
然後測試一下新增成功了沒有問題,但是查詢的單元測試卻沒有通過:
@Test
void testUserInfoMapperFindById(){
UserInfo userInfo = userInfoMapper.findById(3);
System.out.println("userInfo = " + userInfo);
Assertions.assertEquals(3,userInfo.getUserId());
}
這是因為駝峰轉下劃線的問題造成了,user_id
無法注入到userId
中,所以要宣告以下配置來支援下劃線轉駝峰就可以了:
mybatis:
configuration:
map-underscore-to-camel-case: true
如何列印SQL語句呢?只需要宣告Mapper介面包的日誌級別為DEBUG
就可以了。
logging:
level:
cn.felord.kono.mapper: debug
5. 總結
到這裡基本的mybatis整合就完成了,你可以從專案倉庫拉下來,自己配置一個數據庫跑一下。多多關注:碼農小胖哥 繼續來和我一起整合腳手架。
關注公眾號:Felordcn 獲取更多資訊