Mybatis逆向工程笔记小结_Java

1.前言

我们在开发传统的maven项目或者springboot项目过程中，最终处理的就是对于数据的读与存，这时就免不了写对象关系映射代码，实体类、mapper、mapper.xml等代码，若存在大量的增删改查功能的话，我们开发时就会不断重复相同的操作，大大降低了工作效率。

为此便但成了mybatis “逆向工程” ，所谓逆向工程，就是从数据库表结构出发，反向去生成对应的实体和映射代码，今天我们在这里提供2种方案进行实现。

2.实现方案

2.1. mybatis-generator生成

2.1.1. 环境说明

1）springboot 项目（jdk1.8）
2）apache-maven-3.6.1
3）mysql 8.0.30

2.1.2. 数据库表

逆向工程的第一步，需要先有数据库表结构！我们在这里先创建一个表，作为示例使用，sql脚本如下：

--若已存在，先删除
drop table user 
-- 创建数据库用户表
create table user (
	id int not null auto_increment comment '主键',
	name varchar(100) default null comment '员工姓名',
	phone_num varchar(20) default null comment '联系方式',
	address varchar(200) default null comment '住址',
	primary key (`id`)
) engine=innodb default charset=utf8mb4 collate=utf8mb4_general_ci;

2.1.3 添加maven依赖

逆向工程的实现，需要先引入mybatis相关依赖，如果项目中已经引入过，可自动忽略这一步。我们主要需要mybatis，mysql基础依赖，以及mybatis提供的生成器依赖

 <dependencies>
        <!-- mybatis-generator -->
        <dependency>
            <groupid>org.mybatis.generator</groupid>
            <artifactid>mybatis-generator-core</artifactid>
            <version>1.3.7</version>
        </dependency>
        <dependency>
            <groupid>org.mybatis.spring.boot</groupid>
            <artifactid>mybatis-spring-boot-starter</artifactid>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupid>mysql</groupid>
            <artifactid>mysql-connector-java</artifactid>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
    </dependencies>

2.1.4 数据库连接配置

依赖与数据库表创建好之后，我们就正式进入了springboot项目中进行逆向工程开发啦，首先在resources目录下创建一个数据库连接的配置文件：generator.properties

jdbc.driverclass=com.mysql.cj.jdbc.driver
jdbc.connectionurl=jdbc:mysql://localhost:3306/vhr?useunicode=true&characterencoding=utf-8&servertimezone=asia/shanghai
jdbc.userid=root
jdbc.password=123456

2.1.5 配置生成规则

数据库配置完成后，我们紧接着来设置一个生成规则，包括编码，生成文件路径、是否设置自定义注释等等，这个配置可以从网上搜，有很多generatorconfiguration的配置。直接cv稍作修改即可

<?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>
    <!--根据配置文件读取数据库表信息-->
    <properties resource="generator.properties"/>
    <context id="mysqlcontext" targetruntime="mybatis3" defaultmodeltype="flat">
        <!--前置分隔符-->
        <property name="beginningdelimiter" value="`"/>
        <!--后置分隔符-->
        <property name="endingdelimiter" value="`"/>
        <!--设置编码-->
        <property name="javafileencoding" value="utf-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.serializableplugin"/>
        <!-- 为生成的java模型创建一个tostring方法 -->
        <plugin type="org.mybatis.generator.plugins.tostringplugin"/>
        <!--生成mapper.xml时覆盖原文件-->
        <plugin type="org.mybatis.generator.plugins.unmergeablexmlmappersplugin" />
        <!--可以自定义生成model的代码注释-->
        <commentgenerator type="org.javaboy.vhr.utils.commentgenerator">
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressallcomments" value="true"/>
            <property name="suppressdate" value="true"/>
            <property name="addremarkcomments" value="true"/>
        </commentgenerator>
        <!--配置数据库连接-->
        <jdbcconnection driverclass="${jdbc.driverclass}"
                        connectionurl="${jdbc.connectionurl}"
                        userid="${jdbc.userid}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullcatalogmeanscurrent" value="true" />
        </jdbcconnection>
        <!--指定生成model的路径-->
        <javamodelgenerator targetpackage="org.javaboy.vhr.pojo" targetproject="vhr-web\src\main\java"/>
        <!--指定生成mapper.xml的路径-->
        <sqlmapgenerator targetpackage="mybatis.mapper" targetproject="vhr-web\src\main\resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaclientgenerator type="xmlmapper" targetpackage="org.javaboy.vhr.mapper"
                             targetproject="vhr-web\src\main\java"/>
        <!--单独生成某个表，写具体表名，否则生成全部表tablename设为%-->
        <table tablename="user" enablecountbyexample="false" enableupdatebyexample="false" enabledeletebyexample="false"
               enableselectbyexample="false" selectbyexamplequeryid="false">
            <property name="useactualcolumnnames" value="false"/>
            <property name="constructorbased" value="false"/>
            <generatedkey column="id" sqlstatement="jdbc" identity="true"/>
        </table>

    </context>
