MyBatis Generator 学习说明配置

时间 2019-11-10

标签 mybatis generator 学习说明配置栏目 MyBatis 繁體版

原文原文链接

eclipse 里面使用maven 生成，命令： 工程右键 Debug As -> maven build... -> mybatis-generator:generatehtml

http://blog.csdn.net/u011310774/article/details/48269031java

使用这个能够快速自动生成 model和xml 文件的和接口类，方便而又快速。mysql

官方中文文档：sql

http://mbg.cndocs.tk/quickstart.html 数据库

http://www.cnblogs.com/GaiDynasty/p/4088531.htmlapi

MyBatis Generator最佳实践

本节内容针对MyBatis3，使用iBATIS的不必定适用。mybatis

如下根据我的经验（对此有意见的能够留言）对一些配置见解列出以下几点：app

关于实体类的modelType，建议使用defaultModelType="flat"，只有一个对象的状况下管理毕竟方便，使用也简单。dom
关于注释<commentGenerator>，无论你是否要重写本身的注释生成器，有一点不能忘记，那就是注释中必定要保留@mbggenerated,MBG经过该字符串来判断代码是否为代码生成器生成的代码，有该标记的的代码在从新生成的时候会被删除，不会重复。不会在XML中出现重复元素。eclipse
使用MBG生成的代码时，建议尽量不要去修改自动生成的代码，并且要生成带有@mbggenerated，这样才不会在每次从新生成代码的时候须要手动修改好多内容。
仍然是注释相关，在<commentGenerator>中，建议必定要保留suppressAllComments属性(使用默认值false)，必定要取消(设为true)时间戳suppressDate，避免重复提交SVN。
<jdbcConnection>建议将JDBC驱动放到项目的**classpath**下，而不是使用<classPathEntry>来引入jar包，主要考虑到全部开发人员的统一性。
当数据库字段使用CHAR时，建议在<javaModelGenerator>中设置<property name="trimStrings" value="true" />，能够自动去掉没必要要的空格。
在<javaClientGenerator>中，建议设置type="XMLMAPPER",不建议使用注解或混合模式，比较代码和SQL彻底分离易于维护。
建议尽量在<table>中配置<generatedKey>，避免手工操做，以便于MBG重复执行代码生成。

这里用的通配符匹配所有的表，另外全部表都有自动增加的id字段。若是不是全部表的配置都同样，能够作针对性的配置。

Mybatis generator 自动生成代码时，insert如何返回主键值

地址： http://blog.csdn.net/xyw591238/article/details/51588630

和地址： http://blog.csdn.net/s1146896025/article/details/50434578

若是要让generator自动添加该功能，能够以下配置：


<table schema="" tableName="ACT_SecurityBlockLog" domainObjectName="BlockLog"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
<property name="useActualColumnNames" value="true"/>
<generatedKey column="id" sqlStatement="MySql" identity="true"/>

</table>

或者手动增长：

主键值有对象.getId()得到

方法只返回成功影响的行数：1

在insert里面加入selectKey标签就能够了. 通常都是返回的int类型.对应数据库是自增加字段.

要注意的是: ibatis会直接返回int值. Mybatis则把int值包装在参数对象里面.

public int insert(User user) {

//ibatis方式.

int result = UserMapper.insert(user);

return result;

//Mybatis方式

user = UserMapper.insert(user);

return user.getId();

}

还要注意的是数据库类型不同,生成ID的策略也不同. 能够对selectKey添加属性(名字忘记了), pre---先生成ID. post---后生成ID. default是post.

MyBatis Generator配置文件context元素的defaultModelType属性

December 30, 2013 Database Java openwares

MyBatis Generator配置文件context元素有一个defaultModelType属性,这个属性的值会影响实体类(或叫domain类,model类)的生成。

这个属性用于设置产生的模型类型。模型类型定义了MBG如何去产生模型类。对于一些模型类型,MBG会为每一张表产生单独的实体类,而其余的模型类型,MBG会依据表的结构产生一些不一样的实体类。
这个属性支持如下三个值:

这是默认值
这个模型与hierarchical模型类似,除了若是一个实体类只包含一个字段,则不会单独生成此实体类。所以,若是一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

该模型为每一张表只生成一个实体类。这个实体类包含表中的全部字段。通常使用这个模型就够了。

若是表有主键,那么该模型会产生一个单独的主键实体类,若是表还有BLOB字段，则会为表生成一个包含全部BLOB字段的单独的实体类,而后为全部其余的字段生成一个单独的实体类。MBG会在全部生成的实体类之间维护一个继承关系。
显然这个模型比较复杂。

conditional
这是默认值
这个模型与hierarchical模型类似,除了若是一个实体类只包含一个字段,则不会单独生成此实体类。所以,若是一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中
flat
该模型为每一张表只生成一个实体类。这个实体类包含表中的全部字段。通常使用这个模型就够了。
hierarchical
若是表有主键,那么该模型会产生一个单独的主键实体类,若是表还有BLOB字段，则会为表生成一个包含全部BLOB字段的单独的实体类,而后为全部其余的字段生成一个单独的实体类。MBG会在全部生成的实体类之间维护一个继承关系。
显然这个模型比较复杂。

更加详细的说明： http://blog.csdn.net/zsq520520/article/details/50952830

<!-- 能够用于加载配置项或者配置文件，在整个配置文件中就可使用${propertyKey}的方式来引用配置项

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

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

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

另外，若是使用了mybatis-generator-maven-plugin，那么在pom.xml中定义的properties均可以直接在generatorConfig.xml中使用

<!--
    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
-->

<contextid="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
    
    <propertyname="autoDelimitKeywords" value="false"/>


<propertyname="javaFileEncoding" value="UTF-8"/>


<propertyname="javaFormatter"value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>


<propertyname="xmlFormatter"value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>


<propertyname="beginningDelimiter" value="`"/>

<propertyname="endingDelimiter" value="`"/>

<javaTypeResolvertype="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
        
        <propertyname="forceBigDecimals" value="false"/>
    </javaTypeResolver>

<javaModelGeneratortargetPackage="com._520it.mybatis.domain"targetProject="src/main/java">
        
        <propertyname="constructorBased" value="false"/>
        

<propertyname="enableSubPackages" value="true"/>

<propertyname="immutable" value="false"/>

<propertyname="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>


        <propertyname="trimStrings" value="true"/>
    </javaModelGenerator>


<propertyname="trimStrings" value="true"/>
</javaModelGenerator>

<sqlMapGeneratortargetPackage="com._520it.mybatis.mapper"targetProject="src/main/resources">
        
        <propertyname="enableSubPackages" value="true"/>
    </sqlMapGenerator>

<javaClientGeneratortargetPackage="com._520it.mybatis.mapper"type="ANNOTATEDMAPPER" targetProject="src/main/java">
        
        <propertyname="enableSubPackages" value="true"/>
        <!-- 能够为全部生成的接口添加一个父接口，可是MBG只负责生成，不负责检查
        <propertyname="rootInterface" value=""/>

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

<tabletableName="userinfo" >
        
        <propertyname="constructorBased" value="false"/>
        
        <propertyname="ignoreQualifiersAtRuntime" value="false"/>
        
        <propertyname="immutable" value="false"/>
        
        <propertyname="modelOnly" value="false"/>
        <!-- 参考 javaModelGenerator 的 rootClass 属性
        <propertyname="rootClass" value=""/>

更多内容在这里： http://blog.csdn.net/zsq520520/article/details/50952830