还在手动创建pojo吗?代码一键生成它不香吗?(代码片段)

jiangxiaoju jiangxiaoju     2022-10-21     366

关键词:

原创不易,未经允许,请勿转载。

博客主页:https://xiaojujiang.blog.csdn.net/

在写SpringBoot项目,有时候设计到的表有几十上百张,如果要一个一个手动创建JavaBean以及对应的mapper类的话,虽然支持CV的过程。但是也让人很头大。

好在Myabtis-Plus提供了一个代码生成器,可以帮助我们根据表生成对应的controller、service、mapper、entity。

接下来看看如何使用这个代码生成器。

首先在项目中加入代码生成器的依赖

当前最新版本是3.4.2。具体可以到官网去查看。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.2</version>
</dependency>

接着要加入模板引擎。默认是使用Velocity。Freemarker、Beetl也可以。

Velocity(默认):

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

Freemarker:

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

Beetl:

<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.3.2.RELEASE</version>
</dependency>

代码用法解释

完整代码在文末。

这个部分内容不用管。就是用来读入一些输入用的。

 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.isNotBlank(ipt)) 
                return ipt;
            
        
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    

用来设置生成的文件存放位置。默认是在当前项目的目录下。可以自行修改。

还可以设置是否加上swagger注解。默认是没有的。 需要的话,可以把下方的这个注释删掉。

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

这个就是配置数据库的地址、用户名和密码了

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");

设置代码的包名和模块名


        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");

模板引擎的设置
根据你选择的模板引擎,选择对应的模板引擎路径。


        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 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/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            
        );

如果模板引擎不是用默认的Vecity的话。记得设置对应的模板引擎

// set freemarker engine
mpg.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
mpg.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
mpg.setTemplateEngine(new CustomTemplateEngine());

最后设置列名的明明方式、是否加Lombok、使用restController等

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");

完整代码


