前言
前面我們介紹了如何創(chuàng)建一個Spring boot項(xiàng)目以及Spring boot項(xiàng)目的一些基本配置衡蚂，在了解了這些知識的前提下本篇博客繼續(xù)介紹在Spring boot中配置一個基于java的持久層框架---Mybatis。
文章首發(fā)于個人博客:【http://www.xiongfrblog.cn】
為什么使用Mybatis
在實(shí)際的開發(fā)過程中是離不開數(shù)據(jù)庫的歌焦，這里指的是關(guān)系型數(shù)據(jù)庫榕吼，例如MySql轧邪，Oracle,SqlServer等拖吼。大家應(yīng)該都清楚如果不使用任何框架的情況下鼻疮，我們項(xiàng)目要想連接數(shù)據(jù)庫大致分為以下步驟：
- 加載驅(qū)動（使用不同的數(shù)據(jù)庫加載不同的驅(qū)動）
- 獲取連接
- 編寫sql
- 創(chuàng)建
statement - 執(zhí)行sql語句并處理結(jié)果
- 從下而上依次關(guān)閉連接
實(shí)際的開發(fā)過程中，我們對數(shù)據(jù)庫的操作是很頻繁的借嗽，如果都按照上邊的方式去連接數(shù)據(jù)庫的話态鳖，將會給我們帶來很糟糕的體驗(yàn)，所以Mybatis應(yīng)運(yùn)而生淹魄，Mybatis內(nèi)部封裝了jdbc郁惜，使我們開發(fā)者只需要考慮sql語句的編寫堡距，其余的都幫我們搞定甲锡，極大的減輕了開發(fā)人員的工作量，而且還提供了動態(tài)sql等強(qiáng)大功能羽戒，能應(yīng)對實(shí)際項(xiàng)目中的各種需求缤沦，這也是它受到大家青睞的原因。
在Spring boot中配置Mybatis
添加依賴
在整合Mybatis之前先準(zhǔn)備一個干凈的Spring boot項(xiàng)目,然后在pom.xml文件中添加mybatis-spring-boot-starter依賴易稠，因?yàn)樾枰P(guān)聯(lián)到數(shù)據(jù)庫缸废，所以還必須添加一個數(shù)據(jù)庫的依賴，這里我使用的是Mysql數(shù)據(jù)庫驶社，所以需要在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版本對應(yīng)的Mybatis也不一樣企量，詳細(xì)情況可查閱官方文檔【傳送門】。
看到網(wǎng)上很多教程都添加了jdbc的依賴亡电，其實(shí)這里是不需要的届巩，因?yàn)?code>mybatis-spring-boot-starter已經(jīng)包含了spring-boot-starter-jdbc依賴，查看項(xiàng)目中隱形依賴的方法為（使用eclipse）：右鍵項(xiàng)目-->Run As-->Maven build...在彈出框的Goals欄中輸入dependency:tree,點(diǎn)擊Run份乒，在控制臺就會打印出項(xiàng)目的所有依賴及關(guān)系恕汇，如圖：
圖示內(nèi)容可以證明我上面的言論。
配置數(shù)據(jù)源
在application.properties配置文件中添加如下內(nèi)容:
#mybatis配置
#配置實(shí)體類的位置
mybatis.type-aliases-package=com.web.springbootmybatis.entity
#xml文件位置
mybatis.mapper-locations=classpath:mapper/*.xml
#mysql數(shù)據(jù)庫連接信息配置
#mysql驅(qū)動
spring.datasource.driverClassName=com.mysql.jdbc.Driver
#數(shù)據(jù)庫連接信息
spring.datasource.url=jdbc:mysql://localhost:3306/eran?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
#數(shù)據(jù)庫用戶名
spring.datasource.username=root
#數(shù)據(jù)庫密碼
spring.datasource.password=root
配置的屬性值根據(jù)自己的實(shí)際情況填寫或辖，這里是我的配置瘾英，特別要注意實(shí)體類的位置以及xml文件的位置。
構(gòu)建MVC項(xiàng)目結(jié)構(gòu)
創(chuàng)建出對應(yīng)的包即可颂暇，這里我們就創(chuàng)建了幾個需要的包就可以了缺谴，項(xiàng)目結(jié)構(gòu)如下圖：
數(shù)據(jù)庫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
實(shí)體類
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文件煌集，這里只是簡單寫一下妓肢，實(shí)際開發(fā)中，這些文件我們都是利用插件自動生成的苫纤，以后的博客會介紹碉钠。
<?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接口實(shí)現(xiàn)
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層位置,里邊的值根據(jù)實(shí)際情況填寫。
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);
}
}
此時項(xiàng)目的結(jié)構(gòu)為：
啟動項(xiàng)目
啟動項(xiàng)目卷拘，訪問localhost:8080/user或者127.0.0.1:8080/user喊废，得到如下信息：
拿到了數(shù)據(jù)庫中存放的用戶信息，至此Spring boot簡單整合Mybatis就成功了栗弟，這里我們使用的是默認(rèn)的tomcat-jdbc數(shù)據(jù)源污筷，在實(shí)際開發(fā)過程中我們一般使用alibaba提供的功能更強(qiáng)大的druid數(shù)據(jù)源，后邊的博客會詳細(xì)介紹乍赫，這里就不概述了瓣蛀。
打印sql
細(xì)心的小伙伴會發(fā)現(xiàn)按照上邊的配置，我們訪問了數(shù)據(jù)庫雷厂，但是控制臺并沒有打印出我們具體的sql語句惋增，這在實(shí)際開過程中是非常不友好的，看不到sql語句非常不利于我們快速的定位bug,所以下面介紹以下在Spring boot中開啟sql日志的功能改鲫，很簡單诈皿，只需要在配置文件中添加一句配置即可：
logging.level.com.web.springbootmybatis.dao=debug
logging.level后面的路徑指的是mybatis對應(yīng)的方法接口所在的包(也就是dao層所在的包)，并不是
mapper.xml所在的包像棘。
重啟項(xiàng)目稽亏，再次訪問，觀察控制臺是不是已經(jīng)打印出了sql語句了呢：
結(jié)語
關(guān)于Spring boot整合Mybatis的介紹就到這里了缕题，下面的博客中會繼續(xù)介紹Mybatis的自動化插件以及分頁插件截歉，使用druid數(shù)據(jù)源等,bye~
