Mybatis Generator逆向工程的使用详细教程

Mybatis Generator逆向工程的使用详细教程

一、MyBatis Generator简介

MyBatis Generator（MBG）是MyBatis和iBATIS的代码生成器。它将为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。它将审查数据库表（或许多表），并将生成可用于访问表的构件。这减少了设置对象和配置文件以与数据库表交互的初始麻烦。MBG寻求对简单CRUD（创建，检索，更新，删除）的大部分数据库操作产生重大影响。您仍然需要为连接查询或存储过程手动编写SQL和对象代码。MyBatis Generator将生成：

与表结构匹配的java POJO。这可能包括：

一个匹配表的主键的类（如果有主键）

一个匹配表的非主键字段的类（BLOB字段除外）

包含表的BLOB字段的类（如果表具有BLOB字段）

用于启用动态选择，更新和删除的类

这些类之间存在适当的继承关系。请注意，生成器可以配置为生成不同类型的POJO层次结构 - 例如，如果您愿意，可以选择为每个表生成单个域对象。

MyBatis/iBATIS兼容的SQL Map XML文件。MBG为配置中的每个表上的简单CRUD函数生成SQL。生成的SQL语句包括：

insert 插入

update by primary key  按主键更新

update by example (using a dynamic where clause)  通过条件更新（使用动态where子句）

delete by primary key  按主键删除

delete by example (using a dynamic where clause)  按条件删除（使用动态where子句）

select by primary key  按主键查询

select by example (using a dynamic where clause)  按条件查询（使用动态where子句）

count by example  按条件查询记录总数

根据表结构的不同，这些语句有不同的变体（例如，如果表没有主键，则MBG不会通过主键功能生成更新）。

适当使用上述对象的Java客户端类。Java客户端类的生成是可选的。MBG将为MyBatis 3.x生成以下类型的Java客户端：

适用于MyBatis 3.x映射器基础结构的映射器接口

MBG将为iBATIS 2.x生成以下类型的Java客户端：

符合Spring框架的DAO

仅使用iBATIS SQL映射API的DAO。这些DAO可以生成两种：通过构造函数或setter注入提供SqlMapClient。

符合iBATIS DAO框架的DAO（iBATIS的可选部分，现在不推荐使用此框架，我们建议您使用Spring框架）

MyBatis生成器设计为在迭代开发环境中运行良好，并且可以作为Ant任务或Maven插件包含在连续构建环境中。迭代运行MBG时需要注意的重要事项包括：

如果存在与新生成的XML文件同名的现有文件，MBG将自动合并XML文件。MBG不会覆盖您对其生成的XML文件所做的任何自定义更改。您可以反复运行它，而不必担心会丢失对XML的自定义更改。MBG将替换先前运行中生成的任何XML元素。

MBG不会合并Java文件，它可以覆盖现有文件或使用不同的唯一名称保存新生成的文件。如果对生成的Java文件进行更改并以迭代方式运行MBG，则必须手动合并更改。当作为Eclipse插件运行时 ，MBG可以自动合并Java文件。

二、MyBatis Generator使用

1、新建MBG的配置文件generatorConfig.xml文件

PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

driverClass="${jdbc.driverClass}"

connectionURL="${jdbc.connectionURL}"

userId="${jdbc.userId}"

password="${jdbc.password}">

driverClass="${jdbc.driverClass}"

connectionURL="${jdbc.connectionURL}"

userId="${jdbc.userId}"

password="${jdbc.password}">

targetProject=".\src\main\java">

targetProject=".\src\main\java">

targetProject=".\src\main\java">

targetProject=".\src\main\java">

targetProject=".\src\main\java" type="XMLMAPPER">

targetProject=".\src\main\java" type="XMLMAPPER">

enableCountByExample="false" enableUpdateByExample="false"

enableDeleteByExample="false" enableSelectByExample="false"

selectByExampleQueryId="false">

2、新建generator.properties文件

