MyBatis逆向工程记录【IDEA + MySQL8.0.19】

最近在B站学习尚硅谷的尚筹网项目，其中用到了MyBatis逆向工程，看着视频里很简单，跟着一步步做就出了Bug，第一时间想到了数据库版本问题，于是写篇博客记录下。

MyBatis逆向工程

1、pom.xml编写

首先新建一个Maven项目，在其pom文件中加入MyBatis依赖，并且加入逆向工程所需要的插件和相关依赖【JDBC】，这里JDBC的版本根据所使用的MySQL版本来选择。

<!-- 依赖 MyBatis 核心包 -->
<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.4</version>
    </dependency>
</dependencies>
<!-- 控制 Maven 在构建过程中相关配置 -->
<build>
    <!-- 构建过程中用到的插件 -->
    <plugins>
        <!-- 具体插件，逆向工程的操作是以构建过程中插件形式出现的 -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
            <configuration>
                <configurationFile>
                    <!-- 这里是配置generatorConfig.xml的路径，这里空着不写表示默认在resources目录下找generatorConfig.xml文件 -->
                </configurationFile>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.19</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

2、generatorConfig.xml编写

在Maven项目的resources文件夹下新建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>
    <!-- context 是逆向工程的主要配置信息 -->
    <!-- id：配置名称 -->
    <!-- targetRuntime：设置生成的文件的 mybatis 版本 -->
    <context id="default" targetRuntime="MyBatis3">
    
        <!-- optional, 旨在创建class时，对注释进行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>

        <!--jdbc的数据库连接，以下为MySQL版本8以上的JDBC驱动-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/project_crowd?serverTimezone=UTC"
                        userId="root"
                        password="password">
        </jdbcConnection>

        <!--非必须，类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <!-- 默认情况下数据库中的 decimal，bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
            <!-- 不是 double 和 long 类型 -->
            <!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- targetPackage：生成的实体类所在的包 -->
        <!-- targetProject：生成的实体类所在的位置 -->
        <javaModelGenerator targetPackage="com.alageek.entity" targetProject="src/main/java">
            <!-- 是否允许子包 -->
            <property name="enableSubPackages" value="false" />
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true" />
            <!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
            <property name="trimStrings" value="true" />
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false" />
        </javaModelGenerator>

        <!-- targetPackage 和 targetProject：生成的 mapper 文件的包和位置 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <!-- 针对数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- targetPackage 和 targetProject：生成的 interface 文件的包和位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.alageek.dao" targetProject="src/main/java">
            <!-- 针对 oracle 数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
		<!-- 需要映射的表，以及对应的实体类名 -->
        <table tableName="t_admin" domainObjectName="Admin"></table>
    </context>
</generatorConfiguration>

在写这个配置文件的时候遇到个问题，就是下面这句话中最后以dtd结尾的链接爆红了：

<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

经过查资料，发现这不是错误，只需要在idea中进行相关配置即可，首先File->Settings打开配置页面，如下：

根据图中提示，点击加号按钮，在弹出的框中将爆红的链接填入，再点击OK，保存配置即可。

3、启动逆向工程

使用IDEA的Maven插件，选择要逆向工程的项目，如图双击。

双击后就会生成对应文件，如图：

笔者的话

这篇博客是博主为了避免下次要用到逆向工程的时候还要百度所写，所以写的比较简略，大部分配置的意思都在注释里了，如果有看不懂的可以在评论里问，也可以换篇博客看，嘿嘿🤭