从零开始，SpringBoot+Mybatis整合详细步骤

写在开始:一个搬砖程序员的随缘记录

一、创建数据库

CREATE TABLE `tb_user_dat` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '姓名',
  `sex` int(11) DEFAULT NULL COMMENT '性别 1:男 2:女',
  `age` int(11) DEFAULT NULL COMMENT '年龄',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `create_user` int(11) DEFAULT NULL COMMENT '创建人',
  `update_time` datetime DEFAULT NULL COMMENT '修改时间',
  `update_user` int(11) DEFAULT NULL COMMENT '修改人',
  `is_delete` tinyint(1) DEFAULT '1' COMMENT '是否已删除 1:是 0:否',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

二、创建一个SpringBoot项目

可以看之前的文章：SpringBoot项目快速搭建

目录结构：

加入一些基本需要的package后的目录结构

三、项目配置

1、依赖配置

pom.xml

	<properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web-services</artifactId>
        </dependency>

        <!-- druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.8</version>
        </dependency>

        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>

        <!-- mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.1</version>
        </dependency>

        <!-- mybatis自动生成实体类 -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <configurationFile>src/main/resources/GeneratorMapper.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
        </plugins>
    </build>

2、数据源配置

application.yml

server:
  port: 8080 #端口号

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8 #数据库url
    username: root #数据库用户名
    password: admin #数据库密码
    driver-class-name: com.mysql.jdbc.Driver

mybatis:
  mapper-location: classpath:mybatis-config.xml #mybatis-config路径
  mapper-locations: classpath:/mybatis/*.xml

3、mybatis配置

在resources下新建一个mybatis-config.xml文件
mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="lazyLoadingEnabled" value="false" />
        <setting name="cacheEnabled" value="false"/>
        <setting name="multipleResultSetsEnabled" value="true"/>
        <setting name="aggressiveLazyLoading" value="true"/>
        <!--开启驼峰-->
        <setting name="mapUnderscoreToCamelCase" value="true" />
    </settings>
    <typeAliases>
        <!-- 实体类包名地址 -->
        <package name="com.cn.mybatis.entity"/>
    </typeAliases>
</configuration>

4、启动类配置

启动类加入：

@MapperScan("com.cn.mybatis.mapper")

5、加入自动生成实体类文件

在resources下创建GeneratorMapper.xml文件
GeneratorMapper.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="/Users/xxx/workspace/javaJdbc/mysql-connector-java-5.1.22-bin.jar"/>
    <context id="testTables" targetRuntime="MyBatis3">

        <commentGenerator>
            <!--抑制生成注释，由于生成的注释都是英文的，可以不让它生成-->
            <property name="suppressAllComments" value="true"/>
            <!-- 设置文件编码，如果不设置中文会乱码 -->
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>

        <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis"
                        userId="root" password="admin">
        </jdbcConnection>
        <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和
            NUMERIC 类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- targetProject:生成PO类的位置 -->
        <javaModelGenerator targetPackage="com.cn.mybatis.entity"
                            targetProject="/Users/xxx/workspace/demo/mybatis_demo/src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!--                 targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="mybatis"
                         targetProject="/Users/xxx/workspace/demo/mybatis_demo/src/main/resources">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!--         targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.cn.mybatis.mapper"
                             targetProject="/Users/xxx/workspace/demo/mybatis_demo/src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!-- 指定数据库表 -->
        <table tableName="tb_user_dat" domainObjectName="TbUserDat">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

注解：

jar下载地址：jar包

提取码:8fjd

生成实体类和mapper相关类和xml

没有的刷新一下maven

生成后的项目目录

四、代码演示

controller类

package com.cn.mybatis.controller;

import com.cn.mybatis.entity.TbUserDat;
import com.cn.mybatis.service.MybatisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: demo
 * @Date: 2020-05-19 14:54
 */
@RestController
public class MybatisController {
    @Autowired
    private MybatisService mybatisService;

    /**
     * 根据用户id查询用户信息
     *
     * @param id
     * @return
     */
    @GetMapping("/getUserByid")
    public TbUserDat getUserByid(Integer id) {
        return mybatisService.getUserByid(id);
    }
}

service类

package com.cn.mybatis.service;

import com.cn.mybatis.entity.TbUserDat;

/**
 * @Author: demo
 * @Date: 2020-05-19 14:53
 */
public interface MybatisService {
    /**
     * 根据用户id查询用户信息
     *
     * @param id
     * @return
     * */
    TbUserDat getUserByid(Integer id);
}

service实现类

package com.cn.mybatis.service.impl;

import com.cn.mybatis.entity.TbUserDat;
import com.cn.mybatis.mapper.TbUserDatMapper;
import com.cn.mybatis.service.MybatisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @Author: demo
 * @Date: 2020-05-19 14:54
 */
@Service
public class MybatisServiceImpl implements MybatisService {
    @Autowired
    private TbUserDatMapper tbUserDatMapper;

    @Override
    public TbUserDat getUserByid(Integer id) {
        //根据用户id查询用户信息
        TbUserDat tbUserDat = tbUserDatMapper.selectByPrimaryKey(id);
        return tbUserDat;
    }
}

五、效果

Over