MyBatis逆向工程——MyBatis Generator (MBG)-配置文件详解（2）

最新推荐文章于 2025-02-10 21:11:41 发布

星_陨

最新推荐文章于 2025-02-10 21:11:41 发布

阅读量812

点赞数 1

分类专栏： MyBatis系列文章标签： MyBatis MBG

MyBatis系列专栏收录该内容

17 篇文章

订阅专栏

本文详细介绍了MyBatis Generator的配置文件各项设置，包括context、属性配置、javaTypeResolver、javaModelGenerator等元素，以及如何通过配置生成符合需求的Java模型和SQL映射文件。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

转载地址：Mybatis Generator（简称MBG）的最完整配置文件

其他注意点：

（一）<context>元素

用于指定生成一组对象的环境

（1）targetRuntime：用于指定生成的代码的运行时目标

MyBatis3：默认值豪华版

MyBatis3Simple：简单版的CRUD

（二）属性

 <!-- 自动识别数据库关键字，默认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="`"/>

（三）<javaTypeResolver>元素

用于指定MyBatis Generator是否应强制使用java.math.BigDecimal作为DECIMAL和NUMERIC字段，而不是在可能的情况下替换整型

<javaTypeResolver >
			<property
				name="forceBigDecimals"
				value="true" />
		</javaTypeResolver>

true：如果数据库列的类型为DECIMAL或NUMERIC，则Java类型解析器将始终使用java.math.BigDecimal。

false：默认值。替代规则如下：

如果比例大于零，或者长度大于18，则将使用java.math.BigDecimal类型如果比例为零，长度为10到18，那么Java类型解析器将替代java.lang.Long。如果比例为零，长度为5到9，那么Java类型解析器将替代java.lang.Integer。如果比例为零，并且长度小于5，那么Java类型解析器将替代java.lang.Short。

（四）<javaModelGenerator>元素

java模型生成器

（1）targetPackage：生成的类将被放置的包

（2）targetProject：为生成的对象指定目标项目，即类的路径。一般为 .\src 。maven下为.\src\main\java。

最终文件路径wetargetProjecttargetPackage

（3）其他子标签

<javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
        <!--  for MyBatis3/MyBatis3Simple
            自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；
         -->
        <property name="constructorBased" value="false"/>

        <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
        <property name="enableSubPackages" value="true"/>

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

        <!-- 设置一个根对象，
            如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
            注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
                1，属性名相同，类型相同，有相同的getter/setter方法；
         -->
        <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>

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

（五）<sqlMapGenerator>元素

用于定义SQL映射生成器的属性

targetPackage和targetProject属性类似于<javaModelGenerator>元素

注意点：若mapper.xml文件位于WEB-INF/mapper文件夹中。targetPackage="WebContent.WEB-INF.mapper"

（五）<javaClientGenerator>元素

用于定义Java客户端生成器的属性。DAO层接口java类

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

targetPackage和targetProject属性类似于<javaModelGenerator>元素

（六）<table>元素

用于在数据库中选择一个用于内省的表

（1）tableName 数据库中的表名称

（2）domainObjectName 生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字

（3）其他属性

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

（4） < columnOverride>元素作为table的子元素

用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性

<columnOverride column="username">
	<!-- 使用property属性来指定列要生成的属性名称 -->
	<property name="property" value="userName"/>

	<!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名java.lang.Object
	<property name="javaType" value=""/>
	-->

	<!-- jdbcType用于指定该列的JDBC类型 VARCHAR
	<property name="jdbcType" value=""/>
	-->

	<!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名
	注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler
	只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述
	<property name="jdbcType" value=""/>
	-->

	<!-- 参考table元素的delimitAllColumns配置，默认为false
	<property name="delimitedColumnName" value=""/>
	-->

（5）<ignoreColumn>元素用于告知MyBatis生成器（MBG）忽略内省表中的列

delimitedColumnName 如果为true，那么当与数据库中的返回列进行匹配时，MBG将执行区分大小写的完全匹配。如果为 false（默认），则该名称被认为不区分大小写。

<ignoreColumn column="deptId" delimitedColumnName=""/>

（6）<generatedKey>用于生成生成主键的方法

如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选
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属性

 <generatedKey column="" sqlStatement=""/>

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

比如列名为：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元素，该属性无效；

<columnRenamingRule searchString="" replaceString=""/>

（七）<commentGenerator>元素

<commentGenerator>
	<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
	<property
		name="suppressAllComments"
		value="true" />
</commentGenerator>

（ 1）suppressAllComments 用于指定MBG是否将在生成的代码中包含任何注释默认false

（2）suppressDate 用于指定MBG是否在生成的注释中包含生成时间戳。默认false

（3）addRemarkComments 用于指定MBG是否在生成的注释中包含数据库表中的表和列注释默认false

（4）dateFormat日期写入生成的注释时使用的日期格式字符串