mybatis使用一：springboot整合mybatis、mybatis generator，使用逆向工程生成java代码。

最新推荐文章于 2020-12-25 12:49:12 发布

java冯坚持

最新推荐文章于 2020-12-25 12:49:12 发布

阅读量446

点赞数

分类专栏： SQL、mybatis 文章标签： mybatis 数据库 spring java maven

本文链接：https://blog.csdn.net/qq_40036754/article/details/110096146

版权

SQL、mybatis 专栏收录该内容

6 篇文章 2 订阅

订阅专栏

文章目录

前言
一、新建springboot-mybatis工程
二、添加新依赖和插件
- 1. 添加的maven依赖
- 2. 全部的pom.xml文件
三、generatorConfig.xml
三、 config.properties配置如下
- 1. 注意事项（按需填写）
五、逆向生成数据
六、启动
七、通用Mapper的逆向工程

前言

Mybatis的逆向工程功能还是很强大的，可以自动生成实体类以及Mapper文件和Example文件，这样可以大大减少开发人员的工作量。
以前也开发过、使用过mybatis的逆向工程，但是每次没有记录过，以至于后续再使用时都是有点迷茫，知道流程，但是忘记了细节。然后再从网上先查询资料，再开发，以至于浪费了很多时间，所以现在拿出一点时间进行总结。
本博客，是查询了网上的很多资料，又查询了官网文档，进行统一整理。对generatorConfig.xml文件中的细节标签进行了解释。
mybatis-generator的官方文档提供如下：http://mybatis.org/generator/, 使用谷歌浏览器，可以进行右键翻译成中文观看。
本博客的GitHub地址在https://github.com/fengfanli/springboot-mybatis,master和dev01两个分支记得 star哦

一、新建springboot-mybatis工程

新建springboot项目重要地方如下：
选取的开发模块如下
依次按流程完成即可。

二、添加新依赖和插件

1. 添加的maven依赖

在pom.xml中引入两个依赖，依赖如下：

<!-- mybatis逆向工程jar包:mybatis-generator-core -->
<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-maven-plugin -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
</dependency>
<!--逆向工程，自动生成@Table、@Id等注解，会使用到下面两个注解-->
<dependency>
    <groupId>javax.persistence</groupId>
    <artifactId>persistence-api</artifactId>
    <version>1.0</version>
</dependency>
<!--通用Mapper启动器-->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.0.3</version>
</dependency>

<build>
        <finalName>springboot-mybatis</finalName>
        <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.2</version>
                <configuration>
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <!--避免操作不当，覆盖原来的类，设置为不覆盖：false-->
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.47</version>
                    </dependency>
                    <!--<dependency>
                        <groupId>com.thunisoft.arterybase</groupId>
                        <artifactId>ArteryBase</artifactId>
                        <version>3.6.2.2</version>
                    </dependency>-->
                    <!--自动生成@Table、@Id等注解-->
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>4.0.0</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

需要注意的是，src/main/resources/mybatis-generator/generatorConfig.xml 中的内容一定要写generatorConfig.xml从src开始的全路径，因为在执行逆向工程的时候会根据这个路径去读取generatorConfig.xml中的配置。

这时全部的依赖如下：

2. 全部的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.feng</groupId>
    <artifactId>springboot-mybatis</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-mybatis</name>
    <description>springboot-mybatis</description>

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

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <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>
        </dependency>

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


        <!-- mybatis逆向工程jar包:mybatis-generator-core -->
        <!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-maven-plugin -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!--逆向工程，自动生成@Table、@Id等注解，会使用到下面两个注解-->
        <dependency>
            <groupId>javax.persistence</groupId>
            <artifactId>persistence-api</artifactId>
            <version>1.0</version>
        </dependency>
        <!--通用Mapper启动器-->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.3</version>
        </dependency>


    </dependencies>

    <build>
        <finalName>springboot-mybatis</finalName>
        <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.2</version>
                <configuration>
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <!--避免操作不当，覆盖原来的类，设置为不覆盖：false-->
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.47</version>
                    </dependency>
                    <!--<dependency>
                        <groupId>com.thunisoft.arterybase</groupId>
                        <artifactId>ArteryBase</artifactId>
                        <version>3.6.2.2</version>
                    </dependency>-->
                    <!--自动生成@Table、@Id等注解-->
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>4.0.0</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

</project>

三、generatorConfig.xml

