MyBatis Generator 简介
MyBatis Generator 连接数据库表并生成MyBatis或iBatis文件。这有助于最大限度地减少使用MyBatis时为数据库文件创建简单CRUD操作所需的工作量。
参考文档：http://www.mybatis.org/generator/
下载地址：https://github.com/mybatis/generator/releases
MyBatis Generator 使用
本例环境已安装java环境，且数据库是mysql，表结构如下：
1 CREATE DATABASE test_mybatis; 2 USE test_mybatis; 3 4 -- ---------------------------- 5 -- Table structure for employee 6 -- ---------------------------- 7 DROP TABLE IF EXISTS `employee`; 8 CREATE TABLE `employee` ( 9 `id` int(11) NOT NULL AUTO_INCREMENT, 10 `last_name` varchar(255) DEFAULT NULL, 11 `gender` char(1) DEFAULT NULL, 12 `email` varchar(255) DEFAULT NULL, 13 `dept_id` int(11) DEFAULT NULL COMMENT '部门ID', 14 PRIMARY KEY (`id`) 15 ) ENGINE=InnoDB AUTO_INCREMENT=36 DEFAULT CHARSET=utf8; 16 17 -- ---------------------------- 18 -- Records of employee 19 -- ---------------------------- 20 BEGIN; 21 INSERT INTO `employee` VALUES (1, '大白', '1', 'dabai@163.com', 1); 22 INSERT INTO `employee` VALUES (2, '小明', '1', 'xiaoming@163.com', 1); 23 INSERT INTO `employee` VALUES (3, '小红', '1', 'xiaohong@163.com', 1); 24 COMMIT; 25 26
1、使用命令行的方式使用
a、下载mybatis-generator，如下：
、
b、新建配置文件mbg.xml，参考文档：http://www.mybatis.org/generator/
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 <classPathEntry 9 location="/Users/h__d/.m2/repository/mysql/mysql-connector-java/8.0.13/mysql-connector-java-8.0.13.jar" /> 10 11 <!-- 12 context:生成一组对象的环境 13 id:必选，上下文id，用于在生成错误时提示 14 defaultModelType:指定生成对象的样式 15 1，conditional：类似hierarchical； 16 2，flat：所有内容（主键，blob）等全部生成在一个对象中； 17 3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class) 18 targetRuntime: 19 1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample； 20 2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample； 21 introspectedColumnImpl：类全限定名，用于扩展MBG 22 --> 23 <context id="DB2Tables" targetRuntime="MyBatis3"> 24 25 26 27 <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表； 28 一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 29 --> 30 <property name="autoDelimitKeywords" value="false"/> 31 <!-- 生成的Java文件的编码 --> 32 <property name="javaFileEncoding" value="UTF-8"/> 33 <!-- 格式化java代码 --> 34 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 35 <!-- 格式化XML代码 --> 36 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 37 38 <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； --> 39 <property name="beginningDelimiter" value="`"/> 40 <property name="endingDelimiter" value="`"/> 41 42 <!-- 配置pojo的序列化 --> 43 <plugin type="org.mybatis.generator.plugins.SerializablePlugin" /> 44 45 <commentGenerator> 46 <!-- 是否去除自动生成的文档注释 true：是 ： false:否（默认） --> 47 <property name="suppressAllComments" value="true"/> 48 <!-- 是否添加数据库注释备注 true：是 false:否（默认） --> 49 <property name="addRemarkComments" value="true" /> 50 <!-- 是否去除自动生成的时间 true：是 ： false:否（默认） --> 51 <property name="suppressDate" value="false" /> 52 <!-- 注释时间格式 --> 53 <property name="dateFormat" value="yyyy-MM-dd HH:mm:ss" /> 54 </commentGenerator> 55 56 <!-- JDBC 连接 --> 57 <jdbcConnection driverClass="com.mysql.jdbc.Driver" 58 connectionURL="jdbc:mysql://localhost:3306/test_mybatis?allowPublicKeyRetrieval=true" 59 userId="root" password="123456"> 60 </jdbcConnection> 61 62 63 <!-- java类型处理器 64 用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl； 65 注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型； 66 --> 67 <javaTypeResolver> 68 <!-- 69 true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型 70 false：默认, 71 scale>0;length>18：使用BigDecimal; 72 scale=0;length[10,18]：使用Long； 73 scale=0;length[5,9]：使用Integer； 74 scale=0;length<5：使用Short； 75 --> 76 <property name="forceBigDecimals" value="false" /> 77 </javaTypeResolver> 78 79 <!-- java模型创建器，是必须要的元素 80 负责：1，key类（见context的defaultModelType）；2，java类；3，查询类 81 targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制； 82 targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录 83 --> 84 <javaModelGenerator targetPackage="com.test.mybatis.pojo" 85 targetProject="src/main/java"> 86 87 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 88 <property name="enableSubPackages" value="true" /> 89 <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 --> 90 <property name="trimStrings" value="false" /> 91 </javaModelGenerator> 92 93 <!-- 生成SQL map的XML文件生成器， 94 注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口）， 95 或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置 96 targetPackage/targetProject:同javaModelGenerator 97 --> 98 <sqlMapGenerator targetPackage="mapper" 99 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 type="XMLMAPPER" 113 targetPackage="com.test.mybatis.dao" targetProject="src/main/java"> 114 <property name="enableSubPackages" value="true" /> 115 </javaClientGenerator> 116 117 118 <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素 119 选择的table会生成一下文件： 120 1，SQL map文件 121 2，生成一个主键类； 122 3，除了BLOB和主键的其他字段的类； 123 4，包含BLOB的类； 124 5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选； 125 6，Mapper接口（可选） 126 tableName（必要）：要生成对象的表名； 127 注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会 128 根据设置的schema，catalog或tablename去查询数据表，按照下面的流程： 129 1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询； 130 2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找； 131 3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找； 132 4，否则，使用指定的大小写格式查询； 133 另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名； 134 这个时候，请设置delimitIdentifiers="true"即可保留大小写格式； 135 可选： 136 1，schema：数据库的schema； 137 2，catalog：数据库的catalog； 138 3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName 139 4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面； 140 5，enableInsert（默认true）：指定是否生成insert语句； 141 6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）； 142 7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句； 143 8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)； 144 9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）； 145 10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句； 146 11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）； 147 12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）； 148 13，modelType：参考context元素的defaultModelType，相当于覆盖； 149 14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性） 150 15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性 151 注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写； 152 --> 153 <table schema="test_mybatis" tableName="employee" 154 domainObjectName="Employee" > 155 <!-- 如果设置为true，生成的model类会直接使用column本身的名字，而不会再使用驼峰命名方法，比如BORN_DATE，生成的属性名字就是BORN_DATE,而不会是bornDate --> 156 <property name="useActualColumnNames" value="false" /> 157 <!-- generatedKey用于生成生成主键的方法， 158 如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选 159 column:主键的列名； 160 sqlStatement：要生成的selectKey语句，有以下可选项： 161 Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL() 162 DB2 :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL() 163 DB2_MF :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 164 Derby :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL() 165 HSQLDB :相当于selectKey的SQL为：CALL IDENTITY() 166 Informix :相当于selectKey的SQL为：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 167 MySql :相当于selectKey的SQL为：SELECT LAST_INSERT_ID() 168 SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY() 169 SYBASE :相当于selectKey的SQL为：SELECT @@IDENTITY 170 JDBC :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性 171 --> 172 <generatedKey column="ID" sqlStatement="MySql" 173 identity="true" /> 174 <!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性； 175 column:要重新设置的列名； 176 注意，一个table元素中可以有多个columnOverride元素哈~ 177 --> 178 <columnOverride column="DATE_FIELD" 179 property="startDate" /> 180 <!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现 181 column:指定要忽略的列的名字； 182 delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false 183 注意，一个table元素中可以有多个ignoreColumn元素 184 --> 185 <ignoreColumn column="dept_id" /> 186 <columnOverride column="gender" jdbcType="VARCHAR" /> 187 188 </table> 189 190 </context> 191 </generatorConfiguration>
c、使用命令：java -jar mybatis-generator-core-1.3.7.jar -configfile mbg.xml -overwrite
d、查看生成目录文件：
1 package com.test.mybatis.pojo; 2 3 public class Employee { 4 private Integer id; 5 6 private String lastName; 7 8 private String gender; 9 10 private String email; 11 12 public Integer getId() { 13 return id; 14 } 15 16 public void setId(Integer id) { 17 this.id = id; 18 } 19 20 public String getLastName() { 21 return lastName; 22 } 23 24 public void setLastName(String lastName) { 25 this.lastName = lastName; 26 } 27 28 public String getGender() { 29 return gender; 30 } 31 32 public void setGender(String gender) { 33 this.gender = gender; 34 } 35 36 public String getEmail() { 37 return email; 38 } 39 40 public void setEmail(String email) { 41 this.email = email; 42 } 43 }