Spring boot Mybatis 整合（完整版）

更新時(shí)間：2018年09月06日 09:05:38 作者：LuisChen

本文是一篇比較完整的版本通過(guò)圖文并茂的形式給大家介紹了Spring boot Mybatis 整合過(guò)程，感興趣的朋友跟隨腳本之家小編一起看看吧

本項(xiàng)目使用的環(huán)境：

開(kāi)發(fā)工具：

Intellij IDEA 2017.1.3
springboot: 1.5.6
jdk：1.8.0_161
maven:3.3.9

額外功能

PageHelper 分頁(yè)插件
mybatis generator

自動(dòng)生成代碼插件

步驟：

1.創(chuàng)建一個(gè)springboot項(xiàng)目：

這里寫(xiě)圖片描述

2.創(chuàng)建項(xiàng)目的文件結(jié)構(gòu)以及jdk的版本

這里寫(xiě)圖片描述

3.選擇項(xiàng)目所需要的依賴(lài)

這里寫(xiě)圖片描述

然后點(diǎn)擊finish

5.看一下文件的結(jié)構(gòu)：

這里寫(xiě)圖片描述

6.查看一下pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.winter</groupId>
 <artifactId>springboot-mybatis-demo</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <packaging>jar</packaging>
 <name>springboot-mybatis-demo</name>
 <description>Demo project for Spring Boot</description>
 <parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>1.5.6.RELEASE</version>
 <relativePath/> <!-- lookup parent from repository -->
 </parent>
 <properties>
 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 <java.version>1.7</java.version>
 </properties>
 <dependencies>
 <dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.3.0</version>
 </dependency>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
 </dependency>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
 </dependency>
 <dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.35</version>
 </dependency>
 <dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-core</artifactId>
 </dependency>
 <dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
 </dependency>
 <dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-joda</artifactId>
 </dependency>
 <dependency>
  <groupId>com.fasterxml.jackson.module</groupId>
  <artifactId>jackson-module-parameter-names</artifactId>
 </dependency>
 <!-- 分頁(yè)插件 -->
 <dependency>
  <groupId>com.github.pagehelper</groupId>
  <artifactId>pagehelper-spring-boot-starter</artifactId>
  <version>1.1.2</version>
 </dependency>
 <!-- alibaba的druid數(shù)據(jù)庫(kù)連接池 -->
 <dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid-spring-boot-starter</artifactId>
  <version>1.1.0</version>
 </dependency>
 </dependencies>
 <build>
 <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  </plugin>
  <!-- mybatis generator 自動(dòng)生成代碼插件 -->
  <plugin>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-maven-plugin</artifactId>
  <version>1.3.2</version>
  <configuration>
   <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
   <overwrite>true</overwrite>
   <verbose>true</verbose>
  </configuration>
  </plugin>
 </plugins>
 </build>
</project>

7.項(xiàng)目不使用application.properties文件而使用更加簡(jiǎn)潔的application.yml文件：
將原有的resource文件夾下的application.properties文件刪除，創(chuàng)建一個(gè)新的application.yml配置文件，
文件的內(nèi)容如下：

server:
 port: 8080
spring:
 datasource:
 name: test
 url: jdbc:mysql://127.0.0.1:3306/depot
 username: root
 password: root
 # 使用druid數(shù)據(jù)源
 type: com.alibaba.druid.pool.DruidDataSource
 driver-class-name: com.mysql.jdbc.Driver
 filters: stat
 maxActive: 20
 initialSize: 1
 maxWait: 60000
 minIdle: 1
 timeBetweenEvictionRunsMillis: 60000
 minEvictableIdleTimeMillis: 300000
 validationQuery: select 'x'
 testWhileIdle: true
 testOnBorrow: false
 testOnReturn: false
 poolPreparedStatements: true
 maxOpenPreparedStatements: 20