</generatorconfiguration>

2.1.6 自定义实体类注释配置

由于在上一步我们配置了注释生成器，因此，我们要在相应的路径下，创建一个类，来自定义注释的生成规则。路径：org.javaboy.vhr.utils.commentgenerator

<commentgenerator type="org.javaboy.vhr.utils.commentgenerator">
    <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
    <property name="suppressallcomments" value="true"/>
    <property name="suppressdate" value="true"/>
    <property name="addremarkcomments" value="true"/>
</commentgenerator>

commentgenerator代码

**
 * @author 86138
 * @date 2024-05-01 13:27:15
 * @description 添加自定义注释
 */
public class commentgenerator extends defaultcommentgenerator {
    private boolean addremarkcomments = false;

    /**
     * 设置用户配置的参数
     */
    @override
    public void addconfigurationproperties(properties properties) {
        super.addconfigurationproperties(properties);
        this.addremarkcomments = stringutility.istrue(properties.getproperty("addremarkcomments"));
    }

    /**
     * 给字段添加注释
     */
    @override
    public void addfieldcomment(field field, introspectedtable introspectedtable,
                                introspectedcolumn introspectedcolumn) {
        string remarks = introspectedcolumn.getremarks();
        //根据参数和备注信息判断是否添加备注信息
        if (addremarkcomments && stringutility.stringhasvalue(remarks)) {
            addfieldjavadoc(field, remarks);
        }
    }

    /**
     * 给model的字段添加注释
     */
    private void addfieldjavadoc(field field, string remarks) {
        //文档注释开始
        field.addjavadocline("/**");
        //获取数据库字段的备注信息
        string[] remarklines = remarks.split(system.getproperty("line.separator"));
        for (string remarkline : remarklines) {
            field.addjavadocline(" * " + remarkline);
        }
        addjavadoctag(field, false);
        field.addjavadocline(" */");
    }
}

2.1.7 使用生成器

以上步骤做完后，我们就要写我们的逆向工程生成器啦，调用org.mybatis.generator.api中的mybatisgenerator生成器进行实现。注意：当生成的代码重复时，覆盖原代码！直接执行下述generator类的main方法，就会自动读取数据库中的表，并生成对应的实体类与映射

public class generator {
    public static void main(string[] args) throws exception {
        //mbg 执行过程中的警告信息
        list<string> warnings = new arraylist<string>();
        //当生成的代码重复时，覆盖原代码
        boolean overwrite = true;
        //读取我们的 mbg 配置文件
        inputstream is = generator.class.getresourceasstream("/generatorconfig.xml");
        configurationparser cp = new configurationparser(warnings);
        configuration config = cp.parseconfiguration(is);
        is.close();

        defaultshellcallback callback = new defaultshellcallback(overwrite);
        //创建 mbg
        mybatisgenerator mybatisgenerator = new mybatisgenerator(config, callback, warnings);
        //执行生成代码
        mybatisgenerator.generate(null);
        //输出警告信息
        for (string warning : warnings) {
            system.out.println(warning);
        }
    }
}

2.2. mybatisx插件生成(推荐)

基于方案一，我们可以快速的根据数据库中的表进行逆向工程的创建，大量的减少了我们的重复性工作，但是！它的实现还是比较复杂的，generatorconfiguration配置中的内容丰富且复杂，比较难记，而且在原有代码中需要写一定的代码量才能实现。

接下来我们要说的这种方案二，几乎不用写任何代码，只需要点点点就可以实现逆向工程啦，如果你使用idea的话，这种方案尤其方便。

2.2.1 下载idea插件

在插件管理中下载mybatisx插件

2.2.2 配置数据源

在idea的database中配置数据源，这里以mysql为例，需要注意时区的配置。

2.2.3 配置maven依赖

<!--lombok依赖-->
 <dependency>
     <groupid>org.projectlombok</groupid>
     <artifactid>lombok</artifactid>
     <optional>true</optional>
 </dependency>
 <!--mybatis plus依赖-->
 <dependency>
     <groupid>com.baomidou</groupid>
     <artifactid>mybatis-plus-boot-starter</artifactid>
     <version>3.1.0</version>
 </dependency>

2.2.4 配置生成规则

打开刚刚配置好的本地数据库，选择你想构建的数据表，右键 -> mybatisx-generator。