SpringBoot整合MybatisGenerator

MybatisGenerator是一个代码生成器插件，它会根据你设计的数据库自动生成entity类、dao接口、mapper.xml文件。一下是SpringBoot整合的具体流程。

1.在pom文件中添加依赖文件

        <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>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
            <scope>true</scope>
        </dependency>
        <!--mybatis start-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <!--mybatis generator-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.1</version>
        </dependency>
        <!--mybatis end-->
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

2.在pom文件<build></build>中配置插件。

    <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.5</version>
                <dependencies>
                    <dependency>
                        <groupId> mysql</groupId>
                        <artifactId> mysql-connector-java</artifactId>
                        <version> 5.1.30</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!--允许移动生成的文件 -->
                    <verbose>true</verbose>
                    <!-- 是否覆盖 -->
                    <overwrite>true</overwrite>
                    <!-- 自动生成的配置 -->
                    <configurationFile>
                        src/main/resources/mybatis-generator.xml</configurationFile>
                </configuration>
            </plugin>
        </plugins>
        <!--配置Maven 对resource文件 过滤 不配置会忽略mapper.xml文件-->
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

3.配置application.properties。

#数据库配置
spring.datasource.url = jdbc:mysql://127.0.0.1:3306/yc_coupon?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password = root
spring.datasource.driverClassName = com.mysql.jdbc.Driver
##指向mapper的xml文件位置
mybatis.mapper-locations=classpath:mapper/*.xml

4.在resources文件夹下添加mybatis-generator.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>

    <context id="mysql" targetRuntime="MyBatis3Simple">
        <!--去掉注释-->
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
            <property name="suppressDate" value="true" />
        </commentGenerator>
        <!--需要配置数据库连接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/yc_coupon?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false"
                        userId="root"
                        password="root"
        >
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--指定javaBean生成的位置 javaBean生成的位置-->
        <javaModelGenerator targetPackage="com.yc.coupon.entity" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--sql映射文件生成的位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!--指定dao接口生成的位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.yc.coupon.mapper" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!--table是指定每个表的生成策略-->
        <table tableName="t_business_system" domainObjectName="BusinessSystem"></table>
        <table tableName="t_coupon" domainObjectName="Coupon"></table>
        <table tableName="t_coupon_classification" domainObjectName="CouponClassification"></table>
        <table tableName="t_coupon_object" domainObjectName="CouponObject"></table>
        <table tableName="t_coupon_template" domainObjectName="CouponTemplate"></table>
        <table tableName="t_coupon_within_classification" domainObjectName="CouponWithinClassification"></table>
    </context>
</generatorConfiguration>

5.运行generator插件。IDEA页面的右边有MavenProject，打击即可打开下面的列表。

image.png

---

另外介绍另一种运行插件的方法。

image.png
image.png

启动选项里已经有了运行插件的选项。

image.png
运行插件，会自动生成entity、mapper接口、mapper.xml文件。项目目录如下。
image.png
6.接下来说一个这个插件一个巨坑。当我在测试时，只要请求数据库就会报错，报错如下
image.png

这就尴尬了，所有的代码不都是自动生成的吗，为什么会报错，是不是jar包和配置文件有问题，我内心告诉自己就是这样，所以我一遍又一遍的改pom文件中的依赖（以为是jar包版本的问题），后来又去改配置文件。。。。。。
一遍又一遍，就这样4个小时过去了，这个问题依旧没有解决。这个时候才静下心来细细地查看报错日志

image.png
终于看到了这个问题，去mapper.xml文件中一看，果然是mapper.xml出错了。有些mapper.xml文件中的接口方法会重复写两边，这就导致项目报错。把多余的删掉，再运行，终于成功了。
image.png
结语：写代码的 时候一定要心细，有些易出错的地方一定要仔细检查，即使使用插件：）