一:序言
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息。
上面这一段话来自Mybatis官网
的介绍, 初用Mybatis时感觉这个框架相比于JDBC优雅多了, 用起来也如官网说的非常简单。但是用了一段时间之后, 弊端就慢慢凸显出来了
使用Mybatis时不得不为每个表创建一个Entity.java
、Mapper.xml(Mapper可以融合入Dao中)
、Dao.java
,Service.java
层次很清晰, 但是太多重复性的工作了, 费时间且易于出错,并且当数据库发生一点改动的时候... 苦不堪言,为此提供了代码自动生成器MyBatis Generator
二:介绍使用方式
对于MyBatis Generator运行方式,官网给出了如下几种
- 基于
mybatis-generator-core-x.x.x.jar
和其XML
配置文件,通过命令行运行。 - 通过
Ant
的Task
结合其XML
配置文件运行。 - 通过
Maven
插件运行。 - 通过
Java
代码和其XML
配置文件运行。 - 通过
Java
代码和编程式配置运行。 - 通过
Eclipse Feature
运行。
这里介绍两种:
第一种:通过编码+配置文件运行方式
第二种:通过Maven
插件+配置文件方式(推荐)
1、通过编码+配置文件方式
这里简单说下创建和使用过程,通过编码方式去运行插件先需要引入mybatis-generator-core
依赖,编写本文的时候最新的版本为:1.4.0
<dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.4.0</version></dependency>
假设编写好的XML
配置文件是ClassPath
下的generator-configuration.xml
,那么使用代码生成器的编码方式大致如下
List<String> warnings = new ArrayList<>(); // 如果已经存在生成过的文件是否进行覆盖 boolean overwrite = true; File configFile = new File("ClassPath路径/generator-configuration.xml"); ConfigurationParser cp = new ConfigurationParser(warnings); Configuration config = cp.parseConfiguration(configFile); DefaultShellCallback callback = new DefaultShellCallback(overwrite); MyBatisGenerator generator = new MyBatisGenerator(config, callback, warnings); generator.generate(null);
2、通过Maven插件+配置文件方式
项目中引入Maven
的插件mybatis-generator-maven-plugin
,不需要引入mybatis-generator-core
依赖,
<?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"> <generatorConfiguration> <context id="MysqlTables" targetRuntime="MyBatis3" defaultModelType="flat"> <property name="autoDelimitKeywords" value="true" /> <property name="javaFileEncoding" value="utf-8" /> <property name="beginningDelimiter" value="`" /> <property name="endingDelimiter" value="`" /> <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> <plugin type="org.mybatis.generator.plugins.SerializablePlugin" /> <plugin type="org.mybatis.generator.plugins.ToStringPlugin" /> <!-- 注释 --> <commentGenerator > <property name="suppressAllComments" value="true"/><!-- 是否取消注释 --> <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳--> </commentGenerator> <!-- jdbc连接 --> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/fast?serverTimezone=UTC" userId="root" password="root"> </jdbcConnection> <!-- 类型转换 --> <javaTypeResolver> <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) --> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- domain类的位置 --> <javaModelGenerator targetProject="src\main\java" targetPackage="com.rbac.po"/> <!-- mapper xml的位置 --> <sqlMapGenerator targetProject="src\main\resources" targetPackage="mapper"/> <!-- mapper类的位置 --> <javaClientGenerator targetProject="src\main\java" targetPackage="com.rbac.dao" type="XMLMAPPER"/> <!-- <table tableName="tb_users" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"> <property name="useActualColumnNames" value="false" /> </table>--> <table tableName="sys_dict" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <generatedKey column="id" sqlStatement="Mysql" identity="true" /> </table> </context> </generatorConfiguration>
配置文件
<?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"> <!-- 配置生成器 --> <generatorConfiguration> <!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e --> <!-- 引入配置文件 --> <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/> <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 <classPathEntry location="C:\\Development\\mysql-connector-java-5.1.7" />--> <!-- 一个数据库一个context --> <!--defaultModelType="flat" 大数据字段,不分表 --> <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat"> <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表; 一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 --> <property name="autoDelimitKeywords" value="true" /> <!-- 生成的Java文件的编码 --> <property name="javaFileEncoding" value="utf-8" /> <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; --> <property name="beginningDelimiter" value="`" /> <property name="endingDelimiter" value="`" /> <!-- 格式化java代码 --> <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> <!-- 格式化XML代码 --> <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> <plugin type="org.mybatis.generator.plugins.SerializablePlugin" /> <plugin type="org.mybatis.generator.plugins.ToStringPlugin" /> <!-- 注释 --> <commentGenerator > <property name="suppressAllComments" value="false"/><!-- 是否取消注释 --> <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳--> </commentGenerator> <!-- jdbc连接 --> <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" /> <!-- 类型转换 --> <javaTypeResolver> <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) --> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- 生成实体类地址 --> <javaModelGenerator targetPackage="com.lncywlc.rio.entity" targetProject="${models}" > <property name="enableSubPackages" value="false"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成mapxml文件 --> <sqlMapGenerator targetPackage="mapper" targetProject="${resources}" > <property name="enableSubPackages" value="false" /> </sqlMapGenerator> <!-- 生成mapxml对应client,也就是接口dao --> <javaClientGenerator targetPackage="com.lncywlc.rio.dao" targetProject="${daoo}" type="XMLMAPPER" > <property name="enableSubPackages" value="true" /> </javaClientGenerator> <!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 --> <!--如果想生成一个表则tableName="table_name"--> <table tableName="tb_users" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"> <property name="useActualColumnNames" value="false" /> <!-- 数据库表主键 --> <generatedKey column="id" sqlStatement="Mysql" identity="true" /> </table> </context> </generatorConfiguration>
插件配置完毕之后,使用下面的命令即可运行:
mvn mybatis-generator:generate
或者在开发工具,这里用得idea。直接maven projects按钮,弹窗里选择
mybatis-generator-maven-plugin
的更详细配置和可选参数可以参考:
MyBatis Generator Core – Running MyBatis Generator With Maven
三:配置文件详解
XML
配置文件才是Mybatis-Generator
的核心,它用于控制代码生成的所有行为。所有非标签独有的公共配置的Key
可以在mybatis-generator-core
的PropertyRegistry
类中找到。下面是一个相对完整的
<?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"> <!--配置文件中,最外层的标签为<generatorConfiguration> 用于配置生成器 --> <generatorConfiguration> <!-- 0或者1个<properties>标签,用于指定全局配置文件 <properties resource="" url="" /> 可以用于加载配置项或者配置文件,在整个配置文件中就可以使用${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中使用--> <properties resource="generator.properties"/> <!-- <classPathEntry location="E:\tool\mysql-connector-java-5.1.49.jar"/> 在MBG工作的时候,需要额外加载的依赖包,location属性指明加载jar/zip包的全路径 generator-configuration.xml中配置驱动包绝对路径--> <!-- 1或者N个<context>标签,用于运行时的解析模式和具体的代码生成行为,所以这个标签里面的配置是最重要的。 context:生成一组对象的环境 id:必选,上下文id,用于在生成错误时提示 defaultModelType:指定生成对象的样式 执行引擎为MyBatis3DynamicSql或者MyBatis3Kotlin时忽略此配置,可选值: 1,conditional:类似hierarchical;但是只有一个主键的时候会合并所有属性生成在同一个类。 2,flat:所有内容(主键,blob)等全部生成在一个对象中; 3,hierarchical:主键生成一个XXKey对象(key class),Blob等单独生成一个对象,其他简单属性在一个对象中(record class) targetRuntime:属性的可选值比较多,这里做个简单的小结: 1,MyBatis3:默认的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample; 2,MyBatis3Simple:类似MyBatis3,只是不生成XXXBySample; 3.MyBatis3DynamicSql 默认值,兼容JDK8+和MyBatis 3.4.2+,不会生成XML映射文件, 忽略<sqlMapGenerator>的配置项,也就是Mapper全部注解化,依赖于MyBatis Dynamic SQL类库 4.MyBatis3Kotlin 行为类似于MyBatis3DynamicSql,不过兼容Kotlin的代码生成 5.MyBatis3DynamicSqlV1 已经过时,不推荐使用 introspectedColumnImpl:类全限定名,用于扩展MBG--> <context id="default" targetRuntime="MyBatis3"> <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表; 一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖--> <property name="autoDelimitKeywords" value="false"/> <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; --> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <!-- 生成的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"/> <!-- 必须要有的,使用这个配置链接数据库 这里面可以设置property属性,每一个property属性都设置到配置的Driver上--> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/demo" userId="root" password="root"> </jdbcConnection> <!-- <commentGenerator>标签是可选的,用于控制生成的实体的注释内容。 它在mybatis-generator-core中对应的实现类为org.mybatis.generator.internal.DefaultCommentGenerator, 可以通过可选的type属性指定一个自定义的CommentGenerator实现。 <commentGenerator>标签支持0或N个<property>标签,<property>的可选属性有: suppressAllComments 是否生成注释 false suppressDate 是否在注释中添加生成的时间戳 false dateFormat 配合suppressDate使用,指定输出时间戳的格式 java.util.Date#toString() addRemarkComments 是否输出表和列的Comment信息 false 建议保持默认值,也就是什么注释都不输出,生成代码干净的实体。 --> <commentGenerator> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="true"/> </commentGenerator> <!-- java类型处理器 用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl; 注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型;--> <javaTypeResolver> <!-- 不强制把所有的数字类型转化为BigDecimal true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型 false:默认, scale>0;length>18:使用BigDecimal; scale=0;length[10,18]:使用Long; scale=0;length[5,9]:使用Integer; scale=0;length<5:使用Short;--> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- java模型创建器,是必须要的元素 负责:1,key类(见context的defaultModelType);2,java类;3,查询类 targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制; targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中, 如果目录不存在,MBG不会自动建目录--> <javaModelGenerator targetPackage="com.sysconfig.pojo.po" targetProject="src/main/java"> <!-- for MyBatis3/MyBatis3Simple 自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter;--> <property name="constructorBased" value="false"/> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="true"/> <!-- <property name="immutable" value="false"/> 是否创建一个不可变的类,如果为true, 那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类--> <!-- <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/> 设置一个根对象, 如果设置了这个根对象,那么生成的keyClass或者recordClass会继承这个类;在Table的rootClass属性中可以覆盖该选项 注意:如果在key class或者record class中有root class相同的属性,MBG就不会重新生成这些属性了,包括: 1,属性名相同,类型相同,有相同的getter/setter方法;--> <!-- <property name="trimStrings" value="true"/> 设置是否在getter方法中,对String类型字段调用trim()方法 --> </javaModelGenerator> <!-- 生成SQL map的XML文件生成器, 注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口), 或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置 targetPackage/targetProject:同javaModelGenerator--> <sqlMapGenerator targetPackage="mapper.sysconfig" targetProject="src/main/resources"> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口 targetPackage/targetProject:同javaModelGenerator 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--> <javaClientGenerator type="XMLMAPPER" targetPackage="com.sysconfig.dao" 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"即可保留大小写格式; 可选: 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等元素的默认属性的一个复写; --> <table tableName="sys_config" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false" domainObjectName="SysConfig" mapperName="SysConfigMapper"> <!-- 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="id" sqlStatement="MySql"/> <!--0或N个property 是否为实体类生成一个带有所有字段的构造函数 默认false 执行引擎为MyBatis3Kotlin的时候此属性忽略--> <property name="constructorBased" value="false"/> <!-- 默认为false,是否在运行时忽略别名 如果为true,则不会在生成表的时候把schema和catalog作为表的前缀--> <property name="ignoreQualifiersAtRuntime" value="false"/> <!-- 实体类是否不可变, 默认为false, 执行引擎为MyBatis3Kotlin的时候此属性忽略 --> <property name="immutable" value="false"/> <!-- 指定是否只生成domain类,如果设置为true,只生成domain类,如果还配置了sqlMapGenerator, 那么在mapper XML文件中,只生成resultMap元素 --> <property name="modelOnly" value="false"/> <!-- 如果配置此属性,则实体类会继承此指定的超类 <property name="rootClass" value=""/> --> <!--如果配置此属性,则实体类会实现此指定的接口 <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"/> <!--XML映射文件中生成的ResultMap使用列索引定义而不是列名称--> <property name="useColumnIndexes" value="false"/> <!--是否把列名和列备注拼接起来生成实体类属性名--> <property name="useCompoundPropertyNames" value="false"/> <!-- 该元素会在根据表中列名计算对象属性名之前先重命名列名,非常适合用于表中的列都有公用的前缀字符串的时候, 比如列名为: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> <!-- 0或N个ignoreColumn设置一个MGB忽略的列,如果设置了改列,那么在生成的domain中,生成的SQL中,都不会有该列出现 column:指定要忽略的列的名字; delimitedColumnName:参考table元素的delimitAllColumns配置,默认为false 注意,一个table元素中可以有多个ignoreColumn元素 <ignoreColumn column="deptId" delimitedColumnName=""/> --> </table> </context> </generatorConfiguration>
配置文件中,最外层的标签为<generatorConfiguration>
,它的子标签包括:
- 0或者1个
<properties>
标签,用于指定全局配置文件,下面可以通过占位符的形式读取<properties>
指定文件中的值。 - 0或者N个
<classPathEntry>
标签,<classPathEntry>
只有一个location
属性,用于指定数据源驱动包(jar
或者zip
)的绝对路径,具体选择什么驱动包取决于连接什么类型的数据源。 - 1或者N个
<context>
标签,用于运行时的解析模式和具体的代码生成行为,所以这个标签里面的配置是最重要的。
下面分别列举和分析一下<context>
标签和它的主要子标签的一些属性配置和功能。
context标签
<context>
标签在mybatis-generator-core
中对应的实现类为org.mybatis.generator.config.Context
,它除了大量的子标签配置之外,比较主要的属性是:
id
:Context
示例的唯一ID
,用于输出错误信息时候作为唯一标记。targetRuntime
:用于执行代码生成模式。defaultModelType
:控制Domain
类的生成行为。执行引擎为MyBatis3DynamicSql
或者MyBatis3Kotlin
时忽略此配置,可选值:
conditional
:默认值,类似hierarchical
,但是只有一个主键的时候会合并所有属性生成在同一个类。flat
:所有内容全部生成在一个对象中。hierarchical
:键生成一个XXKey对象,Blob等单独生成一个对象,其他简单属性在一个对象中。
targetRuntime
属性的可选值比较多,这里做个简单的小结:
属性 | 功能描述 |
MyBatis3DynamicSql |
默认值,兼容JDK8+ 和MyBatis 3.4.2+ ,不会生成XML 映射文件,忽略<sqlMapGenerator> 的配置项,也就是Mapper 全部注解化,依赖于MyBatis Dynamic SQL 类库 |
MyBatis3Kotlin |
行为类似于MyBatis3DynamicSql ,不过兼容Kotlin 的代码生成 |
MyBatis3 |
提供基本的基于动态SQL 的CRUD 方法和XXXByExample 方法,会生成XML 映射文件 |
MyBatis3Simple |
提供基本的基于动态SQL 的CRUD 方法,会生成XML 映射文件 |
MyBatis3DynamicSqlV1 |
已经过时,不推荐使用 |
<context>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 | 备注 |
autoDelimitKeywords |
是否使用分隔符号括住数据库关键字 | false |
例如MySQL 中会使用反引号括住关键字 |
beginningDelimiter |
分隔符号的开始符号 | " |
|
endingDelimiter |
分隔符号的结束号 | " |
|
javaFileEncoding |
文件的编码 | 系统默认值 |
来源于java.nio.charset.Charset |
javaFormatter |
类名和文件格式化器 | DefaultJavaFormatter |
见JavaFormatter 和DefaultJavaFormatter |
targetJava8 |
是否JDK8和启动其特性 | true |
|
kotlinFileEncoding |
Kotlin 文件编码 |
系统默认值 |
来源于java.nio.charset.Charset |
kotlinFormatter |
Kotlin 类名和文件格式化器 |
DefaultKotlinFormatter |
见KotlinFormatter 和DefaultKotlinFormatter |
xmlFormatter |
XML 文件格式化器 |
DefaultXmlFormatter |
见XmlFormatter 和DefaultXmlFormatter |
显示详细信息
jdbcConnection标签
<jdbcConnection>
标签用于指定数据源的连接信息,它在mybatis-generator-core
中对应的实现类为org.mybatis.generator.config.JDBCConnectionConfiguration
,主要属性包括:
属性 | 功能描述 | 是否必须 |
driverClass |
数据源驱动的全类名 | Y |
connectionURL |
JDBC 的连接URL |
Y |
userId |
连接到数据源的用户名 | N |
password |
连接到数据源的密码 | N |
commentGenerator标签
<commentGenerator>
标签是可选的,用于控制生成的实体的注释内容。它在mybatis-generator-core
中对应的实现类为org.mybatis.generator.internal.DefaultCommentGenerator
,可以通过可选的type
属性指定一个自定义的CommentGenerator
实现。<commentGenerator>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 |
suppressAllComments |
是否生成注释 | false |
suppressDate |
是否在注释中添加生成的时间戳 | false |
dateFormat |
配合suppressDate 使用,指定输出时间戳的格式 |
java.util.Date#toString() |
addRemarkComments |
是否输出表和列的Comment 信息 |
false |
建议保持默认值,也就是什么注释都不输出,生成代码干净的实体。
javaTypeResolver标签
<javaTypeResolver>
标签是<context>
的子标签,用于解析和计算数据库列类型和Java
类型的映射关系,该标签只包含一个type
属性,用于指定org.mybatis.generator.api.JavaTypeResolver
接口的实现类。<javaTypeResolver>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 |
forceBigDecimals |
是否强制把所有的数字类型强制使用java.math.BigDecimal 类型表示 |
false |
useJSR310Types |
是否支持JSR310 ,主要是JSR310 的新日期类型 |
false |
如果useJSR310Types
属性设置为true
,那么生成代码的时候类型映射关系如下(主要针对日期时间类型):
数据库(JDBC)类型 | Java类型 |
DATE |
java.time.LocalDate |
TIME |
java.time.LocalTime |
TIMESTAMP |
java.time.LocalDateTime |
TIME_WITH_TIMEZONE |
java.time.OffsetTime |
TIMESTAMP_WITH_TIMEZONE |
java.time.OffsetDateTime |
引入mybatis-generator-core
后,可以查看JavaTypeResolver
的默认实现为JavaTypeResolverDefaultImpl
,从它的源码可以得知一些映射关系:
BIGINT --> Long BIT --> Boolean INTEGER --> Integer SMALLINT --> Short TINYINT --> Byte ......
有些时候,我们希望INTEGER
、SMALLINT
和TINYINT
都映射为Integer
,那么我们需要覆盖JavaTypeResolverDefaultImpl
的构造方法:
public class DefaultJavaTypeResolver extends JavaTypeResolverDefaultImpl { public DefaultJavaTypeResolver() { super(); typeMap.put(Types.SMALLINT, new JdbcTypeInformation("SMALLINT", new FullyQualifiedJavaType(Integer.class.getName()))); typeMap.put(Types.TINYINT, new JdbcTypeInformation("TINYINT", new FullyQualifiedJavaType(Integer.class.getName()))); } }
注意一点的是这种自定义实现JavaTypeResolver
接口的方式使用编程式运行MBG
会相对方便,如果需要使用Maven
插件运行,那么需要把上面的DefaultJavaTypeResolver
类打包到插件中。
javaModelGenerator标签
<javaModelGenerator标签>
标签是<context>
的子标签,主要用于控制实体(Model
)类的代码生成行为。它支持的属性如下:
属性 | 功能描述 | 是否必须 | 备注 |
targetPackage |
生成的实体类的包名 | Y |
例如club.throwable.model |
targetProject |
生成的实体类文件相对于项目(根目录)的位置 | Y |
例如src/main/java |
<javaModelGenerator标签>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 | 备注 |
constructorBased |
是否生成一个带有所有字段属性的构造函数 | false |
MyBatis3Kotlin 模式下忽略此属性配置 |
enableSubPackages |
是否允许通过Schema 生成子包 |
false |
如果为true ,例如包名为club.throwable ,如果Schema 为xyz ,那么实体类文件最终会生成在club.throwable.xyz 目录 |
exampleTargetPackage |
生成的伴随实体类的Example 类的包名 |
- | - |
exampleTargetProject |
生成的伴随实体类的Example 类文件相对于项目(根目录)的位置 |
- | - |
immutable |
是否不可变 | false |
如果为true ,则不会生成Setter 方法,所有字段都使用final 修饰,提供一个带有所有字段属性的构造函数 |
rootClass |
为生成的实体类添加父类 | - | 通过value 指定父类的全类名即可 |
trimStrings |
Setter 方法是否对字符串类型进行一次trim 操作 |
false |
- |
显示详细信息
javaClientGenerator标签
<javaClientGenerator>
标签是<context>
的子标签,主要用于控制Mapper
接口的代码生成行为。它支持的属性如下:
属性 | 功能描述 | 是否必须 | 备注 |
type |
Mapper 接口生成策略 |
Y |
<context> 标签的targetRuntime 属性为MyBatis3DynamicSql 或者MyBatis3Kotlin 时此属性配置忽略 |
targetPackage |
生成的Mapper 接口的包名 |
Y |
例如club.throwable.mapper |
targetProject |
生成的Mapper 接口文件相对于项目(根目录)的位置 |
Y |
例如src/main/java |
type
属性的可选值如下:
ANNOTATEDMAPPER
:Mapper
接口生成的时候依赖于注解和SqlProviders
(也就是纯注解实现),不会生成XML
映射文件。XMLMAPPER
:Mapper
接口生成接口方法,对应的实现代码生成在XML
映射文件中(也就是纯映射文件实现)。MIXEDMAPPER
:Mapper
接口生成的时候复杂的方法实现生成在XML
映射文件中,而简单的实现通过注解和SqlProviders
实现(也就是注解和映射文件混合实现)。
注意两点:
<context>
标签的targetRuntime
属性指定为MyBatis3Simple
的时候,type
只能选用ANNOTATEDMAPPER
或者XMLMAPPER
。<context>
标签的targetRuntime
属性指定为MyBatis3
的时候,type
可以选用ANNOTATEDMAPPER
、XMLMAPPER
或者MIXEDMAPPER
。
<javaClientGenerator>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 | 备注 |
enableSubPackages |
是否允许通过Schema 生成子包 |
false |
如果为true ,例如包名为club.throwable ,如果Schema 为xyz ,那么Mapper 接口文件最终会生成在club.throwable.xyz 目录 |
useLegacyBuilder |
是否通过SQL Builder 生成动态SQL |
false |
|
rootInterface |
为生成的Mapper 接口添加父接口 |
- | 通过value 指定父接口的全类名即可 |
sqlMapGenerator标签
<sqlMapGenerator>
标签是<context>
的子标签,主要用于控制XML
映射文件的代码生成行为。它支持的属性如下:
属性 | 功能描述 | 是否必须 | 备注 |
targetPackage |
生成的XML 映射文件的包名 |
Y |
例如mappings |
targetProject |
生成的XML 映射文件相对于项目(根目录)的位置 |
Y |
例如src/main/resources |
<sqlMapGenerator>
标签支持0或N个<property>
标签,<property>
的可选属性有:
property属性 | 功能描述 | 默认值 | 备注 |
enableSubPackages |
是否允许通过Schema 生成子包 |
false |
- |
plugin标签
<plugin>
标签是<context>
的子标签,用于引入一些插件对代码生成的一些特性进行扩展,该标签只包含一个type
属性,用于指定org.mybatis.generator.api.Plugin
接口的实现类。内置的插件实现见Supplied Plugins。例如:引入org.mybatis.generator.plugins.SerializablePlugin
插件会让生成的实体类自动实现java.io.Serializable
接口并且添加serialVersionUID
属性。
table标签
<table>
标签是<context>
的子标签,主要用于配置要生成代码的数据库表格,定制一些代码生成行为等等。它支持的属性众多,列举如下:
属性 | 功能描述 | 是否必须 | 备注 |
tableName |
数据库表名称 | Y |
例如t_order |
schema |
数据库Schema |
N |
- |
catalog |
数据库Catalog |
N |
- |
alias |
表名称标签 | N |
如果指定了此值,则查询列的时候结果格式为alias_column |
domainObjectName |
表对应的实体类名称,可以通过. 指定包路径 |
N |
如果指定了bar.User ,则包名为bar ,实体类名称为User |
mapperName |
表对应的Mapper 接口类名称,可以通过. 指定包路径 |
N |
如果指定了bar.UserMapper ,则包名为bar ,Mapper 接口类名称为UserMapper |
sqlProviderName |
动态SQL 提供类SqlProvider 的类名称 |
N |
- |
enableInsert |
是否允许生成insert 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableSelectByPrimaryKey |
是否允许生成selectByPrimaryKey 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableSelectByExample |
是否允许生成selectByExample 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableUpdateByPrimaryKey |
是否允许生成updateByPrimaryKey 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableDeleteByPrimaryKey |
是否允许生成deleteByPrimaryKey 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableDeleteByExample |
是否允许生成deleteByExample 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableCountByExample |
是否允许生成countByExample 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
enableUpdateByExample |
是否允许生成updateByExample 方法 |
N |
默认值为true ,执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
selectByPrimaryKeyQueryId |
value 指定对应的主键列提供列表查询功能 |
N |
执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
selectByExampleQueryId |
value 指定对应的查询ID 提供列表查询功能 |
N |
执行引擎为MyBatis3DynamicSql 或者MyBatis3Kotlin 时忽略此配置 |
modelType |
覆盖<context> 的defaultModelType 属性 |
N |
见<context> 的defaultModelType 属性 |
escapeWildcards |
是否对通配符进行转义 | N |
- |
delimitIdentifiers |
标记匹配表名称的时候是否需要使用分隔符去标记生成的SQL | N |
- |
delimitAllColumns |
是否所有的列都添加分隔符 | N |
默认值为false ,如果设置为true ,所有列名会添加起始和结束分隔符 |
显示详细信息
四: 编程式自定义类型映射
如果把所有得非长整型的数字,统一使用Integer
接收,因此需要自定义类型映射。编写映射器如下:
public class DefaultJavaTypeResolver extends JavaTypeResolverDefaultImpl { public DefaultJavaTypeResolver() { super(); typeMap.put(Types.SMALLINT, new JdbcTypeInformation("SMALLINT", new FullyQualifiedJavaType(Integer.class.getName()))); typeMap.put(Types.TINYINT, new JdbcTypeInformation("TINYINT", new FullyQualifiedJavaType(Integer.class.getName()))); } }
此时最好使用编程式运行代码生成器,修改XML
配置文件:
<javaTypeResolver type="club.throwable.mbg.DefaultJavaTypeResolver"> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> ...
运行方法代码如下:
public class Main { public static void main(String[] args) throws Exception { List<String> warnings = new ArrayList<>(); // 如果已经存在生成过的文件是否进行覆盖 boolean overwrite = true; ConfigurationParser cp = new ConfigurationParser(warnings); Configuration config = cp.parseConfiguration(Main.class.getResourceAsStream("/generator-configuration.xml")); DefaultShellCallback callback = new DefaultShellCallback(overwrite); MyBatisGenerator generator = new MyBatisGenerator(config, callback, warnings); generator.generate(null); } }
数据库的order_status
是TINYINT
类型,生成出来的文件中的orderStatus
字段全部替换使用Integer
类型定义。
小结
本文相对详尽地介绍了Mybatis Generator
的使用方式,具体分析了XML
配置文件中主要标签以及标签属性的功能。因为Mybatis
在Java
的ORM
框架体系中还会有一段很长的时间处于主流地位,了解Mybatis Generator
可以简化CRUD
方法模板代码、实体以及Mapper
接口代码生成,从而解放大量生产力。Mybatis Generator
有不少第三方的扩展,例如tk.mapper
或者mybatis-plus
自身的扩展,可能附加的功能不一样,但是基本的使用是一致的。
参考地址:Mybatis代码生成器Mybatis-Generator使用详解 - throwable - 博客园