重新学习MyBatis-逆向工程

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE generatorConfiguration
 3   PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 4   "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
 5 
 6 <generatorConfiguration>
 7 
 8     <!-- context 运行上下文 -->
 9     <!-- id 必唯一 -->
10     <!-- defaultModelType:可选;flat:所有内容（主键，blob）等全部生成在一个对象中 -->
11     <!-- targetRuntime:可选 ;建议:MyBatis3Simple/MyBatis3 -->
12     <context id="MySqlTables" defaultModelType="flat"
13         targetRuntime="MyBatis3">
14 
15         <!--beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号 -->
16         <!--如ORACLE就是双引号；MYSQL默认是`反引号； -->
17         <property name="beginningDelimiter" value="`" />
18         <property name="endingDelimiter" value="`" />
19 
20         <!-- 指定生成的java文件的编码,没有直接生成到项目时中文可能会乱码 -->
21         <property name="javaFileEncoding" value="UTF-8" />
22 
23         <!-- 格式化java代码 -->
24         <property name="javaFormatter"
25             value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
26 
27         <!-- 格式化XML代码 -->
28         <property name="xmlFormatter"
29             value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
30 
31         <!--自动实现Serializable接口 -->
32         <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
33 
34         <!--去除生成的注释;建议初次不去注释 -->
35         <commentGenerator>
36             <!-- 去除自动生成时的时间戳 -->
37             <property name="suppressDate" value="true" />
38             <!-- 去除自动生成的注释 -->
39             <property name="suppressAllComments" value="true" />
40         </commentGenerator>
41 
42         <!--数据库基本信息 -->
43         <jdbcConnection driverClass="com.mysql.jdbc.Driver"
44             connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
45             password="123456">
46         </jdbcConnection>
47 
48         <!-- java类型处理器 用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl； -->
49         <!-- 注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型； -->
50         <javaTypeResolver
51             type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
52             <!-- true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型 -->
53             <!--false：默认, -->
54             <!--scale>0;length>18：使用BigDecimal -->
55             <!--scale=0;length[10,18]：使用Long -->
56             <!--scale=0;length[5,9]：使用Integer -->
57             <!--scale=0;length<5：使用Short -->
58             <property name="forceBigDecimals" value="false" />
59         </javaTypeResolver>
60 
61         <!--Java model(POJO)生成的位置 -->
62         <!--targetPackage:包路径 -->
63         <!--targetProject:项目路径 -->
64         <javaModelGenerator targetPackage="com.it.mybatis.bean"
65             targetProject=".\src">
66             <!-- enableSubPackages:是否让schema作为包的后缀 -->
67             <property name="enableSubPackages" value="true" />
68             <!-- 从数据库返回的值被清理前后的空格 -->
69             <property name="trimStrings" value="true" />
70         </javaModelGenerator>
71 
72         <!--*Mapper.xml生成的位置 -->
73         <sqlMapGenerator targetPackage="com.it.mybatis.dao"
74             targetProject=".\conf">
75             <property name="enableSubPackages" value="true" />
76         </sqlMapGenerator>
77 
78         <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口 -->
79         <!--type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下） -->
80         <!--1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML -->
81         <!--2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中 -->
82         <!--3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML -->
83         <!--注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER -->
84         <javaClientGenerator type="XMLMAPPER"
85             targetPackage="com.it.mybatis.dao" targetProject=".\src">
86             <property name="enableSubPackages" value="true" />
87         </javaClientGenerator>
88 
89         <!--表的名称;对应类的名称; -->
90         <table tableName="tbl_employee" domainObjectName="Employee"></table>
91         <table tableName="tbl_empt" domainObjectName="Department"></table>
92 
93     </context>
94 </generatorConfiguration>

  1     <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
  2         选择的table会生成一下文件：
  3         1，SQL map文件
  4         2，生成一个主键类；
  5         3，除了BLOB和主键的其他字段的类；
  6         4，包含BLOB的类；
  7         5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
  8         6，Mapper接口（可选）
  9     
 10         tableName（必要）：要生成对象的表名；
 11         注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会
 12             根据设置的schema，catalog或tablename去查询数据表，按照下面的流程：
 13             1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询；
 14             2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找；
 15             3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找；
 16             4，否则，使用指定的大小写格式查询；
 17         另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名；
 18         这个时候，请设置delimitIdentifiers="true"即可保留大小写格式；
 19         
 20         可选：
 21         1，schema：数据库的schema；
 22         2，catalog：数据库的catalog；
 23         3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
 24         4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
 25         5，enableInsert（默认true）：指定是否生成insert语句；
 26         6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
 27         7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
 28         8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
 29         9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
 30         10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
 31         11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
 32         12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
 33         13，modelType：参考context元素的defaultModelType，相当于覆盖；
 34         14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
 35         15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性
 36         
 37         注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写；
 38      -->
 39     <table tableName="userinfo" >
 40         
 41         <!-- 参考 javaModelGenerator 的 constructorBased属性-->
 42         <property name="constructorBased" value="false"/>
 43         
 44         <!-- 默认为false，如果设置为true，在生成的SQL中，table名字不会加上catalog或schema； -->
 45         <property name="ignoreQualifiersAtRuntime" value="false"/>
 46         
 47         <!-- 参考 javaModelGenerator 的 immutable 属性 -->
 48         <property name="immutable" value="false"/>
 49         
 50         <!-- 指定是否只生成domain类，如果设置为true，只生成domain类，如果还配置了sqlMapGenerator，那么在mapper XML文件中，只生成resultMap元素 -->
 51         <property name="modelOnly" value="false"/>
 52         
 53         <!-- 参考 javaModelGenerator 的 rootClass 属性 
 54         <property name="rootClass" value=""/>
 55          -->
 56          
 57         <!-- 参考javaClientGenerator 的  rootInterface 属性
 58         <property name="rootInterface" value=""/>
 59         -->
 60         
 61         <!-- 如果设置了runtimeCatalog，那么在生成的SQL中，使用该指定的catalog，而不是table元素上的catalog 
 62         <property name="runtimeCatalog" value=""/>
 63         -->
 64         
 65         <!-- 如果设置了runtimeSchema，那么在生成的SQL中，使用该指定的schema，而不是table元素上的schema 
 66         <property name="runtimeSchema" value=""/>
 67         -->
 68         
 69         <!-- 如果设置了runtimeTableName，那么在生成的SQL中，使用该指定的tablename，而不是table元素上的tablename 
 70         <property name="runtimeTableName" value=""/>
 71         -->
 72         
 73         <!-- 注意，该属性只针对MyBatis3Simple有用；
 74             如果选择的runtime是MyBatis3Simple，那么会生成一个SelectAll方法，如果指定了selectAllOrderByClause，那么会在该SQL中添加指定的这个order条件；
 75          -->
 76         <property name="selectAllOrderByClause" value="age desc,username asc"/>
 77         
 78         <!-- 如果设置为true，生成的model类会直接使用column本身的名字，而不会再使用驼峰命名方法，比如BORN_DATE，生成的属性名字就是BORN_DATE,而不会是bornDate -->
 79         <property name="useActualColumnNames" value="false"/>
 80         
 81         
 82         <!-- generatedKey用于生成生成主键的方法，
 83             如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选
 84             column:主键的列名；
 85             sqlStatement：要生成的selectKey语句，有以下可选项：
 86                 Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
 87                 DB2       :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
 88                 DB2_MF    :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
 89                 Derby     :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL()
 90                 HSQLDB    :相当于selectKey的SQL为：CALL IDENTITY()
 91                 Informix  :相当于selectKey的SQL为：select dbinfo(‘sqlca.sqlerrd1‘) from systables where tabid=1
 92                 MySql     :相当于selectKey的SQL为：SELECT LAST_INSERT_ID()
 93                 SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY()
 94                 SYBASE    :相当于selectKey的SQL为：SELECT @@IDENTITY
 95                 JDBC      :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性
 96         <generatedKey column="" sqlStatement=""/>
 97          -->
 98         
 99         <!-- 
