一、导入mybatis-generator jar包
1 <dependency> 2 <groupId>org.mybatis.generator</groupId> 3 <artifactId>mybatis-generator-core</artifactId> 4 <version>1.3.5</version> 5 </dependency>
二、pom.xml文件中配置generator插件信息
1 <plugins> 2 <!-- generator插件 --> 3 <plugin> 4 <groupId>org.mybatis.generator</groupId> 5 <artifactId>mybatis-generator-maven-plugin</artifactId> 6 <version>1.3.2</version> 7 <configuration> 8 <configurationFile>src/main/resources/mybatis/generatorConfig.xml</configurationFile> 9 <verbose>true</verbose> 10 <overwrite>true</overwrite> 11 </configuration> 12 <executions> 13 <execution> 14 <id>Generate MyBatis Artifacts</id> 15 <goals> 16 <goal>generate</goal> 17 </goals> 18 </execution> 19 </executions> 20 </plugin> 21 </plugins>
三、添加配置文件generatorConfig.xml
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 <classPathEntry 8 location="C:\repository\mysql\mysql-connector-java\8.0.11\mysql-connector-java-8.0.11.jar"/> 9 <context id="my" targetRuntime="MyBatis3"> 10 <commentGenerator> 11 <property name="suppressDate" value="false"/> 12 <property name="suppressAllComments" value="true"/> 13 </commentGenerator> 14 15 <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" 16 connectionURL="jdbc:mysql://127.0.0.1:3306/test_database?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false&allowMultiQueries=true" 17 userId="root" 18 password="123456"/> 19 20 <!-- model文件配置 --> 21 <javaModelGenerator targetPackage="com.wj.bean.model" 22 targetProject="src/main/java"> 23 <property name="enableSubPackages" value="true"/> 24 <property name="trimStrings" value="true"/> 25 </javaModelGenerator> 26 27 <!-- mapper.xml文件生成配置 --> 28 <sqlMapGenerator targetPackage="mappers._generator" 29 targetProject="src/main/resources"> 30 <property name="enableSubPackages" value="true"/> 31 </sqlMapGenerator> 32 33 <!-- mapper接口生成配置 --> 34 <javaClientGenerator targetPackage="com.wj.dao.mapper" 35 targetProject="src/main/java" type="XMLMAPPER"> 36 <property name="enableSubPackages" value="true"/> 37 </javaClientGenerator> 38 39 <!--<table tableName="CTAS_FEE_BASE" domainObjectName="FeeBase" 40 enableCountByExample="false" enableUpdateByExample="false" 41 enableDeleteByExample="false" enableSelectByExample="false" 42 selectByExampleQueryId="false"> 43 </table>--> 44 45 <table tableName="user_info"></table> 46 </context> 47 </generatorConfiguration>
四、使用方式
eclipse中，右击项目 -> maven build
输入：mvn mybatis-generator:generate
intellj IDEA中 直接双击即可生成代码
五、generatorConfig.xml配置详解
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 <!-- 可以用于加载配置项或者配置文件，在整个配置文件中就可以使用${propertyKey}的方式来引用配置项 8 resource：配置资源加载地址，使用resource，MBG从classpath开始找，比如com/myproject/generatorConfig.properties 9 url：配置资源加载地质，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties. 10 注意，两个属性只能选址一个; 11 另外，如果使用了mybatis-generator-maven-plugin，那么在pom.xml中定义的properties都可以直接在generatorConfig.xml中使用 12 <properties resource="" url="" /> 13 --> 14 <!-- 在MBG工作的时候，需要额外加载的依赖包 15 location属性指明加载jar/zip包的全路径 16 <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" /> 17 --> 18 <!-- 19 context:生成一组对象的环境 20 id:必选，上下文id，用于在生成错误时提示 21 defaultModelType:指定生成对象的样式 22 1，conditional：类似hierarchical； 23 2，flat：所有内容（主键，blob）等全部生成在一个对象中； 24 3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class) 25 targetRuntime: 26 1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample； 27 2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample； 28 introspectedColumnImpl：类全限定名，用于扩展MBG 29 --> 30 <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"> 31 <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表； 32 一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 33 --> 34 <property name="autoDelimitKeywords" value="false"/> 35 <!-- 生成的Java文件的编码 --> 36 <property name="javaFileEncoding" value="UTF-8"/> 37 <!-- 格式化java代码 --> 38 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 39 <!-- 格式化XML代码 --> 40 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 41 <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； --> 42 <property name="beginningDelimiter" value="`"/> 43 <property name="endingDelimiter" value="`"/> 44 <!-- 必须要有的，使用这个配置链接数据库 45 @TODO:是否可以扩展 46 --> 47 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" 48 password="admin"> 49 <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 --> 50 </jdbcConnection> 51 <!-- java类型处理器 52 用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl； 53 注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型； 54 --> 55 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> 56 <!-- 57 true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型 58 false：默认, 59 scale>0;length>18：使用BigDecimal; 60 scale=0;length[10,18]：使用Long； 61 scale=0;length[5,9]：使用Integer； 62 scale=0;length<5：使用Short； 63 --> 64 <property name="forceBigDecimals" value="false"/> 65 </javaTypeResolver> 66 67 <!-- java模型创建器，是必须要的元素 68 负责：1，key类（见context的defaultModelType）；2，java类；3，查询类 69 targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制； 70 targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录 71 --> 72 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java"> 73 <!-- for MyBatis3/MyBatis3Simple 74 自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter； 75 --> 76 <property name="constructorBased" value="false"/> 77 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 78 <property name="enableSubPackages" value="true"/> 79 <!-- for MyBatis3 / MyBatis3Simple 80 是否创建一个不可变的类，如果为true， 81 那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类 82 --> 83 <property name="immutable" value="false"/> 84 <!-- 设置一个根对象， 85 如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项 86 注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括： 87 1，属性名相同，类型相同，有相同的getter/setter方法； 88 --> 89 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/> 90 <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 --> 91 <property name="trimStrings" value="true"/> 92 </javaModelGenerator> 93 94 <!-- 生成SQL map的XML文件生成器， 95 注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口）， 96 或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置 97 targetPackage/targetProject:同javaModelGenerator 98 --> 99 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources"> 100 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 101 <property name="enableSubPackages" value="true"/> 102 </sqlMapGenerator> 103 104 <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口 105 targetPackage/targetProject:同javaModelGenerator 106 type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）： 107 1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML； 108 2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中； 109 3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML； 110 注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER 111 --> 112 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" 113 targetProject="src/main/java"> 114 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 115 <property name="enableSubPackages" value="true"/> 116 <!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查 117 <property name="rootInterface" value=""/> 118 --> 119 </javaClientGenerator> 120 <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素 121 选择的table会生成一下文件： 122 1，SQL map文件 123 2，生成一个主键类； 124 3，除了BLOB和主键的其他字段的类； 125 4，包含BLOB的类； 126 5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选； 127 6，Mapper接口（可选） 128 tableName（必要）：要生成对象的表名； 129 注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会 130 根据设置的schema，catalog或tablename去查询数据表，按照下面的流程： 131 1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询； 132 2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找； 133 3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找； 134 4，否则，使用指定的大小写格式查询； 135 另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名； 136 这个时候，请设置delimitIdentifiers="true"即可保留大小写格式； 137 可选： 138 1，schema：数据库的schema； 139 2，catalog：数据库的catalog； 140 3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName 141 4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面； 142 5，enableInsert（默认true）：指定是否生成insert语句； 143 6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）； 144 7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句； 145 8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)； 146 9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）； 147 10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句； 148 11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）； 149 12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）； 150 13，modelType：参考context元素的defaultModelType，相当于覆盖； 151 14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性） 152 15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性 153 注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写； 154 --> 155 <table tableName="userinfo"> 156 <!-- 参考 javaModelGenerator 的 constructorBased属性--> 157 <property name="constructorBased" value="false"/> 158 <!-- 默认为false，如果设置为true，在生成的SQL中，table名字不会加上catalog或schema； --> 159 <property name="ignoreQualifiersAtRuntime" value="false"/> 160 <!-- 参考 javaModelGenerator 的 immutable 属性 --> 161 <property name="immutable" value="false"/> 162 <!-- 指定是否只生成domain类，如果设置为true，只生成domain类，如果还配置了sqlMapGenerator，那么在mapper XML文件中，只生成resultMap元素 --> 163 <property name="modelOnly" value="false"/> 164 <!-- 参考 javaModelGenerator 的 rootClass 属性 165 <property name="rootClass" value=""/> 166 --> 167 <!-- 参考javaClientGenerator 的 rootInterface 属性 168 <property name="rootInterface" value=""/> 169 --> 170 <!-- 如果设置了runtimeCatalog，那么在生成的SQL中，使用该指定的catalog，而不是table元素上的catalog 171 <property name="runtimeCatalog" value=""/> 172 --> 173 <!-- 如果设置了runtimeSchema，那么在生成的SQL中，使用该指定的schema，而不是table元素上的schema 174 <property name="runtimeSchema" value=""/> 175 --> 176 <!-- 如果设置了runtimeTableName，那么在生成的SQL中，使用该指定的tablename，而不是table元素上的tablename 177 <property name="runtimeTableName" value=""/> 178 --> 179 <!-- 注意，该属性只针对MyBatis3Simple有用； 180 如果选择的runtime是MyBatis3Simple，那么会生成一个SelectAll方法，如果指定了selectAllOrderByClause，那么会在该SQL中添加指定的这个order条件； 181 --> 182 <property name="selectAllOrderByClause" value="age desc,username asc"/> 183 <!-- 如果设置为true，生成的model类会直接使用column本身的名字，而不会再使用驼峰命名方法，比如BORN_DATE，生成的属性名字就是BORN_DATE,而不会是bornDate --> 184 <property name="useActualColumnNames" value="false"/> 185 186 <!-- generatedKey用于生成生成主键的方法， 187 如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选 188 column:主键的列名； 189 sqlStatement：要生成的selectKey语句，有以下可选项： 190 Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL() 191 DB2 :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL() 192 DB2_MF :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 193 Derby :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL() 194 HSQLDB :相当于selectKey的SQL为：CALL IDENTITY() 195 Informix :相当于selectKey的SQL为：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 196 MySql :相当于selectKey的SQL为：SELECT LAST_INSERT_ID() 197 SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY() 198 SYBASE :相当于selectKey的SQL为：SELECT @@IDENTITY 199 JDBC :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性 200 <generatedKey column="" sqlStatement=""/> 201 --> 202 <!-- 203 该元素会在根据表中列名计算对象属性名之前先重命名列名，非常适合用于表中的列都有公用的前缀字符串的时候， 204 比如列名为：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等； 205 那么就可以设置searchString为"^CUST_"，并使用空白替换，那么生成的Customer对象中的属性名称就不是 206 custId,custName等，而是先被替换为ID,NAME,EMAIL,然后变成属性：id，name，email； 207 注意，MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的， 208 如果使用了columnOverride元素，该属性无效； 209 <columnRenamingRule searchString="" replaceString=""/> 210 --> 211 212 <!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性； 213 column:要重新设置的列名； 214 注意，一个table元素中可以有多个columnOverride元素哈~ 215 --> 216 <columnOverride column="username"> 217 <!-- 使用property属性来指定列要生成的属性名称 --> 218 <property name="property" value="userName"/> 219 <!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名 220 <property name="javaType" value=""/> 221 --> 222 <!-- jdbcType用于指定该列的JDBC类型 223 <property name="jdbcType" value=""/> 224 --> 225 <!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名 226 注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler 227 只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述 228 <property name="jdbcType" value=""/> 229 --> 230 <!-- 参考table元素的delimitAllColumns配置，默认为false 231 <property name="delimitedColumnName" value=""/> 232 --> 233 </columnOverride> 234 <!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现 235 column:指定要忽略的列的名字； 236 delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false 237 注意，一个table元素中可以有多个ignoreColumn元素 238 <ignoreColumn column="deptId" delimitedColumnName=""/> 239 --> 240 </table> 241 </context> 242 </generatorConfiguration>