一.MBG介绍
MyBatis Generator(MBG)是一个Mybatis的代码生成器,它可以用来生成可以访问(多个)表的基础对象。MBG解决了对数据库操作有最大影响的一些简单的CRUD(插入,查询,更新,删除)操作。MBG会生成:匹配表结构的Java POJO;MyBatis兼容SQL映射XML文件;Mapper接口类。
二.配置示例
MySQL数据库创建用户表(tb_user),建表语句
CREATE TABLE `spring`.`tb_user` ( `id` INT NOT NULL AUTO_INCREMENT, `username` VARCHAR(45) NOT NULL, `password` VARCHAR(45) NOT NULL, PRIMARY KEY (`id`))DEFAULT CHARACTER SET = utf8;
配置数据库连接,创建resources/mybatis/db.properties
jdbc.driverClassName=com.mysql.jdbc.Driverjdbc.url=jdbc:mysql://172.17.0.2:3306/springjdbc.username=rootjdbc.password=password
配置mybatis generator,创建resources/mybatis/generatorConfig.xml
Maven配置MyBatis Generator,编辑pom.xml
org.mybatis.generator mybatis-generator-maven-plugin 1.3.5 mysql mysql-connector-java 5.1.44 true true ${basedir}/src/main/resources/mybatis/generatorConfig.xml tb_user
三.执行验证
执行mvn mybatis-generator:generate,生成UserDOMapper.java、UserDO.java、UserDOMapper.xml,插件执行成功。
四.<table>元素常用属性
该元素至少要配置一个,可以配置多个,该元素用来配置要通过内省的表,只有配置的才会生成实体类和其他文件。
该元素有一个必选属性:tableName:指定要生成的表名,可以使用SQL通配符匹配多个表,如:<table tableName="%" />
该元素包含多个可选属性:
schema:数据库的schema,可以使用SQL通配符匹配。设置后,生成SQL的表名会变成如schema.tableName的形式。
catalog:数据库的catalog,如果设置了该值,生成SQL的表名会变成如catalog.tableName的形式。alias:如果指定,这个值会用在生成的select查询SQL的表的别名和列名上,列名会被别名为alias_actualColumnName这种模式。domainObjectName:生成对象的基本名称,如果没有指定,MBG会自动根据表名来生成名称。enableXXX:XXX代表多种SQL方法,该属性用来指定是否生成对应的XXX语句。modelType:和<context>的defaultModelType含义一样,这里可以针对表进行配置,这里的配置会覆盖<context>的defaultModelType配置。escapeWildcards:这个属性表示当查询列,是否对schema和表名中的SQL通配符('_' and '%')进行转义,默认false。delimitIdentifiers:是否给标识符增加**分隔符**,默认false。当catalog,schema或tableName中包含空白时,默认true。delimitAllColumns:是否对所有列添加**分隔符**,默认false。除了<property>子元素外,<table>还包含以下子元素:
<generatedKey> (0个或1个):用来指定自动生成主键的属性,如果指定这个元素,MBG在生成insert的SQL映射文件中插入一个<selectKey>元素。也就是数据库自增后如果需要知道值,就用这个,这个是将自增结果回填到对象中。
<columnRenamingRule> (0个或1个):用来在MBG生成列之前,对列进行重命名。对于存在同一前缀的字段想在生成属性名时去除前缀的表非常有用。<columnOverride> (0个或多个):用来修改表中某个列的属性(属性名、数据类型),MBG会使用修改后的列来生成domain的属性。<ignoreColumn> (0个或多个):用来屏蔽不需要生成的列。