100             该元素会在根据表中列名计算对象属性名之前先重命名列名，非常适合用于表中的列都有公用的前缀字符串的时候，
101             比如列名为：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
102             那么就可以设置searchString为"^CUST_"，并使用空白替换，那么生成的Customer对象中的属性名称就不是
103             custId,custName等，而是先被替换为ID,NAME,EMAIL,然后变成属性：id，name，email；
104             
105             注意，MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的，
106             如果使用了columnOverride元素，该属性无效；
107             
108         <columnRenamingRule searchString="" replaceString=""/>
109          -->
110          
111          
112          <!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性；
113             column:要重新设置的列名；
114             注意，一个table元素中可以有多个columnOverride元素哈~
115           -->
116          <columnOverride column="username">
117             <!-- 使用property属性来指定列要生成的属性名称 -->
118             <property name="property" value="userName"/>
119             
120             <!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名
121             <property name="javaType" value=""/>
122              -->
123              
124             <!-- jdbcType用于指定该列的JDBC类型 
125             <property name="jdbcType" value=""/>
126              -->
127              
128             <!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名
129                 注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler
130                 只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述
131             <property name="jdbcType" value=""/>
132             -->
133             
134             <!-- 参考table元素的delimitAllColumns配置，默认为false
135             <property name="delimitedColumnName" value=""/>
136              -->
137          </columnOverride>
138          
139          <!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现 
140             column:指定要忽略的列的名字；
141             delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false
142             
143             注意，一个table元素中可以有多个ignoreColumn元素
144          <ignoreColumn column="deptId" delimitedColumnName=""/>
145          -->
146     </table>

 1 <generatedKey column="id" sqlStatement="MySql" identity="true"/>
 2 
 3 <columnOverride column="username">
 4 <!-- 使用property属性来指定列要生成的属性名称 -->
 5 <property name="property" value="creator"/>
 6 <property name="javaType" value="com.alibaba.fastjson.JSONObject"/>
 7 <property name="jdbcType" value="OTHER"/>
 8 
 9 <!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名
10 注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler
11 只会生成类似：where id = #{id,jdbcType=OTHER,typeHandler=com.it.JSONTypeHandler}的参数描述 -->
12 <property name="jdbcType" value="com.it.JSONTypeHandler"/>
13 
14 </columnOverride>