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

前言

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

文章首發於我的博客:【www.xiongfrblog.cn】

爲何使用Mybatis

在實際的開發過程當中是離不開數據庫的，這裏指的是關係型數據庫，例如MySql，Oracle,SqlServer等。你們應該都清楚若是不使用任何框架的狀況下，咱們項目要想鏈接數據庫大體分爲如下步驟：

1. 加載驅動（使用不一樣的數據庫加載不一樣的驅動）
2. 獲取鏈接
3. 編寫sql
4. 建立statement
5. 執行sql語句並處理結果
6. 從下而上依次關閉鏈接

實際的開發過程當中，咱們對數據庫的操做是很頻繁的，若是都按照上邊的方式去鏈接數據庫的話，將會給咱們帶來很糟糕的體驗，因此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~