当前位置：首页 > news >正文

轻松上手MyBatis反向工程：从零到一的自动化代码生成

news 2025/5/14 15:08:18

前言

反向工程概念：

反向工程是从已有的具体实现（如数据库表结构）中推导出高层次的信息（如Java代码）的过程。在MyBatis中，它特指根据数据库表结构自动生成Java实体类、Mapper接口和XML映射文件。

原理：

MyBatis反向工程通过读取数据库表结构的元数据（如表名、字段名、字段类型等），然后利用模板引擎（如Velocity）和预定义的模板来生成对应的Java代码和配置文件。

简而言之，反向工程就是根据已有的数据库表来自动生成对应的项目结构，如mapper，dao和实体类等内容。

简单的反向工程实现步骤

1、配置依赖：

创建一个maven项目，导入相关依赖（一个是mysql依赖一个是mybatis自动生成的依赖）

mysql的依赖版本要参照自己本地的mysql版本

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><groupId>org.example</groupId><artifactId>fanxianggongcheng_demo1</artifactId><packaging>war</packaging><version>1.0-SNAPSHOT</version><name>fanxianggongcheng_demo1 Maven Webapp</name><url>http://maven.apache.org</url><dependencies><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>3.8.1</version><scope>test</scope></dependency><!--mysql驱动包--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.21</version></dependency><!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core --><dependency><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-core</artifactId><version>1.3.5</version></dependency></dependencies><build><finalName>fanxianggongcheng_demo1</finalName></build>
</project>

2、创建配置文件

在项目的目录下创建MyBatis Generator的配置文件（如generatorConfig.xml），配置数据库连接信息、生成代码的包路径、表信息等。

generatorConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration><context id="DB2Tables" targetRuntime="MyBatis3"><commentGenerator><property name="suppressDate" value="true"/><!-- 是否去除自动生成的注释 true：是 ： false:否 --><property name="suppressAllComments" value="true"/></commentGenerator><!--数据库链接URL，用户名、密码 --><jdbcConnectiondriverClass="com.mysql.cj.jdbc.Driver"connectionURL="jdbc:mysql://localhost:3306/csx_demo?serverTimezone=Asia/Shanghai&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;zeroDateTimeBehavior=convertToNull" userId="root" password="root"></jdbcConnection><javaTypeResolver><property name="forceBigDecimals" value="false" /></javaTypeResolver><!-- 设置Java类生成的位置 --><javaModelGenerator targetPackage="com.model" targetProject=".\src\main\java"><property name="enableSubPackages" value="true" /><property name="trimStrings" value="true" /></javaModelGenerator><!-- 生成映射文件的包名和位置--><sqlMapGenerator targetPackage="com.dao" targetProject=".\src\main\resources"><property name="enableSubPackages" value="true" /></sqlMapGenerator><!-- 生成DAO的包名和位置--><javaClientGenerator type="XMLMAPPER"targetPackage="mapper" targetProject=".\src\main\resources"><property name="enableSubPackages" value="true" /></javaClientGenerator><!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名--><table tableName="t_user"></table></context>
</generatorConfiguration>

3、创建反向工程的启动器类

MGB

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;import java.io.File;
import java.util.ArrayList;
import java.util.List;public class MBG {public static void main(String[] args) throws Exception {List<String> warnings = new ArrayList<String>();boolean overwrite = true;File configFile = new File("generatorConfig.xml");//直接放在文件下面，与pom.xml同级ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = cp.parseConfiguration(configFile);DefaultShellCallback callback = new DefaultShellCallback(overwrite);MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);myBatisGenerator.generate(null);}
}