(9)使用mybatis generator自动生成代码

使用mybatis generator自动生成代码

使用mybatis generator可以帮助我们根据数据库表信息自动生成model层、dao层的代码以及mapper映射文件，使用方式有多种，这里以maven为例进行介绍。

添加依赖

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.h3c</groupId>
    <artifactId>learnmybatis</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <!---mybatis的依赖jar包->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--添加mybatis自动代码生成器插件依赖-->
        <dependency>
	        <groupId>org.mybatis.generator</groupId>
	        <artifactId>mybatis-generator-maven-plugin</artifactId>
	        <version>1.3.5</version>
    	</dependency>
        <!--mysql的数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>
        <!--用于在控制台打印出sql信息-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

    <build>
		<!--若*Mapper.xml不放在src/main/resources目录下，需要添加如下配置，否则maven是
		不会将该xml文件发布到编译后的classes目录下，这样就会导致mybatis到不到该文件。
		-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
        <!--添加generator插件-->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <executions>
                <execution>
                    <id>Generate MyBatis Artifacts</id>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.19</version>
                </dependency>
            </dependencies>
            <configuration>
                <!--配置文件的路径-->
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
            </configuration>
        </plugin>        
    </build>
</project>

在resources目录下创建generatorConfig.xml配置文件

其他配置文件，如log4j.properties、db.properties、mybatis.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>
    <!--如果不需要生成example的话将targetRuntime设置为MyBatis3Simple即可-->
    <context id="test" targetRuntime="MyBatis3">

        <commentGenerator>
            <!-- 生成的注释是否包含生成的时间，一般设置为true，不生成时间 -->
            <property name="suppressDate" value="true" />
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <!--数据库链接URL，用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/learnmybatis?serverTimezone=Asia/Shanghai" 
                        userId="root"
                        password="123456">
        </jdbcConnection>
        <javaTypeResolver>
        	<!--jdbc对应的日期类型转成java8中对应的LocalDateTime类型-->
        	<property name="useJSR310Types" value="true"/>
            <!-- 是否将数据库中的decimal类型转换为java的BigDecimal类型 -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
        <!-- 生成model模型的包名和位置 -->
        <javaModelGenerator targetPackage="com.h3c.bean"
                            targetProject="你项目的路径（不包括盘符）\src\main\java">
            <!--添加数据库中带的schema-->
            <property name="enableSubPackages" value="true" />
            <!--去除从数据库中读取的字段中的空格-->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- 生成mapper映射文件的包名和位置 -->
        <sqlMapGenerator targetPackage="com.h3c.dao"
                         targetProject="你项目的路径（不包括盘符）\src\main\java">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
        <!-- 生成DAO的包名和位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.h3c.dao"
                             targetProject="\my-workspace-idea\learnmybatis\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 要生成哪些表 -->
        <table schema="root" tableName="t_user" domainObjectName="User"></table>
    </context>
</generatorConfiguration>

执行mvn mybatis-generator:generate命令

命令若执行成功会在bean目录下生成User.java类文件，在dao目录下生成UserMapper.java和UserMapper.xml文件

这里有几点需要注意的问题：

• 若上述生成的文件已经存在，再次执行mybatis-generator:generate命令时需要先删除UserMapper.xml文件，因为重新生成时，xml文件的内容不被覆盖而是进行内容追加，其他文件无此问题。
• UserMapper.xml文件中可能会生成重复的增删给查代码，手动删除就好。