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~