MyBatis Generator 教程

官网 http://mybatis.org/generator/quickstart.html

Mybatis可以通过逆向工程，实现自动生成xml文件、dao接口、实体类

以下使用的是Intellij Idea进行自动生成

一、首先，要在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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>spring-boot-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--  此处忽略其他依赖  -->
    </dependencies>
<!--  在build中加入以下插件  -->
    <build>
            <finalName>zsxt</finalName>
            <plugins>
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.2</version>
                    <configuration>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                </plugin>
            </plugins>
    </build>


</project>

二、接着，在resources包下面添加generator.properties和generatorConfig.xml

项目结构如下图所示：

generator.properties

#数据库驱动jar包地址
jdbc.driverLocation=C:\\Users\\lenovo\\.m2\\repository\\mysql\\mysql-connector-java\\5.1.30\\mysql-connector-java-5.1.30.jar
jdbc.driverClass=com.mysql.jdbc.Driver
#数据库名及账号密码
jdbc.connectionURL=jdbc:mysql://localhost/test
jdbc.userId=root
jdbc.password=root

注意：驱动路径不要有中文。。不然会报错：java.lang.RuntimeException: Cannot resolve classpath entry

2.generatorConfig.xml

将以下的targetPackage对应的包名替换为自己的项目对应的包名。其中的"com.example.demo.model"表示的是实体类所在的包。

不存在的文件自行创建，或者文件名不同的自行修改，比如dao文件名改为mapper或者mapping这些。

再将tableName替换为数据表名，domainObjectName表示的是将要生成的实体类名

如下示：

<?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>
<!--导入属性配置-->
<properties resource="generator.properties"></properties>

<!--指定特定数据库的jdbc驱动jar包的位置-->
<classPathEntry location="${jdbc.driverLocation}"/>

<context id="default" targetRuntime="MyBatis3">

    <!-- 注释 -->
    <commentGenerator>
        <property name="suppressAllComments" value="true" /><!-- 是否取消注释 -->
        <!-- <property name="suppressDate" value="true" />  是否生成注释代时间戳 -->
    </commentGenerator>

    <!--jdbc的数据库连接 -->
    <jdbcConnection
            driverClass="${jdbc.driverClass}"
            connectionURL="${jdbc.connectionURL}"
            userId="${jdbc.userId}"
            password="${jdbc.password}">
    </jdbcConnection>


    <!-- 非必需，类型处理器，在数据库类型和java类型之间的转换控制-->
    <javaTypeResolver>
        <property name="forceBigDecimals" value="false"/>
    </javaTypeResolver>


    <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
        targetPackage     指定生成的model生成所在的包名
        targetProject     指定在该项目下所在的路径
    -->
    <javaModelGenerator targetPackage="com.example.demo.model"
                        targetProject="src/main/java">

        <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
        <property name="enableSubPackages" value="false"/>
        <!-- 是否对model添加 构造函数 -->
        <property name="constructorBased" value="true"/>
        <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
        <property name="trimStrings" value="true"/>
        <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
        <property name="immutable" value="false"/>
    </javaModelGenerator>

    <!--在resources目录下的mapper文件，生成数据库的表对应的xml文件 -->
    <sqlMapGenerator targetPackage="mapper"
                     targetProject="src/main/resources">
        <property name="enableSubPackages" value="false"/>
    </sqlMapGenerator>

    <!-- 生成dao层的java代码
            type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
            type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
            type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
    -->
    <javaClientGenerator targetPackage="com.example.demo.dao"
                         targetProject="src/main/java" type="XMLMAPPER">
        <property name="enableSubPackages" value="false"/>
    </javaClientGenerator>

   <!-- 数据表名及实体类名称  -->
    <table tableName="admin_menu" domainObjectName="AdminMenu"
               enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true"
               selectByExampleQueryId="true">
        </table>
 
</context>
</generatorConfiguration>

三、添加maven并运行命令

在界面最上方的导航栏，点击 Run -->Edit Configuration—> 点击+号 -->选择Maven–> 输入命令 mybatis-generator:generate -e

如下图示：

保存完后，选中设置的maven，点击并运行，如下示：

如果报错：RuntimeException:Cannot resolve classpath entry: \src\main\resources\

可以尝试将pom.xml文件下对应的报错的暂时注释掉。

<!--            <resource>               -->
<!--                <directory>src/main/resources/${package.environment}</directory>-->
<!--                 <targetPath>WEB-INF/classes</targetPath> -->
<!--                <filtering>true</filtering>-->
<!--            </resource>-->

注意

1，重新生成前，要把原来的删干净

2，Mapper类上面记得加上@Mapper