Springboot 根据数据库表自动生成实体类和Mapper，只需三步

超、凢脫俗 2023-09-28 15:02 10阅读 0赞

# 前言 #

#  #

# 大家看看下面这个对话： #

![a616114b0fd64611bff3d0a4172edf3b.jpeg][]

> ps：你...不会就是诡计多端的吴工吧？ 如果恰好是，也没事。  
> 看完这一篇，学习只有先知和后知，你看完学会了知道了，就行。

## 本篇内容： ##

**根据数据库的表 自动生成 代码：**

###    ①相关的实体类（包含表字段注释）   ②相关mapper接口（包含增删改查）   ③相关mapper.xml （包含增删改查） ###

不多说，开始实战演练。

# 正文 #

先看下我们三步之后做了些啥，工程目录结构 ：

> 每个红色框就是一步， 三个框，足矣。

![b5fb76e27e8c429eaa6e897e761ad122.png][]

开始开始

**前提**

准备好数据库、表（需要生成实体类、mapper的表）：

这是演示实战，就整2张表意思一下：

![787df21ca9c444949f138c8f57bb6d4f.png][]

表my\_account

![3141795a5067478d9442dc079fc18d5f.png][]

表my\_user

![d86b5b83f4554a52afd3cd3d21d69297.png][]

# **第一步 pom引入依赖** #

<dependencies>
            
            <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>

## 第二步 创建自动生成代码配置 ##

![b55b91b0afc64ca5a8a42cfe26a9cb92.png][]

配置文件一 ，用于生成代码时连接数据库拿表数据的。

generator.properties ：

jdbc.driverClass=com.mysql.cj.jdbc.Driver
    jdbc.connectionURL=jdbc:mysql://localhost:3306/my_test_db?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    jdbc.userId=root
    jdbc.password=123456

配置文件二 ，用于生成代码时 指定生成的 目录路径、代码函数等。

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>
        <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"/>
            
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
            
            <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
            
            <commentGenerator type="com.demo.mybatisgen.util.CommentGenerator">
                
                <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}">
                
                <property name="nullCatalogMeansCurrent" value="true" />
            </jdbcConnection>
            
            <javaModelGenerator targetPackage="com.demo.mybatisgen.model" targetProject="src\main\java"/>
            
            <sqlMapGenerator targetPackage="mybatis.mapper" targetProject="src\main\resources"/>
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.demo.mybatisgen.mapper"
                                 targetProject="src\main\java"/>
            
            <table tableName="%" 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>

这个是使用备注添加器（第三步的内容）：

![5515db7197c949dd9dfadbbece67a786.png][]

## 第三步 创建代码生成器 Generator ##

![cac2c14c7ca3428ebd9b4a1f3573bef0.png][]

CommentGenerator.java：

import org.mybatis.generator.api.IntrospectedColumn;
    import org.mybatis.generator.api.IntrospectedTable;
    import org.mybatis.generator.api.dom.java.Field;
    import org.mybatis.generator.internal.DefaultCommentGenerator;
    import org.mybatis.generator.internal.util.StringUtility;
    
    import java.util.Properties;
    
    
    /**
     * @Author: JCccc
     * @Date: 2022-7-13 10:09
     * @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(" */");
        }
    
    }

Generator.java ：

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.InputStream;
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * @Author: JCccc
     * @Date: 2022-7-13 10:09
     * @Description: 点它
     */
    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);
            }
        }
    }

**好了，三步都完事了，再多一步当我输。**

![3c79eb18513849ddac72a485ad75d75a.png][]

然后点击一下代码生成器Generator 的 main方法：  
  
![3349f7bf48264efda194c558aac8fc16.png][]

可以看到代码生成了：  
  
![c972d8fe54384651a9da3b0979e10e90.png][]

生成代码的路径就是 generatorConfig.xml 配置的：  
![9d473a2b6d1e4cd58074ff7e6c542456.png][]

看看实体：  
![157d472dbcb543799eb5e2431353b065.png][]

看看interface mapper（大部分单表的增删改查函数都生成了）：

![24c91397b8db455ebb4b656a9822ac63.png][]

再看看mapper.xml （都有都有）：

![646ef7452259456f9897e3cc49d6d037.png][]

复制粘贴，三步完成，我看看以后谁还不会！

该篇就到这吧。

[a616114b0fd64611bff3d0a4172edf3b.jpeg]: https://img-blog.csdnimg.cn/a616114b0fd64611bff3d0a4172edf3b.jpeg
[b5fb76e27e8c429eaa6e897e761ad122.png]: https://img-blog.csdnimg.cn/b5fb76e27e8c429eaa6e897e761ad122.png
[787df21ca9c444949f138c8f57bb6d4f.png]: https://img-blog.csdnimg.cn/787df21ca9c444949f138c8f57bb6d4f.png
[3141795a5067478d9442dc079fc18d5f.png]: https://img-blog.csdnimg.cn/3141795a5067478d9442dc079fc18d5f.png
[d86b5b83f4554a52afd3cd3d21d69297.png]: https://img-blog.csdnimg.cn/d86b5b83f4554a52afd3cd3d21d69297.png
[b55b91b0afc64ca5a8a42cfe26a9cb92.png]: https://img-blog.csdnimg.cn/b55b91b0afc64ca5a8a42cfe26a9cb92.png
[5515db7197c949dd9dfadbbece67a786.png]: https://img-blog.csdnimg.cn/5515db7197c949dd9dfadbbece67a786.png
[cac2c14c7ca3428ebd9b4a1f3573bef0.png]: https://img-blog.csdnimg.cn/cac2c14c7ca3428ebd9b4a1f3573bef0.png
[3c79eb18513849ddac72a485ad75d75a.png]: https://img-blog.csdnimg.cn/3c79eb18513849ddac72a485ad75d75a.png
[3349f7bf48264efda194c558aac8fc16.png]: https://img-blog.csdnimg.cn/3349f7bf48264efda194c558aac8fc16.png
[c972d8fe54384651a9da3b0979e10e90.png]: https://img-blog.csdnimg.cn/c972d8fe54384651a9da3b0979e10e90.png
[9d473a2b6d1e4cd58074ff7e6c542456.png]: https://img-blog.csdnimg.cn/9d473a2b6d1e4cd58074ff7e6c542456.png
[157d472dbcb543799eb5e2431353b065.png]: https://img-blog.csdnimg.cn/157d472dbcb543799eb5e2431353b065.png
[24c91397b8db455ebb4b656a9822ac63.png]: https://img-blog.csdnimg.cn/24c91397b8db455ebb4b656a9822ac63.png
[646ef7452259456f9897e3cc49d6d037.png]: https://img-blog.csdnimg.cn/646ef7452259456f9897e3cc49d6d037.png