// 演示例子,执行 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.isNotBlank(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("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

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

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 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/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            
        );
        /*
        cfg.setFileCreate(new IFileCreate() 
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) 
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录,自定义目录用");
                if (fileType == FileType.MAPPER) 
                    // 已经生成 mapper 文件判断存在,不想重新生成返回 false
                    return !new File(filePath).exists();
                
                // 允许生成模板文件
                return true;
            
        );
        */
        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("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    


拒绝白嫖从一键三连开始!

原创不易,未经允许,请勿转载。

博客主页:https://xiaojujiang.blog.csdn.net/

本地没有环境跑深度学习模型?阿里云天池实验室它不香吗(代码片段)

一、前言前几天做深度学习模型训练使用Google的colab总是掉,搞得很烦。然后那天我队友“叶伏天”和我说有一个类似于Googlecolab的平台,可以训练,虽然也有8小时的限时,但是这两个我可以替换使用,甚至一... 查看详情

数据中台为什么要建标签体系,分类它不香吗?

来源:谈数据,作者:石秀峰全文共3678个字,建议阅读6分钟大家好,我是云祁,好久不见 👋 最近一直忙于新工作填坑ing... 原创更新的频率变低了不少,掐指一算上一篇原创emmmmm 还是一个多月... 查看详情

热部署只知道devtools吗?jrebel不香吗?

持续原创输出,点击上方蓝字关注我目录前言JRebel收费怎么破?什么是本地热部署?什么是远程热部署?JRebel和devtools的区别如何安装JRebel?如何本地热部署?如何远程热部署?多模块开发的一个坑总结前言SpringBoot中的热部署相... 查看详情

别再这么写代码了,这几个方法不香吗?(代码片段)

...,让我们开发起来多了很多便利。不过最近Review项目代码的时候发现,虽然很多项目工程已经使用了JDK8,但是工程代码却很少使用到JDK8新特性、新方法。如果单从代码正确性上来说,老方式写法写当然没有什么... 查看详情

[每日一题]requestanimationframe不香吗?

关注「松宝写代码」,精选好文,每日一题时间永远是自己的每分每秒也都是为自己的将来铺垫和增值作者:saucxs|songEagle一、前言2020.12.23日刚立的flag,每日一题,题目类型不限制,可以是:算法... 查看详情

我们为什么从webpack转向vite,早点下班不香吗?(代码片段)

全文3000字,欢迎点赞关注转发一、Vite是什么2020年4月,尤大大发了这么一个推:随后,2021年2月,Vite2.0它来了,上来就是一套组合拳:基于esbuild实现的极速开发体验多框架支持兼容Rollup的插件机制与AP... 查看详情

数据中台的oneid是个什么鬼,主数据它不香吗?

来源:谈数据,作者:石秀峰全文共3188个字,建议阅读6分钟如题!这个问题一直困扰了我很久,在阿里的数据中台中,有三个主要的组成部分OneID、OneData和OneService。我之前写的一篇文章曾对阿里的数... 查看详情

别再用visio了!试试这个比它快10倍的画图工具不香吗?(代码片段)

总有童鞋问,这个流程图图怎么绘制的,这个UML类图用什么工具做的等等,今天给大家推荐一款idea插件PlantUml,来帮助大家快速快速完成绘制。掌握之后,效率是visio等其他工具的10倍,甩的他们尾灯都看... 查看详情

es不香吗,为啥还要clickhouse?

点击上方“朱小厮的博客”,选择“设为星标”后台回复"书",获取后台回复“k8s”,可领取k8s资料Elasticsearch是一个实时的分布式搜索分析引擎,它的底层是构建在Lucene之上的。简单来说是通过扩展Lucene的... 查看详情

es不香吗,为啥还要clickhouse?

点击上方“朱小厮的博客”,选择“设为星标”后台回复"书",获取后台回复“k8s”,可领取k8s资料Elasticsearch是一个实时的分布式搜索分析引擎,它的底层是构建在Lucene之上的。简单来说是通过扩展Lucene的... 查看详情

地下管孔资源紧张,气吹微缆不香吗?

1  前言微缆是一种缆径不足同容量普通管道光缆(以下简称“普缆”)1/2的特种光缆。由于缆径较细、机械性能较差,微缆不能采用传统的人工布放方式,而只能采用气吹方式布放在一种外径略大于微缆的微管... 查看详情

地下管孔资源紧张,气吹微缆不香吗?

1  前言微缆是一种缆径不足同容量普通管道光缆(以下简称“普缆”)1/2的特种光缆。由于缆径较细、机械性能较差,微缆不能采用传统的人工布放方式,而只能采用气吹方式布放在一种外径略大于微缆的微管... 查看详情

docker不香吗?为什么还要用k8s

本文禁止转载!目录容器化时代来了容器化技术的尖刀武器Docker横空出世Docker怎么用?编排系统的需求催生k8sk8s与DockerSwarm江湖恩怨k8s是做什么用的?K8s架构和组件Docker与k8s难舍难分开发实践,灵魂追问最后一个... 查看详情

docker不香吗?为什么还要用k8s

本文禁止转载!目录容器化时代来了容器化技术的尖刀武器Docker横空出世Docker怎么用?编排系统的需求催生k8sk8s与DockerSwarm江湖恩怨k8s是做什么用的?K8s架构和组件Docker与k8s难舍难分开发实践,灵魂追问最后一个... 查看详情

大厂大批招聘c/c++工程师,掌握了c/c++的程序员他不香吗

...;+在近30年里经久不衰,并且现在学习C++的人还在逐年增长。究其原因,是C++有着独特优势。C++是编程语言中的**“万能选手”**,它的适用领域非常广泛,许多新的编程语言都从它身上汲取了... 查看详情

还在手写数据库设计文档?java一键生成(代码片段)

🍅作者主页:Java李杨勇 🍅简介:Java领域优质创作者🏆、【java李杨勇】公号作者✌ 简历模板、学习资料、面试题库【关注我,都给你】🍅文末获取源码联系🍅前言:以前我们还需要手写数... 查看详情

还在手写数据库设计文档?java一键生成(代码片段)

🍅作者主页:Java李杨勇 🍅简介:Java领域优质创作者🏆、【java李杨勇】公号作者✌ 简历模板、学习资料、面试题库【关注我,都给你】🍅文末获取源码联系🍅前言:以前我们还需要手写数... 查看详情

还在纠结配色问题?手把手教你用matlab一键生成高质量色卡(代码片段)

好久没写APPdesigner工具了,于是写了一个一键生成色卡工具,效果如下:可以自定义颜色数量,颜色格式,生成的色卡还能一键保存,保存效果:1使用流程点击LoadImg按钮导入图片更改ColorNum制定颜色数... 查看详情