Spring boot學習（三） Spring boot整合mybatis
前言
前面我們介紹瞭如何建立一個Spring boot專案以及Spring boot專案的一些基本配置，在瞭解了這些知識的前提下本篇部落格繼續介紹在Spring boot中配置一個基於 java 的持久層框架--- Mybatis 。
文章首發於個人部落格:【 http://www.xiongfrblog.cn 】
為什麼使用Mybatis
在實際的開發過程中是離不開資料庫的，這裡指的是 關係型資料庫 ，例如 MySql ， Oracle , SqlServer 等。大家應該都清楚如果不使用任何框架的情況下，我們專案要想連線資料庫大致分為以下步驟：
statement
實際的開發過程中，我們對資料庫的操作是很頻繁的，如果都按照上邊的方式去連線資料庫的話，將會給我們帶來很糟糕的體驗，所以 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;
importcom.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~