MyBatis框架核心之(十)Mybatis generator(MBG)代码生成工具

最新推荐文章于 2024-02-25 13:06:41 发布

王福强

最新推荐文章于 2024-02-25 13:06:41 发布

阅读量912

点赞数 2

CC 4.0 BY-SA版权

分类专栏： MyBatis 文章标签： mybatis-generator配置详 MBG配置 generatorConfig mybatis代码自动生成 mybatis-generator ma

本文链接：https://blog.youkuaiyun.com/wfq784967698/article/details/78828776

MyBatis 专栏收录该内容

6 篇文章

订阅专栏

十、Mybatis generator （MBG）自动生成持久层代码

简介：mybatisgenerator是用来给持久层自动生成代码的，会根据表中的字段，和你在配置文件之中的设置，自动生成数据库的查询语句和实体类，大大的提高了开发的效率，与hibernate的你逆向生成有点像

mybatis-generator自动生成代码有三种用法：

1. 命令行

2. eclipse插件

3. maven插件

(本文只介绍第一中和第三种)

不管是哪种使用方式，核心配置文件的配置都差不多。所以先详细介绍一下mybatis-generator的配置文件

一、核心配置文件详解

在MBG中，最主要也最重要的就是XML配置文件，下面配置详细介绍了标签的作用，

如果只是简单使用，可直接复制下面的源代码实例中的配置

mybatis-generator 配置文件的配置详解

<?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">

<!-- 可以用于加载配置项或者配置文件，在整个配置文件中就可以使用${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中使用

-->

<!-- 在MBG工作的时候，需要额外加载的数据库驱动jar

location属性指明加载jar/zip包的全路径

如果使用的是maven plugin则可以在plugin中设置可以不配置

注意，classPathEntry只在下面这两种情况下才有效：

·当加载 JDBC 驱动内省数据库时

·当加载根类中的 JavaModelGenerator 检查重写的方法时

因此，如果你需要加载其他用途的jar包，classPathEntry起不到作用，不能这么写，解决的办法就是将你用的jar包添加到类路径中，在Eclipse等IDE中运行的时候，添加jar包比较容易。当从命令行执行的时候，需要用java -cp xx.jar,xx2.jar xxxMainClass这种方式在-cp后面指定来使用(注意-jar会导致-cp无效)。

-->

<classPathEntry location="mysql-connector-java-5.1.26-bin.jar"/>

<!--

context:生成一组对象的环境

id:必选，上下文id，用于在生成错误时提示

defaultModelType:指定生成对象的样式

1，conditional：类似hierarchical；

2，flat：所有内容（主键，blob）等全部生成在一个对象中；

3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)

targetRuntime:

1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；

2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；

introspectedColumnImpl：类全限定名，用于扩展MBG

-->

<!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；

一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖

-->

<!-- 必须要有的，使用这个配置链接数据库

@TODO:是否可以扩展

-->

</jdbcConnection>

<!-- java类型处理器

用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；

注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；

-->

<!--

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；

-->

</javaTypeResolver>

<!-- java模型创建器，是必须要的元素

负责：1，key类（见context的defaultModelType）；2，java类；3，查询类

targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；

targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录

-->

<!-- for MyBatis3/MyBatis3Simple

自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；

-->

<!-- for MyBatis3 / MyBatis3Simple

是否创建一个不可变的类，如果为true，

那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类

-->

<!-- 设置一个根对象，

如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项

注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：

1，属性名相同，类型相同，有相同的getter/setter方法；

-->

</javaModelGenerator>

<!-- 生成SQL map的XML文件生成器，

注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），

或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置

targetPackage/targetProject:同javaModelGenerator

-->

</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

-->

<!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查

-->

</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等元素的默认属性的一个复写；

-->

<!-- 参考 javaModelGenerator 的 rootClass 属性

-->

<!-- 参考javaClientGenerator 的 rootInterface 属性

-->

<!-- 如果设置了runtimeCatalog，那么在生成的SQL中，使用该指定的catalog，而不是table元素上的catalog

-->

<!-- 如果设置了runtimeSchema，那么在生成的SQL中，使用该指定的schema，而不是table元素上的schema

-->

<!-- 如果设置了runtimeTableName，那么在生成的SQL中，使用该指定的tablename，而不是table元素上的tablename

-->

<!-- 注意，该属性只针对MyBatis3Simple有用；

如果选择的runtime是MyBatis3Simple，那么会生成一个SelectAll方法，如果指定了selectAllOrderByClause，那么会在该SQL中添加指定的这个order条件；

-->

<!-- 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属性

-->

<!--

该元素会在根据表中列名计算对象属性名之前先重命名列名，非常适合用于表中的列都有公用的前缀字符串的时候，

比如列名为：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元素，该属性无效；

-->

<!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性；

column:要重新设置的列名；

注意，一个table元素中可以有多个columnOverride元素哈~

-->

<!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名

-->

<!-- jdbcType用于指定该列的JDBC类型

-->

<!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名

注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler

只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述

-->

<!-- 参考table元素的delimitAllColumns配置，默认为false

-->

</columnOverride>

<!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现

column:指定要忽略的列的名字；

delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false

注意，一个table元素中可以有多个ignoreColumn元素

-->

</table>

</context>

</generatorConfiguration>

二、 mybatis-generator使用命令生成代码

1. 创建目录结构

新建一个文件夹，名字可以任意起，其中结构为下图

1).src目录

