首页 > 技术文章 > 使用generatorConfig自动生成实体类与dao的接口以及mappers映射文件

zhouyon 2018-11-11 15:52 原文

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>
    <!--jdbc 驱动包,等-->
    <!--<classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />-->

    <!--
    context:生成一组对象的环境
    id:必选,上下文id,用于在生成错误时提示
    defaultModelType:指定生成对象的样式
        1,conditional:类似hierarchical;
        2,flat:所有内容(主键,blob)等全部生成在一个对象中;
        3,hierarchical:主键生成一个XXKey对象(key class),Blob等单独生成一个对象,其他简单属性在一个对象中(record class)
    targetRuntime:
        1,MyBatis3:默认的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample;
        2,MyBatis3Simple:类似MyBatis3,只是不生成XXXBySample;
    introspectedColumnImpl:类全限定名,用于扩展MBG
-->
    <context id="mysql" targetRuntime="MyBatis3Simple">


        <!-- 注释生成器 -->
        <!--commentGenerator还可以配置一个type,设置自己的注解生成器,
        默认使用的是org.mybatis.generator.internal.DefaultCommentGenerator;-->
        <commentGenerator>
            <!--去掉生成日期那行注释-->
            <property name="suppressDate" value="true"/>
            <!--去掉所有的注解-->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!-- 当表名或者字段名为SQL关键字的时候,默认为false,
        可以设置该属性为true,MBG会自动给表名或字段名添加**分隔符** -->
        <property name="autoDelimitKeywords" value="false"/>

         <!-- 生成的Java文件的编码-->
        <property name="javaFileEncoding" value="UTF-8"/>

           <!-- 格式化java代码-->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

           <!-- 格式化XML代码-->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

           <!--beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,
            比如ORACLE就是双引号,MYSQL默认是`反引号; -->
        <property name="beginningDelimiter" value="`"/> 
        <property name="endingDelimiter" value="`"/>

        <!--配置链接数据库-->
        <jdbcConnection driverClass="org.mariadb.jdbc.Driver"
                        connectionURL="jdbc:mariadb://localhost/EmployeeDB"
                        userId="root"
                        password="123456">
        </jdbcConnection>

        <!-- java模型创建器,是必须要的元素
        负责:1,key类(见context的defaultModelType);2,java类;3,查询类
        targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;
        targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,
        如果目录不存在,MBG不会自动建目录
        -->
        <javaModelGenerator targetPackage="com.nf147.emp.entity" targetProject="src/main/java">

            <!-- 设置是否在getter方法中,对String类型字段调用trim()方法-->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成SQL map的XML文件生成器, 注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),
            或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置
            targetPackage/targetProject:同javaModelGenerator -->
        <sqlMapGenerator targetPackage="mappers" targetProject="src/main/resources">
        </sqlMapGenerator>

        <!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口 targetPackage/targetProject:
        同javaModelGeneratortype:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
             1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;
             2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;
             3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;
             注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.nf147.emp.dao" targetProject="src/main/java">
            <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
              <property name="enableSubPackages" value="true" />
            <!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,
            不负责检查 <property name="rootInterface"value=""/> -->
        </javaClientGenerator>
        <!-- 要映射的表名 -->
        <table tableName="%">

            <!-- 如果设置为true,生成的model类会直接使用column本身的名字,
            而不会再使用驼峰命名方法,比如BORN_DATE,
            生成的属性名字就是BORN_DATE,而不会是bornDate -->
            <property name="useActualColumnNames" value="true"/>
        </table>
    </context>
</generatorConfiguration>

pom.xml
<plugins>
      <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.7</version>
        <dependencies>
          <dependency>
            <groupId>org.mariadb.jdbc</groupId>
            <artifactId>mariadb-java-client</artifactId>
            <version>2.3.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>

 

 

运行即可生成

 

 


推荐阅读