mybatis代码自动生成_mybatis自动生成-CSDN博客

本文链接：https://blog.csdn.net/huweijian5/article/details/89335377

mybatis代码自动生成

文章目录

mybatis代码自动生成

前言

在使用mybatis时最繁琐的就是要根据表写一大堆mapper,entity,xml，这些虽然简单，但这种重复性的工作又必须得做，身为程序员自然不能忍受这种体力活，于是想方设法能一键自动生成代码
下面列举了三种实现方式，第一种是利用Mybatis官方的工具库生成，第二种是利用了idea上的插件生成，第三种则是利用mybatis-plus的代码生成器

Mybatis官方实现

Mybatis官方说明：http://www.mybatis.org/generator/
Mybatis github地址：https://github.com/mybatis/generator
官方工具库下载地址：https://github.com/mybatis/generator/releases ，下载压缩文件如mybatis-generator-core-1.3.7.zip，解压后可以在里面找到mybatis-generator-core-1.3.7.jar
还需要下载mysql驱动，如mysql-connector-java-5.1.47.jar，下载地址：https://mvnrepository.com/artifact/mysql/mysql-connector-java
下载完工具库后最主要就是修改generatorConfig.xml实现生成代码的相关设置，然后运行bat即可

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">
<!--https://www.jianshu.com/p/cd8867af4389
https://www.cnblogs.com/shyroke/p/8042868.html-->
<generatorConfiguration>
    <classPathEntry location="mysql-connector-java-5.1.47.jar" />

    <context id="DB2Tables" targetRuntime="MyBatis3"  defaultModelType="flat">
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
       一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
    -->
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://172.16.11.192:3306/ics"
                        userId="reader"
                        password="reader">
        </jdbcConnection>

        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <javaModelGenerator targetPackage="com.xxx.ics.das.entity"  targetProject="..\..\das\src\main\java">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true" />
            <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="mybatis"  targetProject="..\..\das\src\main\resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
        <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
               targetPackage/targetProject:同javaModelGenerator
               type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
                   1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
                   2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
                   3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
               注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
           -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.xxx.ics.das.mapper"  targetProject="..\..\das\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
               选择的table会生成一下文件：
               1，SQL map文件
               2，生成一个主键类；
               3，除了BLOB和主键的其他字段的类；
               4，包含BLOB的类；
               5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
               6，Mapper接口（可选）

               tableName（必要）：要生成对象的表名；
               注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会
                   根据设置的schema，catalog或tablename去查询数据表，按照下面的流程：
                   1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询；
                   2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找；
                   3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找；
                   4，否则，使用指定的大小写格式查询；
               另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名；
               这个时候，请设置delimitIdentifiers="true"即可保留大小写格式；

               可选：
               1，schema：数据库的schema；
               2，catalog：数据库的catalog；
               3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
               4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
               5，enableInsert（默认true）：指定是否生成insert语句；
               6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
               7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
               8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
               9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
               10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
               11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
               12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
               13，modelType：参考context元素的defaultModelType，相当于覆盖；
               14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
               15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性

               注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写；
            -->
        <table schema="zhiot" tableName="tb_application" domainObjectName="Application" >
           <!--false则会采用驼峰命名法-->
            <property name="useActualColumnNames" value="fase"/>
           <!-- <generatedKey column="id" sqlStatement="MySql" identity="true" />
            <columnOverride column="DATE_FIELD" property="startDate" />
            <ignoreColumn column="FRED" />
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />-->
        </table>
        <table schema="zhiot" tableName="tb_sys_oauth_client" domainObjectName="OauthClient" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
        <table schema="zhiot" tableName="tb_sys_right" domainObjectName="Right" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
        <table schema="zhiot" tableName="tb_sys_role" domainObjectName="Role" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
        <table schema="zhiot" tableName="tb_sys_role_right" domainObjectName="RoleRight" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
        <table schema="zhiot" tableName="tb_sys_user" domainObjectName="User" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
        <table schema="zhiot" tableName="tb_sys_user_role" domainObjectName="UserRole" >
            <property name="useActualColumnNames" value="fase"/>
        </table>
    </context>
</generatorConfiguration>

在windows下运行bat

 java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml
 rem java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml -overwrite

主要文件如下：

idea插件实现

在idea的插件市场中搜索better-mybatis-generator和MyBatis Plus，这两个插件均能帮助我们快速生成代码，当然可能还有更多更好用的插件，只是觉得够用就好
另外推荐另一个插件Mybatis Tools，这个插件虽然不能代码生成，但它可以实现在xml中跳转到实体类，是个非常不错的工具

mybatis-plus实现

MyBatis-Plus官方文档：https://mp.baomidou.com/guide/generator.html
MyBatis-Plus也有对代码生成的支持，具体做法请参照官方说明

注意添加以下依赖

dependencies {
	implementation('com.baomidou:mybatis-plus-boot-starter:3.1.0')
    implementation('com.baomidou:mybatis-plus-generator:3.1.0')
    implementation('org.apache.velocity:velocity-engine-core:2.1')
    }

代码示例


import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");

        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("hwj");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/pms?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&serverTimezone=GMT%2B8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();

        //pc.setModuleName(scanner("模块名"));//如果需要模块名则打开

        pc.setParent("com.xxx.pms"); //修改为实际的包名

        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        //String templatePath = "/templates/mapper.xml.ftl";
        //mpg.setTemplateEngine(new FreemarkerTemplateEngine());//由于默认是velocity,如果用freemarker则必须设置

        // 如果模板引擎是 velocity
         String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {

            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mybatis/" + (pc.getModuleName()==null?"":pc.getModuleName()+"/")
                         + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        //设置超类的路径，注意这个超类是用户自己的，自动生成的类将继承于这个超类
        //strategy.setSuperEntityClass("com.xxx.pms.model.BaseEntity");
        //strategy.setSuperControllerClass("com.xxx.pms.controller.BaseController");
        //strategy.setSuperEntityColumns("id");

        strategy.setEntityLombokModel(true);

        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);

        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));


        //strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);

        mpg.execute();
    }

}

参考

代码生成器 | MyBatis-Plus
https://mp.baomidou.com/guide/generator.html
mybatis/generator: A code generator for MyBatis and iBATIS.
https://github.com/mybatis/generator
MyBatis Generator Core – Introduction to MyBatis Generator
http://www.mybatis.org/generator/
（二十二）SpringBoot之使用mybatis generator自动生成bean、mapper、mapper xml - shyroke、 - 博客园
https://www.cnblogs.com/shyroke/p/8042868.html