MyBatis的逆向工程

概念

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

1. 创建逆向工程

添加依赖和插件

<dependencies>
    <!-- MyBatis核心 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>
    
    <!-- MySQL驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.27</version>
    </dependency>
    
    <!-- log4j日志 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
    
    <!-- junit测试 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </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.27</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

创建MyBatis的核心配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="jdbc.properties"/>
    
    <typeAliases>
        <package name="com.example.pojo"/>
    </typeAliases>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <package name="com.example.mapper"/>
    </mappers>
</configuration>

创建逆向工程的配置文件

文件名必须是：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/mybatis"
                        userId="root"
                        password="123456">
        </jdbcConnection>
        
        <!-- javaBean的生成策略 -->
        <javaModelGenerator targetPackage="com.example.pojo"
                            targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        
        <!-- SQL映射文件的生成策略 -->
        <sqlMapGenerator targetPackage="com.example.mapper"
                         targetProject="./src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        
        <!-- Mapper接口的生成策略 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.example.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>

提示

Mac 和 Linux 系统需要把路径中的 \ 改成 /

执行MBG插件的generate目标

在 Maven 面板中找到 mybatis-generator 插件，双击 mybatis-generator:generate 执行。

2. QBC查询

逆向工程生成的 MyBatis3 版本会生成 XxxExample 类，用于构建复杂的查询条件。

基本查询

@Test
public void testMBG() {
    EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
    
    // 查询所有数据
    List<Emp> list = mapper.selectByExample(null);
    list.forEach(System.out::println);
}

条件查询

@Test
public void testMBGByExample() {
    EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
    
    // 创建条件对象
    EmpExample example = new EmpExample();
    
    // 创建条件
    example.createCriteria()
           .andEmpNameEqualTo("张三")
           .andAgeGreaterThan(20);
    
    // 或者条件
    example.or()
           .andSexEqualTo("男");
    
    List<Emp> list = mapper.selectByExample(example);
    list.forEach(System.out::println);
}

选择性修改

@Test
public void testUpdateByPrimaryKeySelective() {
    EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
    
    Emp emp = new Emp(1, "admin", null, null, null, null);
    
    // 选择性修改：只修改不为null的字段
    mapper.updateByPrimaryKeySelective(emp);
}

常用方法

方法	说明
selectByExample	根据条件查询
selectByPrimaryKey	根据主键查询
insert	插入（全字段）
insertSelective	选择性插入（只插入不为null的字段）
updateByPrimaryKey	根据主键修改（全字段）
updateByPrimaryKeySelective	根据主键选择性修改
updateByExample	根据条件修改（全字段）
updateByExampleSelective	根据条件选择性修改
deleteByPrimaryKey	根据主键删除
deleteByExample	根据条件删除
countByExample	根据条件统计数量