Spring boot學習(三) Spring boot整合mybatis

前言

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

文章首發于個人博客:【http://www.xiongfrblog.cn

為什么使用Mybatis

在實際的開發過程中是離不開數據庫的,這里指的是關系型數據庫,例如MySqlOracle,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~

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容