jdbc.driverLocation=C:\\mysql-connector-java-5.1.43.jar

jdbc.driverClass=com.mysql.jdbc.Driver

jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis

jdbc.userId=root

jdbc.password=tiger

3、配置执行mybatis generator操作，这里有两种方式

第1种方式：

如果使用maven项目就可以省去编写Java启动类，使用maven插件和配置文件pom.xml即可，插件启动maven-generator，在pom.xml中添加maven-generator插件

org.mybatis.generator

mybatis-generator-maven-plugin

1.3.2

true

true

${project.basedir}/src/main/resources/generatorConfig.xml

mysql

mysql-connector-java

5.1.35

点击mybatis-generator:generate就能执行mybatis generator了

第2种方式：

1、如果不是maven项目添加该mybatis-generator-core-1.3.2.jar，编写main方法指向mybatis逆向工程，我给依赖粘贴到下面了

org.mybatis.generator

mybatis-generator-core

1.3.2

2、修改generatorConfig.xml文件，放开注释的该配置

3、然后编写测试类执行

/**

* 如果不是maven项目可以这样生成

*/

public class MybatisGeneratorTest {

public static void main(String[] args) throws InterruptedException, SQLException, IOException, InvalidConfigurationException, XMLParserException {

List warnings = new ArrayList();

//生成的java文件是否覆盖

boolean overwrite = true;

//指定逆向工程配置文件

//File configFile = new File("E:\\project\\mybatis-generator\\src\\main\\resources\\generatorConfig.xml");

InputStream resourceAsStream = MybatisGeneratorTest.class.getClassLoader().getResourceAsStream("generatorConfig.xml");

ConfigurationParser cp = new ConfigurationParser(warnings);

Configuration config = cp.parseConfiguration(resourceAsStream);

DefaultShellCallback callback = new DefaultShellCallback(overwrite);

MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,callback, warnings);

myBatisGenerator.generate(null);

}

}

介绍完这两种方式，查看数据表：

查看生成的实体类：​

TIP：可以看出如果实体类想要遵循驼峰命名规范，数据库表字段名设计需要用"_"来划分

查看生成的文件信息：​

TIP1：必须在标签里添加数据库驱动，在其他地方添加无效，如果不添加会报找不到驱动错误，如过不在该插件添加数据库依赖的话可以使用 来指定数据库驱动位置。

TIP2：如果你在使用mybatis generator插件执行的时候报[ERROR] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate (default-cli) on project mybatis-generator: resource generator.properties does not exist -> [Help 1]​

尽管你的 配置的没有问题，但是还是找不到generator.properties，查看该配置，注释掉​

该配置会改变generatorConfig.xml中读取generator.properties文件的默认路径

TIP3：Mybatis Generator反向工程默认不会覆盖生成的*.java文件。也可以设置覆盖生成的*.java文件，在反向工程插件mybatis-generator-maven-plugin添加该配置true则会覆盖生成的*.java文件，如图​

Mybatis Generator不会覆盖你的mapper.xml文件，MBG会合并追加到mapper.xml和你自定义的存在一起，但是如果你修改MBG第一次默认生成的SQL（MBG生成的CRUD），MBG会重新把自己生成的CRUD恢复默认，说白了，MBG只会覆盖他自己生成的SQL，不会覆盖你自定义的，你自定义的不变。。。如图，他不会动你的自定义SQL，只会覆盖Mybatis反向工程自己生成的SQL，前提MBG自动生成SQL语句的注释要存在。​

在最常见的用例中，MyBatis Generator（MBG）由XML配置文件驱动。配置文件告诉MBG

如何连接到数据库

生成什么对象，以及如何生成它们

应使用哪些表生成对象

官方MBG配置文件详解地址：http://mybatis.org/generator/configreference/xmlconfig.html

附带一个MBG的中文配置文件详解：https://jianshu.com/p/e09d2370b796

更多Mybatis逆向工程的使用参考：http://mybatis.org/generator/index.html

总结

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。