【Mybatis】逆向工程

关于Mybatis的代码生成器使用

一、介绍

• 逆向工程：也被称作Mybatis Generator（代码生成器）
  • 简称：MBG

• 代码生成器可以通过数据库表，来自动生成JavaBean、接口、映射文件，不用自己配置

• 代码生成器，要下载相应的jar包：mybatis-generator-core
  • 下载地址：https://github.com/mybatis/generator/releases

Maven：
       <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.4.0</version>
        </dependency>

• 方便学习，可以参考官方使用文档：https://www.mybatis.org/generator

---

二、使用方法

2.1 创建配置文件

• 参考官方文档配置文件信息：http://mybatis.org/generator/configreference/xmlconfig.html
• 复制基本的模板进行修改，具体各个参数，可细看官方文档

<?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="D:\DataBase\mysql-connector-java-8.0.21\mysql-connector-java-8.0.21.jar"/>

    <!--代码生成器运行环境：参数看官方
        MyBatis3Simple：创建简单的增删改查方法
        MyBatis3：能创建动态sql语句
    -->
    <context id="DB2Tables" targetRuntime="MyBatis3">

        <!--jdbcConnection：数据库连接-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8"
                        userId="root"
                        password="123">
        </jdbcConnection>

        <!--javaTypeResolver：Java类型解析器
            使用默认即可
        -->
        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!--指定JavaBean的生成策略：生成JavaBean
            targetPackage="test.model1"：目标包
            targetProject="\MGBTestProjecr\src"：目标工程（在IDEA中蓝色的文件夹）
            属性内容可看官方文档
        -->
        <javaModelGenerator targetPackage="com.letere.bean" targetProject=".\src\main\java"><!--当前工程src包下-->
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--sqlMapGenerator：sql映射文件生成策略（Mapper文件）-->
        <sqlMapGenerator targetPackage="com.letere.mapper"  targetProject=".\src\main\java"><!--当前工程resources目录下-->
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!--javaClientGenerator：生成mapper接口所在位置与方法-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.letere.dao"  targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!--table：关联数据库表，通过数据库表来逆向生成前面所有东西
            tableName：表名
            domainObject：生成JavaBean的名字
        -->
        <table  tableName="tbl_employee" domainObjectName="Employee" />
    </context>
</generatorConfiguration>

• 目录结构

2.2 使用代码生成器

• 代码生成器运行的方式有很多种，可看官方文档：http://mybatis.org/generator/running/running.html

• 下面是以Java运行xml文件的形式来举例
• 复制官方基本代码进行修改：http://mybatis.org/generator/running/runningWithJava.html
  • 注意代码导包会出现重复包，应选择导入以下包：
    • java.io.File;
    • org.mybatis.generator.config.xml.ConfigurationParser;

测试方法：只需修改配置文件路径即可
    @Test
    public void runningXmlByJava() throws Exception{
        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        File configFile = new File("src\\main\\resources\\mbg-config.xml");//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);
    }

• 代码运行，会发现在每个包下会自动相应的JavaBean、接口、配置文件