generatorConfig 配置注释详解

<?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/generator.properties" />

    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
    <classPathEntry location="${mysql_driver_path}"/>

    <!--
    context:生成一组对象的环境
    id:必选,上下文id,用于在生成错误时提示
    defaultModelType:指定生成对象的样式  分层-  双主键 defaultModelType="hierarchical"
        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:类全限定名,用于扩展MBGc -->

    <!--   targetRuntime:MyBatis3Simple MyBatis3 -->
    <context id="DB2Tables" targetRuntime="${targetRuntime}">
        <commentGenerator>

            <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
                            一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
            <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="`" />

            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true:是 : false:否 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 是否  自动为每一个生成的类创建一个构造方法-->
            <property name="constructorBased" value="false"/>

        </commentGenerator>

        <!--数据库链接URL,用户名、密码 -->
        <jdbcConnection  driverClass="${jdbc_driver}"  connectionURL="${jdbc_url}" userId="${jdbc_username}" password="${jdbc_password}">
            <!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>

        <!-- java类型处理器 用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl;
                        注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和NUMERIC数据类型;    -->
        <javaTypeResolver>
            <!-- true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型 false:默认, scale>0;length>18:使用BigDecimal;
                scale=0;length[10,18]:使用Long; scale=0;length[5,9]:使用Integer; scale=0;length<5:使用Short; -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>



        <!-- java模型创建器,是必须要的元素 负责:1,key类(见context的defaultModelType);2,java类;3,查询类
          targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制; targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录 -->
        <javaModelGenerator targetPackage="${targetPackageEntity}" targetProject="${targetProjectEntity}">
            <!-- for MyBatis3/MyBatis3Simple 自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter; -->
            <!-- <property name="constructorBased" value="false" /> -->

            <!-- for MyBatis3 / MyBatis3Simple 是否创建一个不可变的类,如果为true, 那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类 -->
            <!-- <property name="immutable" value="true" /> -->
            <property name="enableSubPackages" value="true"/>

            <!-- 设置是否在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="${targetPackageMapperXml}" targetProject="${targetProjectXml}">
            <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 生成DAO的包名和位置 客户端代码,生成易于使用的针对Model对象和XML配置文件 的代码
               type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
               type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
               type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口               -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="${targetPackageDao}" targetProject="${targetProjectDao}">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>


        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
        <!-- 参考 javaModelGenerator 的 constructorBased属性 -->
        <!-- property name="constructorBased" value="false"  generatedKey column="id" sqlStatement="JDBC" -->
        <!-- mapperName="{0}Dao" 插件实现修改名字 [后期优化 需要了解原理 ] -->
        <!-- 选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素
             选择的table会生成一下文件:
             1,SQL map文件
             2,生成一个主键类;
             3,除了BLOB和主键的其他字段的类;
             4,包含BLOB的类;
             5,一个用户生成动态查询的条件类(selectByExample, deleteByExample),可选;
             6,Mapper接口(可选)

             tableName(必要):要生成对象的表名;
             注意:大小写敏感问题。正常情况下,MBG会自动的去识别数据库标识符的大小写敏感度,在一般情况下,MBG会
                 根据设置的schema,catalog或tablename去查询数据表,按照下面的流程:
                 1,如果schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询;
                 2,否则,如果数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找;
                 3,否则,如果数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找;
                 4,否则,使用指定的大小写格式查询;
             另外的,如果在创建表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种情况下也会使用给定的大小写来创建表名;
             这个时候,请设置delimitIdentifiers="true"即可保留大小写格式;

             可选:
             1,schema:数据库的schema;
             2,catalog:数据库的catalog;
             3,alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName
             4,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;
             5,enableInsert(默认true):指定是否生成insert语句;
             6,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);
             7,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;
             8,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);
             9,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);
             10,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;
             11,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);
             12,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);
             13,modelType:参考context元素的defaultModelType,相当于覆盖;
             14,delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,如果类似MYSQL这样的数据库,使用的是`(反引号,那么还需要设置context的beginningDelimiter和endingDelimiter属性)
             15,delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false,delimitIdentifiers参考context的属性

           注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写;
        -->
        <table tableName="test"  domainObjectName="Test"
               enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true"
               enableSelectByExample="true" selectByExampleQueryId="true">
        </table>


        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
        <!--<table tableName="vlpr_realtime_picture_task" domainObjectName="VlprRealtimePictureTask" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="area" domainObjectName="Area" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="camera" domainObjectName="Camera" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="datasource" domainObjectName="Datasource" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="user" domainObjectName="User" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="vlpr_result_ymd" domainObjectName="VlprResultYmd" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>

        <table tableName="vlpr_task" domainObjectName="VlprTask" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>
        <table tableName="sys_log" domainObjectName="SysLog" enableCountByExample="true" enableUpdateByExample="true"
               enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"></table>
       -->

    </context>
</generatorConfiguration>

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值