转:Mybatis Generator配置文件完整配置详解

原文:https://blog.csdn.net/leoe_/article/details/71194991



 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

resource:配置资源加载地址,使用resource,MBG从classpath开始找,比如com/myproject/generatorConfig.properties 

    url:配置资源加载地质,使用URL的方式,比如file:///C:/myfolder/generatorConfig.properties.

    注意,两个属性只能选址一个;

    另外,如果使用了mybatis-generator-maven-plugin,那么在pom.xml中定义的properties都可以直接在generatorConfig.xml中使用

-->


    location属性指明加载jar/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

-->   

        一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖

    -->                                           

        @TODO:是否可以扩展

    -->                   

        用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl;

        注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型;

    -->           

            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;

        -->               

        负责:1,key类(见context的defaultModelType);2,java类;3,查询类

        targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;

        targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录

    -->           

            自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter;

        -->                               

            是否创建一个不可变的类,如果为true,

            那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类

        -->               

            如果设置了这个根对象,那么生成的keyClass或者recordClass会继承这个类;在Table的rootClass属性中可以覆盖该选项

            注意:如果在key class或者record class中有root class相同的属性,MBG就不会重新生成这些属性了,包括:

                1,属性名相同,类型相同,有相同的getter/setter方法;

        -->                               

        注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),

            或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置

        targetPackage/targetProject:同javaModelGenerator

    -->                           

        targetPackage/targetProject:同javaModelGenerator

        type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):

            1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;

            2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;

            3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;

        注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER

    -->                           

       

        -->       

        选择的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等元素的默认属性的一个复写;

    -->                                                                           

       

        -->       

       

        -->       

       

        -->       

       

        -->       

       

        -->       

            如果选择的runtime是MyBatis3Simple,那么会生成一个SelectAll方法,如果指定了selectAllOrderByClause,那么会在该SQL中添加指定的这个order条件;

        -->                               

            如果设置了该元素,MBG会在生成的元素中生成一条正确的元素,该元素可选

            column:主键的列名;

            sqlStatement:要生成的selectKey语句,有以下可选项:

                Cloudscape:相当于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL()

                DB2      :相当于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL()

                DB2_MF    :相当于selectKey的SQL为:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1

                Derby      :相当于selectKey的SQL为:VALUES IDENTITY_VAL_LOCAL()

                HSQLDB      :相当于selectKey的SQL为:CALL IDENTITY()

                Informix  :相当于selectKey的SQL为:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1

                MySql      :相当于selectKey的SQL为:SELECT LAST_INSERT_ID()

                SqlServer :相当于selectKey的SQL为:SELECT SCOPE_IDENTITY()

                SYBASE      :相当于selectKey的SQL为:SELECT @@IDENTITY

                JDBC      :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性

       

        -->       

            该元素会在根据表中列名计算对象属性名之前先重命名列名,非常适合用于表中的列都有公用的前缀字符串的时候,

            比如列名为:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等;

            那么就可以设置searchString为"^CUST_",并使用空白替换,那么生成的Customer对象中的属性名称就不是

            custId,custName等,而是先被替换为ID,NAME,EMAIL,然后变成属性:id,name,email;

            注意,MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的,

            如果使用了columnOverride元素,该属性无效;

       

        -->       

            column:要重新设置的列名;

            注意,一个table元素中可以有多个columnOverride元素哈~

          -->                                           

           

              -->           

           

              -->           

                注意,mybatis中,不会生成到mybatis-config.xml中的typeHandler

                只会生成类似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述

           

            -->           

           

              -->               

            column:指定要忽略的列的名字;

            delimitedColumnName:参考table元素的delimitAllColumns配置,默认为false

            注意,一个table元素中可以有多个ignoreColumn元素

       

        -->   

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容