逆向工程MBG(MyBatis Generator)

概述

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

官方文档地址 ： 链接: http://www.mybatis.org/generator/

官方工程地址：

链接: https://github.com/mybatis/generator/releases

逆向工程与正向工程的区别

• 正向工程：先创建Java实体类，由框架负责根据实体类生成数据库表。 Hibernate是支持正向工 程的。
• 逆向工程：先创建数据库表，由框架负责根据数据库表，反向生成如下资源：

• Java实体类
• Mapper接口
• Mapper映射文件

创建逆向工程的步骤

①添加依赖和插件

<!-- 依赖MyBatis核心包 -->
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
        <!-- junit测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

        <!-- log4j日志 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.32</version>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.2.0</version>
        </dependency>
    </dependencies>

    <!-- 控制Maven在构建过程中相关配置 -->
    <build>

        <!-- 构建过程中用到的插件 -->
        <plugins>

            <!-- 具体插件，逆向工程的操作是以构建过程中插件形式出现的 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.0</version>

                <!-- 插件的依赖 -->
                <dependencies>

                    <!-- 逆向工程的核心依赖 -->
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>

                    <!-- MySQL驱动 -->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.32</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

②创建MyBatis的核心配置文件，即 mybatis-config.xml

③创建逆向工程的配置文件（文件名必须是：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>
    <!--
            targetRuntime: 执行生成的逆向工程的版本
                    MyBatis3Simple: 生成基本的CRUD（清新简洁版）
                    MyBatis3: 生成带条件的CRUD（奢华尊享版）
     -->
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <!-- 数据库的连接信息 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"
                        userId="root"
                        password="root">
        </jdbcConnection>
        <!-- javaBean的生成策略-->
        <javaModelGenerator targetPackage="com.zrb.pojo" targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- SQL映射文件的生成策略 -->
        <sqlMapGenerator targetPackage="com.zrb.mapper"  targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
        <!-- Mapper接口的生成策略 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.zrb.mapper"  targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        <!-- 逆向分析的表 -->
        <!-- tableName设置为*号，可以对应所有表，此时不写domainObjectName -->
        <!-- domainObjectName属性指定生成出来的实体类的类名 -->
        <table tableName="t_emp" domainObjectName="Emp"/>
        <table tableName="t_dept" domainObjectName="Dept"/>
    </context>
</generatorConfiguration>

其中

driverClass：为注册驱动，如果mysql是8版本后的，用com.mysql.cj.jdbc.Driver，如果是5版本的，去掉cj，即com.mysql.jdbc.Driver

connectionURL：连接数据库jdbc:mysql://ip地址:端口号/数据库，如果连接的是本机ip，且端口号为3306，localhost:3306可以不写，serverTimezone=UTC是设置时区，如果出现The server time zone value ‘?й???’ is unrecognized错误。就在后面加上serverTimezone=UTC

userId：数据库账号

password：数据库密码

其中

targetPackage：值为设置的包名，包名可以是不存在的，会自动创建

targetProject：值为项目目录名，且必须是已存在的，否则会报错，targetProject的值的起始目录为当前子模块目录

property中

• name的值enableSubPackages为是否允许通过tableName即表生成子包，即如果后面的value的值为true，如果包名为com.zrb.pojo，如果table中指定tableName对应的domainObjectName为Emp，那么实体类文件最终会生成在com.zrb.Emp目录（其中：domainObjectName属性指定生成出来的实体类的类名）
• trimStrings后value的值为true，为Setter方法对字符串类型进行一次trim操作，即对表的字段名进行去除两边的空格操作

④执行MBG插件的generate目标

1. 点击idea右上角的maven选项
2. 点击具有与MyBatis Generator有关插件的模块中的Plugins

3. 然后双击mybatis-generator 中的mybatis-generator:generate

MyBatis逆向工程之QBC查询风格

Query By Criteria：根据条件查询，即条件都是定义好的，只需要调用相对应的方法，就可以生成标准的条件

相关的代码使用

@Test
public void testMBG(){
try {
		InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
		SqlSessionFactory sqlSessionFactory = new
		SqlSessionFactoryBuilder().build(is);
		SqlSession sqlSession = sqlSessionFactory.openSession(true);
		EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
		//查询所有数据
		/*List<Emp> list = mapper.selectByExample(null);
		list.forEach(emp -> System.out.println(emp));*/
		//根据条件查询
		/*EmpExample example = new EmpExample();
		example.createCriteria().andEmpNameEqualTo("张
		三").andAgeGreaterThanOrEqualTo(20);
		example.or().andDidIsNotNull();
		List<Emp> list = mapper.selectByExample(example);
		list.forEach(emp -> System.out.println(emp));*/
		mapper.updateByPrimaryKeySelective(new
		Emp(1,"admin",22,null,"[e-mail]",3));
	} catch (IOException e) {
		e.printStackTrace();
	}
}