Spring boot學習（三） Spring boot整合mybatis

諾丨言發表於2019-01-17

前言

前面我們介紹瞭如何建立一個Spring boot專案以及Spring boot專案的一些基本配置，在瞭解了這些知識的前提下本篇部落格繼續介紹在Spring boot中配置一個基於java的持久層框架---Mybatis。

文章首發於個人部落格:【www.xiongfrblog.cn】

為什麼使用Mybatis

在實際的開發過程中是離不開資料庫的，這裡指的是關係型資料庫，例如MySql，Oracle,SqlServer等。大家應該都清楚如果不使用任何框架的情況下，我們專案要想連線資料庫大致分為以下步驟：

載入驅動（使用不同的資料庫載入不同的驅動）
獲取連線
編寫sql
建立statement
執行sql語句並處理結果
從下而上依次關閉連線

實際的開發過程中，我們對資料庫的操作是很頻繁的，如果都按照上邊的方式去連線資料庫的話，將會給我們帶來很糟糕的體驗，所以Mybatis應運而生，Mybatis內部封裝了jdbc，使我們開發者只需要考慮sql語句的編寫，其餘的都幫我們搞定，極大的減輕了開發人員的工作量，而且還提供了動態sql等強大功能，能應對實際專案中的各種需求，這也是它受到大家青睞的原因。

在Spring boot中配置Mybatis

新增依賴

在整合Mybatis之前先準備一個乾淨的Spring boot專案,然後在pom.xml檔案中新增mybatis-spring-boot-starter依賴，因為需要關聯到資料庫，所以還必須新增一個資料庫的依賴，這裡我使用的是Mysql資料庫，所以需要在pom.xml檔案中新增以下兩個依賴：

<!-- 整合mysql -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- 整合mybatis -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>
複製程式碼

不同的Spring boot版本對應的Mybatis也不一樣，詳細情況可查閱官方文件【傳送門】。

看到網上很多教程都新增了jdbc的依賴，其實這裡是不需要的，因為mybatis-spring-boot-starter已經包含了spring-boot-starter-jdbc依賴，檢視專案中隱形依賴的方法為（使用eclipse）：右鍵專案-->Run As-->Maven build...在彈出框的Goals欄中輸入dependency:tree,點選Run，在控制檯就會列印出專案的所有依賴及關係，如圖：

圖示內容可以證明我上面的言論。

配置資料來源

在application.properties配置檔案中新增如下內容:

#mybatis配置
#配置實體類的位置
mybatis.type-aliases-package=com.web.springbootmybatis.entity
#xml檔案位置
mybatis.mapper-locations=classpath:mapper/*.xml
#mysql資料庫連線資訊配置
#mysql驅動
spring.datasource.driverClassName=com.mysql.jdbc.Driver
#資料庫連線資訊
spring.datasource.url=jdbc:mysql://localhost:3306/eran?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
#資料庫使用者名稱
spring.datasource.username=root
#資料庫密碼
spring.datasource.password=root
複製程式碼

配置的屬性值根據自己的實際情況填寫，這裡是我的配置，特別要注意實體類的位置以及xml檔案的位置。

構建MVC專案結構

建立出對應的包即可，這裡我們就建立了幾個需要的包就可以了，專案結構如下圖：

資料庫sql

CREATE TABLE `sys_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `usercode` varchar(32) NOT NULL COMMENT '賬號',
  `username` varchar(64) NOT NULL COMMENT '姓名',
  `password` varchar(32) NOT NULL COMMENT '密碼',
  `salt` varchar(64) DEFAULT NULL COMMENT '鹽',
  `locked` char(1) DEFAULT NULL COMMENT '賬號是否鎖定，1：鎖定，0未鎖定',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

INSERT INTO `sys_user` VALUES ('1', 'Promise', 'eran', '123456', null, '0');
複製程式碼

SysUser.java

實體類

package com.web.springbootmybatis.entity;

import java.io.Serializable;

import com.fasterxml.jackson.annotation.JsonProperty;
 
public class SysUser implements Serializable{

	private static final long serialVersionUID = 1L;

	//主鍵 : id 	
	private Long id; 
	
	//賬號 : usercode 	
	private String usercode; 
	
	//姓名 : username 	
	private String username; 
	
	//密碼 : password 	
	private String password; 
	
	//鹽 : salt 	
	private String salt; 
	
	//賬號是否鎖定，1：鎖定，0未鎖定 : locked 	
	private String locked; 
	
	//省略getter,setter方法
}

複製程式碼

SysUserMapper.java

dao層介面

package com.web.springbootmybatis.dao;

/**
 * SysUserMapper
 */