## 該配置節(jié)點(diǎn)為獨(dú)立的節(jié)點(diǎn)，有很多同學(xué)容易將這個(gè)配置放在spring的節(jié)點(diǎn)下，導(dǎo)致配置無(wú)法被識(shí)別
mybatis:
 mapper-locations: classpath:mapping/*.xml #注意：一定要對(duì)應(yīng)mapper映射xml文件的所在路徑
 type-aliases-package: com.winter.model # 注意：對(duì)應(yīng)實(shí)體類(lèi)的路徑
#pagehelper分頁(yè)插件
pagehelper:
 helperDialect: mysql
 reasonable: true
 supportMethodsArguments: true
 params: count=countSql

8.創(chuàng)建數(shù)據(jù)庫(kù)：

CREATE DATABASE mytest;
CREATE TABLE t_user(
 user_id INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
 user_name VARCHAR(255) NOT NULL ,
 password VARCHAR(255) NOT NULL ,
 phone VARCHAR(255) NOT NULL
) ENGINE=INNODB AUTO_INCREMENT=1000 DEFAULT CHARSET=utf8;

9.使用mybatis generator 自動(dòng)生成代碼：

配置pom.xml中g(shù)enerator 插件所對(duì)應(yīng)的配置文件 ${basedir}/src/main/resources/generator/generatorConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
 <!-- 數(shù)據(jù)庫(kù)驅(qū)動(dòng):選擇你的本地硬盤(pán)上面的數(shù)據(jù)庫(kù)驅(qū)動(dòng)包-->
 <classPathEntry location="E:\developer\mybatis-generator-core-1.3.2\lib\mysql-connector-java-5.1.25-bin.jar"/>
 <context id="DB2Tables" targetRuntime="MyBatis3">
 <commentGenerator>
  <property name="suppressDate" value="true"/>
  <!-- 是否去除自動(dòng)生成的注釋 true：是 ： false:否 -->
  <property name="suppressAllComments" value="true"/>
 </commentGenerator>
 <!--數(shù)據(jù)庫(kù)鏈接URL，用戶(hù)名、密碼 -->
 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1/mytest" userId="root" password="root">
 </jdbcConnection>
 <javaTypeResolver>
  <property name="forceBigDecimals" value="false"/>
 </javaTypeResolver>
 <!-- 生成模型的包名和位置-->
 <javaModelGenerator targetPackage="com.winter.model" targetProject="src/main/java">
  <property name="enableSubPackages" value="true"/>
  <property name="trimStrings" value="true"/>
 </javaModelGenerator>
 <!-- 生成映射文件的包名和位置-->
 <sqlMapGenerator targetPackage="mapping" targetProject="src/main/resources">
  <property name="enableSubPackages" value="true"/>
 </sqlMapGenerator>
 <!-- 生成DAO的包名和位置-->
 <javaClientGenerator type="XMLMAPPER" targetPackage="com.winter.mapper" targetProject="src/main/java">
  <property name="enableSubPackages" value="true"/>
 </javaClientGenerator>
 <!-- 要生成的表 tableName是數(shù)據(jù)庫(kù)中的表名或視圖名 domainObjectName是實(shí)體類(lèi)名-->
 <table tableName="t_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
 </context>
</generatorConfiguration>

點(diǎn)擊run-Edit Configurations

這里寫(xiě)圖片描述

添加配置

這里寫(xiě)圖片描述

運(yùn)行

注意?。?！同一張表一定不要運(yùn)行多次，因?yàn)閙apper的映射文件中會(huì)生成多次的代碼，導(dǎo)致報(bào)錯(cuò)，切記

這里寫(xiě)圖片描述

最后生成的文件以及結(jié)構(gòu)：

這里寫(xiě)圖片描述

10. 生成的文件

UserMapper.java

package com.winter.mapper;
import com.winter.model.User;
public interface UserMapper {
 int deleteByPrimaryKey(Integer userId);
 int insert(User record);
 int insertSelective(User record);
 User selectByPrimaryKey(Integer userId);
 int updateByPrimaryKeySelective(User record);
 int updateByPrimaryKey(User record);
 //這個(gè)方式我自己加的
 List<User> selectAllUser();
}

User.java

package com.winter.model;
public class User {
 private Integer userId;
 private String userName;
 private String password;
 private String phone;
 public Integer getUserId() {
 return userId;
 }
 public void setUserId(Integer userId) {
 this.userId = userId;
 }
 public String getUserName() {
 return userName;
 }
 public void setUserName(String userName) {
 this.userName = userName == null ? null : userName.trim();
 }
 public String getPassword() {
 return password;
 }
 public void setPassword(String password) {
 this.password = password == null ? null : password.trim();
 }
 public String getPhone() {
 return phone;
 }
 public void setPhone(String phone) {
 this.phone = phone == null ? null : phone.trim();
 }
}

對(duì)于sql語(yǔ)句這種黃色的背景，真心是看不下去了（解決方案）：

這里寫(xiě)圖片描述

UserMapper.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.winter.mapper.UserMapper" >
 <resultMap id="BaseResultMap" type="com.winter.model.User" >
 <id column="user_id" property="userId" jdbcType="INTEGER" />
 <result column="user_name" property="userName" jdbcType="VARCHAR" />
 <result column="password" property="password" jdbcType="VARCHAR" />
 <result column="phone" property="phone" jdbcType="VARCHAR" />
 </resultMap>
 <sql id="Base_Column_List" >
 user_id, user_name, password, phone
 </sql>
 <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
 select 
 <include refid="Base_Column_List" />
 from t_user
 where user_id = #{userId,jdbcType=INTEGER}
 </select>
 <!-- 這個(gè)方法是我自己加的 -->
 <select id="selectAllUser" resultMap="BaseResultMap">
 select
 <include refid="Base_Column_List" />
 from t_user
 </select>
 <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
 delete from t_user
 where user_id = #{userId,jdbcType=INTEGER}
 </delete>
 <insert id="insert" parameterType="com.winter.model.User" >
 insert into t_user (user_id, user_name, password, 
 phone)
 values (#{userId,jdbcType=INTEGER}, #{userName,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR}, 
 #{phone,jdbcType=VARCHAR})
 </insert>
 <insert id="insertSelective" parameterType="com.winter.model.User" >
 insert into t_user
 <trim prefix="(" suffix=")" suffixOverrides="," >
 <if test="userId != null" >
 user_id,
 </if>
 <if test="userName != null" >
 user_name,
 </if>
 <if test="password != null" >
 password,
 </if>
 <if test="phone != null" >
 phone,
 </if>
 </trim>
 <trim prefix="values (" suffix=")" suffixOverrides="," >
 <if test="userId != null" >
 #{userId,jdbcType=INTEGER},
 </if>
 <if test="userName != null" >
 #{userName,jdbcType=VARCHAR},
 </if>
 <if test="password != null" >
 #{password,jdbcType=VARCHAR},
 </if>
 <if test="phone != null" >
 #{phone,jdbcType=VARCHAR},
 </if>
 </trim>
 </insert>
 <update id="updateByPrimaryKeySelective" parameterType="com.winter.model.User" >
 update t_user
 <set >
 <if test="userName != null" >
 user_name = #{userName,jdbcType=VARCHAR},
 </if>
 <if test="password != null" >
 password = #{password,jdbcType=VARCHAR},
 </if>
 <if test="phone != null" >
 phone = #{phone,jdbcType=VARCHAR},
 </if>
 </set>
 where user_id = #{userId,jdbcType=INTEGER}
 </update>
 <update id="updateByPrimaryKey" parameterType="com.winter.model.User" >
 update t_user
 set user_name = #{userName,jdbcType=VARCHAR},
 password = #{password,jdbcType=VARCHAR},
 phone = #{phone,jdbcType=VARCHAR}
 where user_id = #{userId,jdbcType=INTEGER}
 </update>
</mapper>

11.打開(kāi)類(lèi)SpringbootMybatisDemoApplication.java，這個(gè)是springboot的啟動(dòng)類(lèi)。我們需要添加點(diǎn)東西：

package com.winter;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.winter.mapper")//將項(xiàng)目中對(duì)應(yīng)的mapper類(lèi)的路徑加進(jìn)來(lái)就可以了
public class SpringbootMybatisDemoApplication {
 public static void main(String[] args) {
 SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
 }
}

注意：@MapperScan("com.winter.mapper")這個(gè)注解非常的關(guān)鍵，這個(gè)對(duì)應(yīng)了項(xiàng)目中mapper（dao）所對(duì)應(yīng)的包路徑，很多同學(xué)就是這里忘了加導(dǎo)致異常的

12.到這里所有的搭建工作都完成了，接下來(lái)就是測(cè)試的工作，沒(méi)使用junit4進(jìn)行測(cè)試：
首先看一下完成之后的文件的結(jié)構(gòu)：

這里寫(xiě)圖片描述

現(xiàn)在controller，service層的代碼都寫(xiě)好：

UserController.java

package com.winter.Controller;
import com.winter.model.User;
import com.winter.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
 * Created by Administrator on 2017/8/16.
 */