在resources包下创建 mybatis-generator/generatorConfig.xml 文件，即：src/main/resources/mybatis-generator/generatorConfig.xml

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>
    <!-- 数据库驱动(数据库的JDBC驱动):选择你的本地硬盘上面的数据库驱动包位置-->
    <classPathEntry
            location="E:\localadtmaven\mysql\mysql-connector-java\5.1.30\mysql-connector-java-5.1.30.jar"/>

    <!-- 一个数据库一个context -->
    <!--必选属性id，用来唯一确定一个<context>元素，该id属性可以在运行MBG的使用。-->
    <!--defaultModelType="flat" 大数据字段，不分表
        这个属性定义了MBG如何生成**实体类**。这个属性有以下可选值：
        conditional: *这是默认值*,这个模型和下面的hierarchical类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。
        flat: 该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。**这种模型最简单，推荐使用。
        hierarchical: 如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。
    -->
    <!--targetRuntime="MyBatis3"
        此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：
        MyBatis3:*这是默认值*
        MyBatis3Simple
        Ibatis2Java2
        Ibatis2Java5 一般情况下使用默认值即可，有关这些值的具体作用以及区别请查看中文文档的详细内容。
    -->
    <context id="MysqlTables" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="utf-8"/>

        <!-- JavaBean 实现 序列化 接口 -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 生成toString -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!--通用 Mapper 插件，可以生成带注解的实体类， 注解包括：@Table、@Column、@Id-->
        <!--<plugin type="tk.mybatis.mapper.generator.MapperPlugin">-->
            <!--<property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>-->
             <!--caseSensitive默认false，当数据库表名区分大小写时，可以将该属性设置为true -->
            <!--<property name="caseSensitive" value="true"/>-->
        <!--</plugin>-->

        <!-- optional，旨在创建class时，对注释进行控制 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true"/> <!-- 是否生成注释代时间戳-->
        </commentGenerator>

        <!--数据库链接URL，用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://192.168.131.168:3306/COMPANY"
                        userId="root"
                        password="123456"/>
        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal,
                false: 可自动转化以下类型（Long, Integer, Short, etc.），把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer(默认)
                true:  把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal
            -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成模型的包名和位置，也就是生成实体类地址 -->
        <javaModelGenerator targetPackage="com.feng.bean" targetProject="src/main/java">
            <!-- 默认false 是否允许子包 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 默认false 是否对model添加 构造函数 -->
            <property name="constructorBased" value="false"/>
            <!-- 默认false 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
            <!-- 默认false 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成映射文件的包名和位置，也就是生成 xml文件,文件默认生成在 resources.mapper 文件夹下-->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 生成 DAO 接口的位置 -->
        <javaClientGenerator targetPackage="com.feng.mapper" targetProject="src/main/java"
                             type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 要生成的表 tableName 是数据库中的表名或视图名 ，domainObjectName是实体类名-->
        <table tableName="COMPANY" domainObjectName="Company"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
        <!--<table tableName="sys_user" domainObjectName="SysUser"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false">
            <columnOverride column="sex" javaType="java.lang.Integer"/>
            <columnOverride column="status" javaType="java.lang.Integer"/>
            <columnOverride column="create_where" javaType="java.lang.Integer"/>
            <columnOverride column="deleted" javaType="java.lang.Integer"/>
        </table>-->
    </context>
</generatorConfiguration>

第一个配置是<properties resource="mybatis-generator/config.properties"/>,是将config.properties文件引入到本配置中，
config.properties 配置文件中都是key-value的键值对，也就是将generatorConfig.xml中可配置的值抽出来，在config.properties 进行编写。在generatorConfig.xml中使用 ${}去获取即可。

三、 config.properties配置如下

也就是说不用修改generatorConfig.xml配置文件，只需要修改config.properties 中的内容即可。按需修改。

# 数据库驱动路径
classPathEntry.location = E:\\localadtmaven\\mysql\\mysql-connector-java\\5.1.30\\mysql-connector-java-5.1.30.jar

# 数据库配置
jdbc.driverClass = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://192.168.131.168:3306/CLASS
jdbc.username = root
jdbc.password = Dataadt123!

#生成代码路径
package.bean = com.feng.bean
package.mapper= mapper
package.dao = com.feng.dao


# 数据库表配置(有几个表添加几个)
table1.tableName = STUDENT
table1.domainObjectName = Student

table2.tableName = tableName
table3.domainObjectName = ObjectName

这些配置可以直接考过去，每一行配置上都有注释，把需要改的改成自己的即可；
仔细观看注释，很详细，可直接复制使用。

1. 注意事项（按需填写）

数据库的名称和表名称 一定要与数据库中名称保持一致，包括大小写。
config.properties 主要要修改的标签不是很多，总结如下，共有6类信息;
classPathEntry.location:数据库驱动的路径。
jdbc:jdbc链接信息。
package.bean:生成模型（实体类）的位置。
package.mapper:生成映射文件的包名和位置。
package.dao:生成DAO接口的位置。
table1.tableName:要生成的表与实体类的映射。

五、逆向生成数据

配置完了之后，我们就可执行逆向工程了，点击右侧的Maven，就能看到下面的结构，然后根据如果的路径找到 mybatis-generator,双击运行即可。
在这里插入图片描述
如果控制台出现以下的样子，就说嘛成功了

现在可以来看看效果，刷新一下，会发现Company.java、CompanyMapper.java、CompanyMapper.xml这三个文件都已经生成好了。

六、启动

在启动类上添加排除数据源的自动配置，要不然会报错：Failed to configure a DataSource: ‘url’ attribute is not specified and no embedded datasource could be configured.
在这里插入图片描述
运行即可，出现如下，则运行成功。

项目的结构如下：