import java.util.List;
import java.util.Map;

import  com.web.springbootmybatis.entity.SysUser;
 
public interface SysUserMapper{

	public SysUser findById(Long id);
}
複製程式碼

SysUserMapper.xml

由於我使用的是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.web.springbootmybatis.dao.SysUserMapper">
	    <resultMap id="sysUser" type="com.web.springbootmybatis.entity.SysUser">
                  <result column="id" property="id" />
 		          <result column="usercode" property="usercode" />
 		          <result column="username" property="username" />
 		          <result column="password" property="password" />
 		          <result column="salt" property="salt" />
 		          <result column="locked" property="locked" />
 		</resultMap>
	<select id="findById" parameterType="java.lang.Long" resultMap="sysUser">
		SELECT 
			id ,			
			usercode,			
			username,			
			password,			
			salt,			
			locked			
		FROM sys_user
		WHERE
			id=#{id} 	
	</select>
</mapper>
複製程式碼

ISysUserService.java

service介面

package com.web.springbootmybatis.service;
/**
* @author Promise
* @createTime 2018年12月27日 下午11:11:00
* @description 
*/

import com.web.springbootmybatis.entity.SysUser;

public interface ISysUserService {
	SysUser findById(Long id);
}
複製程式碼

SysUserServiceImpl.java

service介面實現

package com.web.springbootmybatis.service.impl;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.web.springbootmybatis.dao.SysUserMapper;
import com.web.springbootmybatis.entity.SysUser;
import com.web.springbootmybatis.service.ISysUserService;

/**
* @author Promise
* @createTime 2018年12月27日 下午11:11:48
* @description 
*/
@Service("sysUserService")
public class SysUserServiceImpl implements ISysUserService{

	@Autowired
	private SysUserMapper sysUserMapper;
	
	@Override
	public SysUser findById(Long id) {
		// TODO Auto-generated method stub
		return sysUserMapper.findById(id);
	}
}

複製程式碼

TestController.java

控制器

package com.web.springbootmybatis.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.web.springbootmybatis.entity.SysUser;
import com.web.springbootmybatis.service.ISysUserService;

/**
* @author Promise
* @createTime 2018年12月27日 下午11:13:22
* @description 
*/
@RestController
public class TestController {

	@Autowired
	private ISysUserService sysUserService;
	
	@RequestMapping("/user")
	public SysUser getUser() {
		return sysUserService.findById(1L);
	}
}
複製程式碼

新增註解掃描dao層

在啟動類中新增註解@MapperScan()註解配置掃描dao層位置,裡邊的值根據實際情況填寫。

package com.web.springbootmybatis;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.web.springbootmybatis.dao")
public class SpringbootMybatisApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootMybatisApplication.class, args);
	}

}
複製程式碼

此時專案的結構為：

啟動專案

啟動專案，訪問localhost:8080/user或者127.0.0.1:8080/user，得到如下資訊：

拿到了資料庫中存放的使用者資訊，至此Spring boot簡單整合Mybatis就成功了，這裡我們使用的是預設的tomcat-jdbc資料來源，在實際開發過程中我們一般使用alibaba提供的功能更強大的druid資料來源，後邊的部落格會詳細介紹，這裡就不概述了。

列印sql

細心的小夥伴會發現按照上邊的配置，我們訪問了資料庫，但是控制檯並沒有列印出我們具體的sql語句，這在實際開過程中是非常不友好的，看不到sql語句非常不利於我們快速的定位bug,所以下面介紹以下在Spring boot中開啟sql日誌的功能，很簡單，只需要在配置檔案中新增一句配置即可：

