SpringBoot 整合 mybatis

一. 实现过程

1. 前提

本文直接实现 mybatis 自动生成代码，需要连接数据库，所以在整合 mybatis 之前要先配置好数据库信息

1.1 引入数据库依赖

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

1.2 application.properties 配置数据库信息

#set database
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/boxcloud?useUnicode=true&characterEncoding=utf-8&useSSL=false&generateSimpleParameterMetadata=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

1.3 如果需要数据库连接池，可以加入相应配置，这里选择 alibaba druid

引入依赖

<!-- alibaba的druid数据库连接池 -->
<dependency>
     <groupId>com.alibaba</groupId>
     <artifactId>druid-spring-boot-starter</artifactId>
     <version>1.1.0</version>
</dependency>

application.properties

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

2. 接下来开始整合mybatis

2.1 引入依赖

<!-- mybatis -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>
<!--mybatis 自动生成插件-->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.5</version>
</dependency>

2.2 引入插件

<!-- mybatis generator 自动生成代码插件 -->
<plugin>
     <groupId>org.mybatis.generator</groupId>
     <artifactId>mybatis-generator-maven-plugin</artifactId>
     <version>1.3.5</version>
     <configuration>
         <configurationFile>${basedir}/src/main/resources/mybatis/generator-config.xml</configurationFile>
         <overwrite>true</overwrite><!-- false 表示不会覆盖之前生成的代码 -->
         <verbose>true</verbose>
     </configuration>
</plugin>

2.3 创建 generator-config.xml 文件

本文中路径为 src/main/resources/mybatis/generator-config.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>

    <!-- 引入SpringBoot配置文件 -->
    <properties resource="application.properties"/>
    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包，可以去 Maven Dependencies 里面找，然后 Copy Qualified Name-->
    <classPathEntry  location="C:\Users\lkk\.m2\repository\mysql\mysql-connector-java\5.1.43\mysql-connector-java-5.1.43.jar"/>
    <context id="mysqlTables"  targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!-- 数据库驱动、数据库链接URL、用户名、密码 -->
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="com.ahav.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成DAO的包名和位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.ahav.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
        <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>

2.4 创建数据库表之后验证是否成功

在项目上 Run As --> Maven build... --> mybatis-generator:generate

注意：这里使用的数据库驱动的版本号最好选择 5.X.X ，5点几的版本可能更稳定，对 mybatis 的支持更好一些，使用 6.0.6 等其他更新的版本总是报错。

结果如下：对应的目录如果不存在的话会自动创建

二. 原理理解