Mybatis Generator配置详解

Mybatis Generator配置详解

<?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">
<!-- 使用最新版的MBG需要使用上面的xml头,配置文件必须包含上面的DOCTYPE。-->

<!-- 配置生成器 -->
<generatorConfiguration>
<!--generatorConfiguration节点没有任何属性,直接写节点即可-->
<!--
	generatorConfiguration包含以下子元素(有严格的顺序):
	<properties> (0个或1个)
	<classPathEntry> (0个或多个)
	<context> (1个或多个)
-->

<!-- 
	properties这个元素用来指定外部的属性元素,不是必须的元素。
	元素用于指定一个需要在配置中解析使用的外部属性文件,引入属性文件后,
	可以在配置中使用 ${property}这种形式的引用,通过这种方式引用属性文件中的属性值。 
	对于后面需要配置的**jdbc信息**和targetProject属性会很有用。

	这个属性可以通过resource或者url来指定属性文件的位置,
	这两个属性只能使用其中一个来指定,同时出现会报错。

	resource:指定**classpath**下的属性文件,
	使用类似com/myproject/generatorConfig.properties这样的属性值。
	
	url:可以指定文件系统上的特定位置,
	例如file:///C:/myfolder/generatorConfig.properties
	<properties resource="" url="" />
 -->
 

  
   <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
   <!--
   		classPathEntry  
   		这个元素可以0或多个,不受限制。
		最常见的用法是通过这个属性指定驱动的路径,例如:
		<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>
		建议:由于该参数使用了绝对路径,因此不利用在不同电脑上通用,
		因此建议最好把需要的jar包放到项目的classpath下,避免每个人都得单独配置路径。
		一般在项目中使用的时候,classpath下面都有JDBC驱动,因此从项目中启动的时候不需要配置该项。
	-->
    <classPathEntry  
    location="C:\Users\mysql\mysql-connector-java\5.1.42\mysql-connector-java-5.1.6.jar"/>
   
<!-- 
    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:
    该参数可以指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。