@Controller
@RequestMapping(value = "/user")
public class UserController {
 @Autowired
 private UserService userService;
 @ResponseBody
 @RequestMapping(value = "/add", produces = {"application/json;charset=UTF-8"})
 public int addUser(User user){
 return userService.addUser(user);
 }
 @ResponseBody
 @RequestMapping(value = "/all/{pageNum}/{pageSize}", produces = {"application/json;charset=UTF-8"})
 public Object findAllUser(@PathVariable("pageNum") int pageNum, @PathVariable("pageSize") int pageSize){
 return userService.findAllUser(pageNum,pageSize);
 }
}

UserService.java

package com.winter.service;
import com.winter.model.User;
import java.util.List;
/**
 * Created by Administrator on 2017/8/16.
 */
public interface UserService {
 int addUser(User user);
 List<User> findAllUser(int pageNum, int pageSize);
}

UserServiceImpl.java

package com.winter.service.impl;
import com.github.pagehelper.PageHelper;
import com.winter.mapper.UserMapper;
import com.winter.model.User;
import com.winter.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
/**
 * Created by Administrator on 2017/8/16.
 */
@Service(value = "userService")
public class UserServiceImpl implements UserService {
 @Autowired
 private UserMapper userMapper;//這里會(huì)報(bào)錯(cuò)，但是并不會(huì)影響
 @Override
 public int addUser(User user) {
 return userMapper.insertSelective(user);
 }
 /*
 * 這個(gè)方法中用到了我們開(kāi)頭配置依賴(lài)的分頁(yè)插件pagehelper
 * 很簡(jiǎn)單，只需要在service層傳入?yún)?shù)，然后將參數(shù)傳遞給一個(gè)插件的一個(gè)靜態(tài)方法即可；
 * pageNum 開(kāi)始頁(yè)數(shù)
 * pageSize 每頁(yè)顯示的數(shù)據(jù)條數(shù)
 * */
 @Override
 public List<User> findAllUser(int pageNum, int pageSize) {
 //將參數(shù)傳給這個(gè)方法就可以實(shí)現(xiàn)物理分頁(yè)了，非常簡(jiǎn)單。
 PageHelper.startPage(pageNum, pageSize);
 return userMapper.selectAllUser();
 }
}

如果強(qiáng)迫癥看不下去那個(gè)報(bào)錯(cuò)：（解決方法）

這里寫(xiě)圖片描述