logging.level.com.web.springbootmybatis.dao=debug
複製程式碼

logging.level後面的路徑指的是mybatis對應的方法介面所在的包(也就是dao層所在的包)，並不是mapper.xml所在的包。

重啟專案，再次訪問，觀察控制檯是不是已經列印出了sql語句了呢：

結語

關於Spring boot整合Mybatis的介紹就到這裡了，下面的部落格中會繼續介紹Mybatis的自動化外掛以及分頁外掛，使用druid資料來源等,bye~

Spring boot學習（五）Spring boot整合Mybatis Generator以及PageHelper
2019-01-20
Spring BootMyBatis
Spring Boot系列（三）：Spring Boot整合Mybatis原始碼解析
2020-08-20
Spring BootMyBatis原始碼
Spring Boot 整合 MyBatis
2022-05-13
Spring BootMyBatis
spring boot 整合mybatis
2017-12-14
Spring BootMyBatis
Spring boot學習（四）Spring boot整合Druid
2019-01-17
Spring BootUI
Spring boot 六整合 MyBatis
2017-11-07
Spring BootMyBatis
小代學Spring Boot之整合MyBatis
2019-07-19
Spring BootMyBatis
Spring Boot 整合 Mybatis 和 MySQL
2017-06-01
Spring BootMyBatisMySql
Spring Boot：Spring Boot配置Mybatis
2021-09-09
Spring BootMyBatis
spring boot（三）整合 redis
2021-11-23
Spring BootRedis
Spring Boot 學習筆記(3)：MyBatis
2018-09-27
Spring Boot筆記MyBatis
【Spring Boot】快速整合Mybatis-Plus
2023-02-07
Spring BootMyBatis
Spring Boot學習6：Spring Boot JDBC
2018-02-13
Spring BootJDBC
從零開始學Spring Boot系列-整合mybatis
2024-03-10
Spring BootMyBatis
Spring boot入門（二）：Spring boot整合MySql,Mybatis和PageHelper外掛
2019-02-28
Spring BootMySqlMyBatis
Spring Boot學習（一）——Spring Boot介紹
2021-09-16
Spring Boot
Spring Boot（六）整合 MyBatis 操作 MySQL 8
2018-09-12
Spring BootMyBatisMySql
Spring Boot 2.0(八)：Spring Boot 整合 Memcached
2018-09-04
Spring Boot
Spring Boot(十八)：使用 Spring Boot 整合 FastDFS
2018-01-16
Spring BootAST
spring boot學習
2018-08-22
Spring Boot
Spring Boot 學習
2022-02-28
Spring Boot
Spring Boot學習3：web篇（中）-Spring boot Rest學習
2018-02-03
Spring BootWebREST
Spring boot學習（二） Spring boot基礎配置
2019-01-17
Spring Boot
Spring boot學習（一）開啟Spring boot之旅
2019-01-17
Spring Boot
Spring Boot學習筆記：Spring Boot核心配置
2020-11-23
Spring Boot筆記
Spring Boot學習5：spring-boot web容器
2018-02-11
Spring BootWeb
Spring Boot整合MyBatis實現通用Mapper
2018-08-22
Spring BootMyBatisAPP
Spring Boot 整合 MyBatis和 SQL Server實踐
2018-12-17
Spring BootMyBatisSQLServer
從零開始學Spring Boot系列-整合MyBatis-Plus
2024-04-04
Spring BootMyBatis
Spring Boot整合Spring Batch
2019-05-09
Spring BootBAT
Spring Boot整合Spring Security
2018-12-18
Spring Boot
Spring Boot整合Spring Aop
2020-12-14
Spring Boot
Spring Boot整合rabbitmq
2020-05-10
Spring BootMQ
Spring Boot 整合 rabbitmq
2019-05-31
Spring BootMQ
Spring Boot 整合 elasticsearch
2019-05-31
Spring BootElasticsearch
Spring Boot 整合 docker
2019-05-31
Spring BootDocker
Spring Boot 整合 elk
2019-05-31
Spring Boot
Spring Boot 整合 Apollo
2019-05-31
Spring Boot