-->
<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat" >
<!--使用MyBatis3Simple可以避免在后面的<table>中逐个进行配置(后面会提到)。-->

    <!-- 
    	autoDelimitKeywords自动识别数据库关键字,默认false,如果设置为true,
    	当表名或者字段名为SQL关键字的时候,
    	可以设置该属性为true,MBG会自动给表名或字段名添加**分隔符**。
     -->
    <property name="autoDelimitKeywords" value="false"/>
    
      <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,
      比如ORACLE就是双引号,MYSQL默认是`反引号; -->
    <property name="beginningDelimiter" value="`"/>
    <property name="endingDelimiter" value="`"/>
    
    <!-- 生成的Java文件的编码 
    	属性javaFileEncoding设置要使用的Java文件的编码,默认使用当前平台的编码,
    	只有当生产的编码需要特殊指定时才需要使用,一般用不到。-->
    <property name="javaFileEncoding" value="UTF-8"/>

	<!--最后两个javaFormatter和xmlFormatter属性“可能会”很有用,
	如果你想使用模板来定制生成的java文件和xml文件的样式,你可以通过指定这两个属性的值来实现。-->
    <!-- 格式化java代码 -->
    <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
    <!-- 格式化XML代码 -->
    <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
    
  
    
    <!-- 必须要有的,使用这个配置链接数据库 
		配置该元素只需要注意如果JDBC驱动不在**classpath**下,
		就需要通过<classPathEntry>元素引入jar包,这里**推荐**将jar包放到**classpath**下。
	-->
	<!--
		该元素有两个必选属性:
		driverClass:访问数据库的JDBC驱动程序的完全限定类名
		connectionURL:访问数据库的JDBC连接URL

		该元素还有两个可选属性:
		userId:访问数据库的用户ID
		password:访问数据库的密码
	-->
    <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
        <!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
    </jdbcConnection>
    
    <!-- java类型处理器 
        用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl;
        注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型; 
    -->
    <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
        <!-- 
            true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型
            false:默认,
                如果精度>0或者长度>18,就会使用java.math.BigDecimal
				如果精度=0并且10<=长度<=18,就会使用java.lang.Long
				如果精度=0并且5<=长度<=9,就会使用java.lang.Integer
				如果精度=0并且长度<5,就会使用java.lang.Short
         -->
         <!--
         	可以配置的属性为forceBigDecimals,
         	该属性可以控制是否强制DECIMAL和NUMERIC类型的字段转换为Java类型的java.math.BigDecimal,
         	默认值为false,一般不需要配置。
         	如果设置为true,那么一定会使用java.math.BigDecimal
         -->
        <property name="forceBigDecimals" value="false"/>
    </javaTypeResolver>
    
    
    <!-- java模型创建器,是必须要的元素
        负责:1,key类(见context的defaultModelType);2,java类;3,查询类
        该元素只有两个属性,都是必选的。
        targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;
        targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,
        				如果目录不存在,MBG不会自动建目录
        该元素用来控制生成的实体类,根据<context>中配置的defaultModelType,
        一个表可能会对应生成多个不同的实体类。
        一个表对应多个类实际上并不方便,所以前面也推荐使用flat,这种情况下一个表对应一个实体类。
     -->
    <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
        <!--  
        	该属性只对MyBatis3有效,如果true就会使用构造方法入参,
        	如果false就会使用setter方式。默认为false。
         -->
        <property name="constructorBased" value="false"/>
        
        <!-- 
        	如果true,MBG会根据catalog和schema来生成子包。
        	如果false就会直接用targetPackage属性。默认为false。
         -->
        <property name="enableSubPackages" value="true"/>
        
        <!-- for MyBatis3 / MyBatis3Simple
            该属性用来配置实体类属性是否可变,如果设置为true,
            那么constructorBased不管设置成什么,都会使用构造方法入参, 并且不会生成setter方法。
            如果为false,实体类属性就可以改变。默认为false。
         -->
        <property name="immutable" value="false"/>
        
        <!-- 设置一个根对象,
			设置所有实体类的基类。如果设置,需要使用类的全限定名称。并且如果MBG能够加载rootClass,
			那么MBG不会覆盖和父类中完全匹配的属性。匹配规则:
				属性名完全相同
				属性类型相同
				属性有getter方法
				属性有setter方法
         -->
        <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
        
        <!-- 设置是否在getter方法中,对String类型字段调用trim()方法 
			是否对数据库查询结果进行trim操作,如果设置为true就会生成类似这样
			public void setUsername(String username) {	
				this.username = username == null ? null : username.trim();
				}的setter方法。
			默认值为false。
		-->
        <property name="trimStrings" value="true"/>
    </javaModelGenerator>
    
    
    <!-- 生成SQL map的XML文件生成器,
    	该元素可选,最多配置一个。但是有如下两种必选的特殊情况:
		如果targetRuntime目标是**iBATIS2**,该元素必须配置一个。
		如果targetRuntime目标是**MyBatis3**,只有当<javaClientGenerator>需要XML时,
		该元素必须配置一个。 如果没有配置<javaClientGenerator>,则使用以下的规则:
		如果指定了一个<sqlMapGenerator>,那么MBG将只生成XML的SQL映射文件和实体类。
		如果没有指定<sqlMapGenerator>,那么MBG将只生成实体类。
		该元素只有两个属性(和前面提过的<javaModelGenerator>的属性含义一样),都是必选的。
			targetPackage:生成实体类存放的包名,一般就是放在该包下。
						实际还会受到其他配置的影响(<table>中会提到)。
			targetProject:指定目标项目路径,使用的是文件系统的绝对路径。
			
        注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),
            或者只使用Mapper接口+Annotation,所以,
            如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置
       		targetPackage/targetProject:同javaModelGenerator
		
     -->
    <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
        <!-- 该元素支持<property>子元素,只有一个可以配置的属性:
		enableSubPackages:如果true,MBG会根据catalog和schema来生成子包。
		如果false就会直接用targetPackage属性。默认为false。 
		-->
        <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>
    
    
    <!-- 如果不配置该元素,就不会生成Mapper接口。
    	type:该属性用于选择一个预定义的客户端代码(可以理解为Mapper接口)生成器,
    	用户可以自定义实现,需要继承org.mybatis.generator.codegen.AbstractJavaClientGenerator类,
    	必选有一个默认的构造方法。 该属性提供了以下预定的代码生成器,
    	首先根据<context>的targetRuntime分成三类:
		MyBatis3:
			ANNOTATEDMAPPER:基于注解的Mapper接口,不会有对应的XML映射文件
			MIXEDMAPPER:XML和注解的混合形式,(上面这种情况中的)SqlProvider注解方法会被XML替代。
			XMLMAPPER:所有的方法都在XML中,接口调用依赖XML文件。
		MyBatis3Simple:
			ANNOTATEDMAPPER:基于注解的Mapper接口,不会有对应的XML映射文件
			XMLMAPPER:所有的方法都在XML中,接口调用依赖XML文件。
			Ibatis2Java2或**Ibatis2Java5**:
		IBATIS:生成的对象符合iBATIS的DAO框架(不建议使用)。
		GENERIC-CI:生成的对象将只依赖于SqlMapClient,通过构造方法注入。
		GENERIC-SI:生成的对象将只依赖于SqlMapClient,通过setter方法注入。
		SPRING:生成的对象符合Spring的DAO接口
		
		targetPackage:生成实体类存放的包名,一般就是放在该包下。
						实际还会受到其他配置的影响(<table>中会提到)。
		targetProject:指定目标项目路径,使用的是文件系统的绝对路径。

		该元素还有一个可选属性:
		implementationPackage:如果指定了该属性,实现类就会生成在这个包中。
    -->
    <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
        <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
        <property name="enableSubPackages" value="true"/>
        
        <!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,不负责检查
        <property name="rootInterface" value=""/>
         -->
    </javaClientGenerator>
    
    <!-- 选择一个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"即可保留大小写格式;
        如要生成全部的表,可以按如下配置:
		<table tableName="%" />
        
        可选:
        1,schema:数据库的schema,可以使用SQL通配符匹配。如果设置了该值,
        			生成SQL的表名会变成如schema.tableName的形式。
        2,catalog:数据库的catalog,如果设置了该值,生成SQL的表名会变成如catalog.tableName的形式;
        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属性)
        			当catalog,schema或tableName中包含空白时,默认为true。
        15,delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来。
        			默认为false,delimitIdentifiers参考context的属性
        
        注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写;
     -->
    <table tableName="userinfo" >
        
        <!-- 参考 javaModelGenerator 的 constructorBased属性-->
        <property name="constructorBased" value="false"/>
        
        <!-- 默认为false,如果设置为true,在生成的SQL中,table名字不会加上catalog或schema; -->
        <property name="ignoreQualifiersAtRuntime" value="false"/>
        
        <!-- 参考 javaModelGenerator 的 immutable 属性 -->
        <property name="immutable" value="false"/>
        
        <!-- 指定是否只生成domain类,如果设置为true,只生成domain类,没有mapper接口
        如果还配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素
		如果为true还会覆盖属性中的enableXXX方法,将不会生成任何CRUD方法。
		 -->
        <property name="modelOnly" value="false"/>
        
        <!-- 参考 javaModelGenerator 的 rootClass 属性 
        <property name="rootClass" value=""/>
         -->
         
        <!-- 参考javaClientGenerator 的  rootInterface 属性
        <property name="rootInterface" value=""/>
        -->
        
        <!-- 如果设置了runtimeCatalog,那么在生成的SQL中,使用该指定的catalog,
        而不是table元素上的catalog 
        <property name="runtimeCatalog" value=""/>
        -->
        
        <!-- 如果设置了runtimeSchema,那么在生成的SQL中,
        使用该指定的schema,而不是table元素上的schema 
        <property name="runtimeSchema" value=""/>
        -->
        
        <!-- 如果设置了runtimeTableName,那么在生成的SQL中,
        使用该指定的tablename,而不是table元素上的tablename 
        <property name="runtimeTableName" value=""/>
        -->
        
        <!-- 注意,该属性只针对MyBatis3Simple有用;
            如果选择的runtime是MyBatis3Simple,那么会生成一个SelectAll方法,
            如果指定了selectAllOrderByClause,那么会在该SQL中添加指定的这个order条件;
         -->
        <property name="selectAllOrderByClause" value="age desc,username asc"/>
        
        <!-- 如果设置为true,生成的model类会直接使用column本身的名字,
        		而不会再使用驼峰命名方法,比如BORN_DATE,生成的属性名字就是BORN_DATE,
        		而不会是bornDate -->
        <property name="useActualColumnNames" value="false"/>
        
        
        <!-- 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=""/>
      这个元素还包含两个可选属性
		identity:当设置为true时,该列会被标记为identity列,
			并且<selectKey>元素会被插入在insert后面。
       		当设置为false时,<selectKey>会插入到insert之前(通常是序列)。
       		**重要**: 即使您type属性指定为post,您仍然需要为identity列将该参数设置为true。 
       		这将标志MBG从插入列表中删除该列。默认值是false。
       
       type:type=post and identity=true的时候生成的<selectKey>中的order=AFTER,
			当type=pre的时候,identity只能为false,生成的<selectKey>中的order=BEFORE。
			可以这么理解,自动增长的列只有插入到数据库后才能得到ID,所以是AFTER,使用序列时,
			只有先获取序列之后,才能插入数据库,所以是BEFORE。
         -->
        
        <!-- 
            该元素会在根据表中列名计算对象属性名之前先重命名列名,
            非常适合用于表中的列都有公用的前缀字符串的时候,
            比如列名为: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=""/>
         -->
         
         
         <!-- 用来修改表中某个列的属性,MBG会使用修改后的列来生成domain的属性;
            column:要重新设置的列名;
            注意,一个table元素中可以有多个columnOverride元素哈~
          -->
         <columnOverride column="username">
            <!-- 使用property属性来指定列要生成的属性名称 -->
            <property name="property" value="userName"/>
            
            <!-- javaType用于指定生成的domain的属性类型,使用类型的全限定名
            <property name="javaType" value=""/>
             -->
             
            <!-- jdbcType用于指定该列的JDBC类型 
            <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=""/>
             -->
         </columnOverride>
         
         <!-- ignoreColumn设置一个MGB忽略的列,如果设置了改列,那么在生成的domain中,生成的SQL中,都不会有该列出现 
            column:指定要忽略的列的名字;
            delimitedColumnName:参考table元素的delimitAllColumns配置,默认为false
            
            注意,一个table元素中可以有多个ignoreColumn元素
         <ignoreColumn column="deptId" delimitedColumnName=""/>
         -->
    </table>
    
</context>

</generatorConfiguration>

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值