SpringBoot学习03--使用MyBatis的Generator生成代码

上一篇 SpringBoot学习02–整合MyBatis（基于xml），简单的整合了MyBatis。不过其中的 dao、model、mappers 文件都是手写的，如果数据库表多的情况下，写这些文件比较麻烦。MyBatis提供了 Generator工具方便我们动态生成这些文件。

下面是具体的步骤

1. 修改pom.xml文件

主要修改pom.xml中的build节点，代码如下

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
		</plugin>
		<!-- mybatis generator 自动生成代码插件 -->
		<plugin>
			<groupId>org.mybatis.generator</groupId>
			<artifactId>mybatis-generator-maven-plugin</artifactId>
			<version>1.3.5</version>
			<dependencies>
				<dependency>
					<groupId>org.mybatis.generator</groupId>
					<artifactId>mybatis-generator-core</artifactId>
					<version>1.3.5</version>
				</dependency>
				<dependency>
					<groupId>mysql</groupId>
					<artifactId>mysql-connector-java</artifactId>
					<version>8.0.16</version>
				</dependency>
			</dependencies>
			<executions>
				<execution>
					<id>mybatis.generator</id>
					<phase>package</phase>
					<goals>
						<goal>generate</goal>
					</goals>
				</execution>
			</executions>
			<configuration>
				<!-- 允许移动生成的文件 -->
				<verbose>true</verbose>
				<!-- 允许自动覆盖文件 -->
				<overwrite>true</overwrite>
				<configurationFile>
					src/main/resources/mybatis-generator.xml
				</configurationFile>
			</configuration>
		</plugin>
	</plugins>
</build>

2. 新增 mybatis-generator.xml文件

在 src/main/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="MySQLTables" targetRuntime="MyBatis3">
        <!-- 生成的pojo，将implements Serializable-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>

        <!-- 数据库链接URL、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/demo?serverTimezone=UTC"
                        userId="root"
                        password="admin123">
        </jdbcConnection>

        <!--
        默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer
            true，把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal
        -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!--
        生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，
        也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下
        -->
        <!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN">-->
        <javaModelGenerator targetPackage="com.example.demo.model" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
            <!-- 从数据库返回的值被清理前后的空格  -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--对应的mapper.xml文件  -->
        <sqlMapGenerator targetPackage="mappers" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 对应的Mapper接口类文件 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.dao" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>


        <!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
        <table tableName="tb_account" domainObjectName="Account"
               enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" selectByExampleQueryId="false" >
            <property name="useActualColumnNames" value="false"/>
        </table>
    </context>
</generatorConfiguration>

3. 执行

点击菜单 Run->Edit Configurations...

选择 + -> Maven

Command line 输入 mybatis-generator:generate，输入Name后点击 ok

最后点击菜单 Run -> Run mybatis-generator

执行后会显示控制台会显示如下信息，表示生成成功。

至此，我们会看到相应的目录下都动态生成了相应的文件（Service包下的文件不是生成的）。

注意： 生成的AccountMapper文件是不会带 @Repository或@Mapper注解的，在IDEA中，不带 @Repository注解时，使用 @Autowired注入时，会显示如下的提示，看得比较别扭（虽然不会影响代码运行），我们可以手动加上@Repository注解