Spring boot Mybatis 整合（完整版）

对mybatis注解方式有兴趣的，可以查看我的另一篇：spring boot mybatis 整合（注解版） 注解方式更加简洁简单，极大程度的提高了开发速度。如果大家需要使用更高的版本比如springboot2.0，请参照我最新的博客springboot2.0 mybatis 整合 (springboot2.0版本)

个人开源项目

• springboot+mybatis+thymeleaf+docker构建的个人站点开源项目（集成了个人主页、个人作品、个人博客）

更多干货

springboot系列目录

正题

本项目使用的环境：

• 开发工具：intellij idea 2017.1.3
• springboot: 1.5.6
• jdk：1.8.0_161
• maven:3.3.9

额外功能

• pagehelper 分页插件
• mybatis generator 自动生成代码插件

步骤：
1.创建一个springboot项目：

2.创建项目的文件结构以及jdk的版本

3.选择项目所需要的依赖


然后点击finish

5.看一下文件的结构：

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>
        <!-- 分页插件 -->
        <dependency>
            <groupid>com.github.pagehelper</groupid>
            <artifactid>pagehelper-spring-boot-starter</artifactid>
            <version>1.1.2</version>
        </dependency>
        <!-- alibaba的druid数据库连接池 -->
        <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 自动生成代码插件 -->
            <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.项目不使用application.properties文件 而使用更加简洁的application.yml文件：
将原有的resource文件夹下的application.properties文件删除，创建一个新的application.yml配置文件，
文件的内容如下：

server:
  port: 8080

spring:
    datasource:
        name: test
        url: jdbc:mysql://127.0.0.1:3306/depot
        username: root
        password: root
        # 使用druid数据源
        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

## 该配置节点为独立的节点，有很多同学容易将这个配置放在spring的节点下，导致配置无法被识别
mybatis:
  mapper-locations: classpath:mapping/*.xml  #注意：一定要对应mapper映射xml文件的所在路径
  type-aliases-package: com.winter.model  # 注意：对应实体类的路径

#pagehelper分页插件
pagehelper:
    helperdialect: mysql
    reasonable: true
    supportmethodsarguments: true
    params: count=countsql

8.创建数据库：

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 自动生成代码：

• 配置pom.xml中generator 插件所对应的配置文件 ${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>
    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
    <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"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressallcomments" value="true"/>
        </commentgenerator>
        <!--数据库链接url，用户名、密码 -->
        <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是数据库中的表名或视图名 domainobjectname是实体类名-->
        <table tablename="t_user" domainobjectname="user" enablecountbyexample="false" enableupdatebyexample="false" enabledeletebyexample="false" enableselectbyexample="false" selectbyexamplequeryid="false"></table>
    </context>
</generatorconfiguration>

• 点击run-edit configurations

• 添加配置

• 运行
  注意！！！同一张表一定不要运行多次，因为mapper的映射文件中会生成多次的代码，导致报错，切记
  

  最后生成的文件以及结构：

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);
    //这个方式我自己加的
    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();
    }
}

对于sql语句这种黄色的背景，真心是看不下去了（解决方案）：

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>
  <!-- 这个方法是我自己加的 -->
  <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.打开类springbootmybatisdemoapplication.java，这个是springboot的启动类。我们需要添加点东西：

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")//将项目中对应的mapper类的路径加进来就可以了
public class springbootmybatisdemoapplication {

    public static void main(string[] args) {
        springapplication.run(springbootmybatisdemoapplication.class, args);
    }
}

注意：@mapperscan("com.winter.mapper")这个注解非常的关键，这个对应了项目中mapper（dao）所对应的包路径，很多同学就是这里忘了加导致异常的

12.到这里所有的搭建工作都完成了，接下来就是测试的工作，没使用junit4进行测试：
首先看一下完成之后的文件的结构：

现在controller，service层的代码都写好：

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;//这里会报错，但是并不会影响

    @override
    public int adduser(user user) {

        return usermapper.insertselective(user);
    }

    /*
    * 这个方法中用到了我们开头配置依赖的分页插件pagehelper
    * 很简单，只需要在service层传入参数，然后将参数传递给一个插件的一个静态方法即可；
    * pagenum 开始页数
    * pagesize 每页显示的数据条数
    * */
    @override
    public list<user> findalluser(int pagenum, int pagesize) {
        //将参数传给这个方法就可以实现物理分页了，非常简单。
        pagehelper.startpage(pagenum, pagesize);
        return usermapper.selectalluser();
    }
}

如果强迫症看不下去那个报错：（解决方法）

测试我使用了idea一个很用心的功能。
可以发http请求的插件：

点击左侧的运行按钮就可以发送请求了；
如果返回值正确 说明你已经搭建成功了！！

**如果出现mapper注入不了的情况，请检查版本，当前博客的搭建方法只适合1.5.*版本的，如果你的版本是2.0以上的版本，请参照我的另一篇博客的mybatis的配置：springboot2.0整合mybatis **

如果大家想使用事务控制的话，请参照spring boot mybatis 整合（注解版） ,这个里面就有关于事务控制的使用

源码地址：https://github.com/winterchens/springboot-mybatis-demo

springboot技术交流群：681513531