是最后代码生成的目录

2).generatorConfig.xml

是主要的配置文件目录，相当于generator的大脑

注意：配置文件必须为ANSI编码才能正常运行，因为配置文件中有注释，如果实在想用UTF-8可以删除所有注解然后运行

错误是：XML Parser Error on line 11

注释中不允许出现字符串 "--"

generatorConfig.xml

<?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>

<classPathEntry location="mysql-connector-java-5.1.26-bin.jar"/>

<context id="mysql" targetRuntime="MyBatis3">

<commentGenerator>

<property name="suppressDate" value="true"/>

<property name="suppressAllComments" value="true"/>

</commentGenerator>

<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost/test" userId="root" password="root">

</jdbcConnection>

<javaTypeResolver>

<property name="forceBigDecimals" value="false"/>

</javaTypeResolver>

<javaModelGenerator targetPackage="cn.fuqiang.entity" targetProject="src">

<property name="enableSubPackages" value="true"/>

<property name="trimStrings" value="true"/>

</javaModelGenerator>

<sqlMapGenerator targetPackage="cn.fuqiang.mapping" targetProject="src">

<property name="enableSubPackages" value="true"/>

</sqlMapGenerator>

<javaClientGenerator type="XMLMAPPER" targetPackage="cn.fuqiang.dao" targetProject="src">

<property name="enableSubPackages" value="true"/>

</javaClientGenerator>

<table tableName="emp"></table>

</context>

</generatorConfiguration>

3).mybatis-generator-core-1.3.2.jar

是mybatis-generator 要是用jar包，可以在这个地址下载： https://github.com/mybatis/generator/releases

4). mysql-connector-java-5.1.26-bin.jar

是连接mysql数据库的驱动jar包，因为我使用的是mysql所以放入了mysql的jar，如果是其他数据库需要放入相应的jar包，当然也要与配置文件中的匹配

5).run.cmd

是自己创建的可执行文件，其中放的是执行该jar命令

java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite

详细的配置

run.cmd

java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite

pause

注意：可执行文件中的pause是暂停，主要用于报错的时候查看，如果不加有错误也会一闪而过。

当然如果不会创建.cmd可执行文件可以在该文件目录空白处按住Shift键，右键鼠标选择"在此处打开命令窗口"，复制粘贴生成语句的文件代码即可。

三、 mybatis-generator使用maven plugin 生成代码

1. pom.xml文件的配置

主要配置plugin的配置

mybatis-generator-core的，和连接数据库的驱动的依赖可以根据需要配置

注意：如果在 generatorConfig.xml文件中配置使用了

<classPathEntry location="mysql-connector-java-5.1.26-bin.jar"/>

则不需要再这里配置连接数据库的驱动依赖，plugin中也不用配置

pom.xml的配置

<groupId>cn.fuqiang.common</groupId>

<version>0.0.1-SNAPSHOT</version>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

</properties>

<!-- 引入两个需要的jar包

有些配置文件中使用数据库驱动

<classPathEntry location="mysql-connector-java-5.0.8-bin.jar"/>配置

我们使用不使用导入本地的驱动加载（详见下面配置）

-->

<groupId>Mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

<groupId>org.mybatis.generator</groupId>

<artifactId>mybatis-generator-core</artifactId>

</dependency>

</dependencies>

<build>

<groupId>org.mybatis.generator</groupId>

<artifactId>mybatis-generator-maven-plugin</artifactId>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

</dependencies>

<configurationFile>src/main/resources/MyBatis-Generator.xml</configurationFile>

</configuration>

</plugin>

</plugins>

</build>

</project>

2.配置mybatis-generator Config.xml文件

配置该配置文件有两种方式

如果generator.xml要使用<classPathEntry location="mysql-connector-java-5.1.26-bin.jar"/>，可以使用上面使用命令的配置文件，pom.xml中也不需要配置数据库的依赖

如果不使用则需要使用以下配置

mybatis-generator.xml

<?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">

</commentGenerator>

<jdbcConnection driverClass="com.mysql.jdbc.Driver"

connectionURL="jdbc:mysql://localhost/test" userId="root" password="root">

</jdbcConnection>

<!-- This property is used to specify whether MyBatis Generator should

force the use of java.math.BigDecimal for DECIMAL and NUMERIC fields, -->

</javaTypeResolver>

<javaModelGenerator targetPackage="cn.fuqiang.entity"

targetProject="src/main/java">

</javaModelGenerator>

<sqlMapGenerator targetPackage="cn.fuqiang.mapping"

targetProject="src/main/java">

</sqlMapGenerator>

<javaClientGenerator type="ANNOTATEDMAPPER"

targetPackage="cn.fuqiang.dao" implementationPackage="cn.fuqiang.dao.impl" targetProject="src/main/java">

</javaClientGenerator>

</table>

</table>

</context>

</generatorConfiguration>

3.对项目做运行参数配置

在项目上面点击右键，

选择要执行的项目

在Goals输入运行的命令：mybatis-generator:generate

注意要是没有 src/main/resources目录会报错

运行后需要刷新一下目录

MyBatis框架核心之(十)Mybatis generator(MBG)代码生成工具

十、Mybatis generator （MBG）自动生成持久层代码

1. 命令行

2. eclipse插件

一、 核心配置文件详解

二、 mybatis-generator使用命令生成代码

三、 mybatis-generator使用maven plugin 生成代码

一、核心配置文件详解