前言:本文简单介绍了MyBatis的逆向工程用法,介绍了两种启动方式和提供了关于MBG配置文件的样例。逆向工程通过数据库自动创建三个组件,减轻开发工作量,提高开发效率。
简介
官方文档:http://mybatis.org/generator/
官方代码:https://github.com/mybatis/generator
MyBatis框架需要:实体类、自定义Mapper接口、Mapper.xml
传统的开发中上诉的三个组件需要开发者手动创建,逆向工程可以帮助开发者来自动创建三个组件,减轻开发工作量,提高开发效率
maven插件启动方式(无需启动类)
generator插件
<properties>
<mysql.connect.version>8.0.25</mysql.connect.version>
<mybatis.generator.plugin.version>1.4.0</mybatis.generator.plugin.version>
<mybatis.generator.vision>1.4.0</mybatis.generator.vision>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>${mybatis.generator.plugin.version}</version>
<configuration>
<!--指定MBG配置文件generatorConfig.xml的位置(需修改)-->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<!--是否将生成过程输出至控制台-->
<verbose>true</verbose>
<!--是否覆盖同名文件(只是针对XML文件,java文件生成类似*.java.1、*.java.2形式的文件)-->
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.connect.version}</version>
</dependency>
<!--mybatis代码生成器-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>${mybatis.generator.version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
main启动方式(需启动类)
导入依赖
<dependencies>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!--mybatis代码生成器-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
启动类
Generator
public class Generator {
public static void main(String[] args) throws InterruptedException, SQLException, IOException, XMLParserException, InvalidConfigurationException {
List<String> warnings = new ArrayList<>(); // 执行过程中的警告信息
boolean overwrite = true; // 生成的代码重复时,覆盖原代码
// 指定配置文件位置
String projectPath = System.getProperty("user.dir"); // 获取当前项目路径
String configFilePath = projectPath + "/src/main/resources/generatorConfig.xml"; //需修改
File configFile = new File(configFilePath);
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
// mybatis-generator-core依赖 1.3.6 后才有MyBatisGenerator类,需要jre1.8才能运行
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null); // 执行生成代码
warnings.forEach(System.out::println); // 输出警告信息
}
}
创建MBG配置文件
核心配置说明
jdbcConnection
:配置数据库连接信息javaModelGenerator
:配置JavaBean的生成策略sqlMapGenerator
:配置SQL映射文件生成策略javaClientGenerator
:配置Mapper接口的生成策略table
:配置目标数据库tableName
:表名domainObjectName
:JavaBean类名
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>
<!--指定 JDBC 驱动程序的位置(使用maven依赖不需要)-->
<!--<classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />-->
<context id="mysqlTables" targetRuntime="MyBatis3">
<!--jdbcConnection:指定连接的目标数据库-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/数据库名?serverTimezone=UTC&useUnicode=true&useSSL=false&characterEncoding=utf8"
userId="root"
password="密码">
</jdbcConnection>
<!-- 默认false时,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer;为true时把JDBC DECIMAL 和
NUMERIC 类型解析为java.math.BigDecimal -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!--javaModelGenerator:指定javaBean(实体类)的生成策略;targetPackage:目标包名;targetProject:目标工程-->
<javaModelGenerator targetPackage="com.mybatis.pojo" targetProject="./src/main/java">
<property name="enableSubPackages" value="true"/>
<!-- 从数据库返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!--sqlMapGenerator:sql映射生成策略-->
<sqlMapGenerator targetPackage="com.mybatis.mapper" targetProject="./src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!--javaClientGenerator:指定mapper接口所在位置-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.mybatis.mapper" targetProject="./src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--指定要逆向分析的表:根据表创建javaBean-->
<table tableName="m_user" domainObjectName="User"></table>
</context>
</generatorConfiguration>
参考资料来源: