5.SpringBoot配置自动生成代码 - 技术博客
程序智享家
精彩内容加载中

5.SpringBoot配置自动生成代码

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

admin 2025-02-04 876 阅读 0 评论 java框架

一.Springboot配置代码生成插件

1.在pom.xml中引入代码生成器和freemarker模板引擎
<!-- mybatis-plus-generator代码生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>
<!-- freemarker模板引擎 -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>
2.在test文件夹下建一个运行类,用来运行main方法,这个根据自己的需求在哪写都可以,主要是生成代码的逻辑写好,然后调用就可以了。
package com.tms.tblog;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/***
 * 代码生成器 执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
 */
public class CodeGenerator {

    public static void main(String[] args) {
        System.out.println("=====================数据库配置=======================");
        String url = "jdbc:mysql://localhost:3306/tblog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC";
        String username = "root";
        String password = "root";
        String author = "lcj";
        String parentName = "com.tms";// 父包名
        String moduleName = "tblog";// 父包模块名
        String tableName = "customer";//表名,多个英文逗号分隔?所有输入 all
        AutoGenerator(url,
                username,
                password,
                author,
                parentName,
                moduleName,
                tableName);
    }

    /**
     * 自动生成代码调用方法
     * @param url 数据库地址
     * @param username 数据库用户名
     * @param password 数据库密码
     * @param author 作者
     * @param parentName 父包名
     * @param moduleName 父包模块名
     * @param tableName 表名,多个英文逗号分隔?所有输入 all
     */
    protected static void AutoGenerator(String url,
                                        String username,
                                        String password,
                                        String author,
                                        String parentName,
                                        String moduleName,
                                        String tableName) {
        FastAutoGenerator.create(url, username, password)
                // 全局配置
                .globalConfig(builder -> builder.author(author)// 设置作者名
                                .outputDir(System.getProperty("user.dir") + "/src/main/java") //设置输出路径:项目的 java 目录下
                                .commentDate("yyyy-MM-dd hh:mm:ss")//注释日期
                                .dateType(DateType.TIME_PACK)//定义生成的实体类中日期的类型 TIME_PACK=LocalDateTime;ONLY_DATE=Date;
                                .fileOverride()//覆盖之前的文件
//                        .enableSwagger()//开启 swagger 模式
                                .disableOpenDir() //禁止打开输出目录,默认打开
                )
                // 包配置
                .packageConfig(builder -> builder.parent(parentName)// 设置父包名
                        .moduleName(moduleName)//设置模块包名
                        .entity("entity") //entity 实体类包名
                        .service("service")//Service 包名
                        .serviceImpl("service.iImpl")// ***ServiceImpl 包名
                        .mapper("dao") //Mapper 包名
                        .xml("mapper") //Mapper XML 包名
                        .controller("controller") //Controller 包名
                        .other("utils")//自定义文件包名
                        .pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") + "/src/main/resources/mapper")) //配置 mapper.xml 路径信息:项目的 resources 目录下
                )
                // 策略配置
                .strategyConfig(builder -> {
                    builder.addInclude(getTables(tableName))// 设置需要生成的数据表名
                            .addTablePrefix("t_", "c_") // 设置过滤表前缀

                            // service 策略配置
                            .serviceBuilder()
                            .formatServiceFileName("%sService")//格式化 service 接口文件名称,%s进行匹配表名,如 UserService
                            .formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称,%s进行匹配表名,如 UserServiceImpl

                            // 实体类策略配置
                            .entityBuilder()        //实体类策略配置
                            .enableLombok()         //开启 Lombok
                            .disableSerialVersionUID() //不实现 Serializable 接口,不生产 SerialVersionUID
                            .logicDeleteColumnName("deleted")  //逻辑删除字段名
                            .naming(NamingStrategy.underline_to_camel) //数据库表映射到实体的命名策略:下划线转驼峰命
                            .columnNaming(NamingStrategy.underline_to_camel)  //数据库表字段映射到实体的命名策略:下划线转驼峰命
                            //添加表字段填充,"create_time"字段自动填充为插入时间,"modify_time"字段自动填充为插入修改时间
                            .addTableFills(
                                    new Column("create_time", FieldFill.INSERT),
                                    new Column("modify_time", FieldFill.INSERT_UPDATE))
                            .enableTableFieldAnnotation()       // 开启生成实体时生成字段注解

                            // Controller策略配置
                            .controllerBuilder()
                            .formatFileName("%sController")//格式化 Controller 类文件名称,%s进行匹配表名,如 UserController
                            .enableRestStyle() //开启生成 @RestController 控制器

                            // Mapper策略配置
                            .mapperBuilder()
                            .superClass(BaseMapper.class) //设置父类
                            .formatMapperFileName("%sMapper")  //格式化 mapper 文件名称
                            .enableMapperAnnotation()       //开启 @Mapper 注解
                            .formatXmlFileName("%sMapper"); //格式化 Xml 文件名称
                })
                //5、模板
                .templateEngine(new FreemarkerTemplateEngine())
                /*
                        .templateEngine(new VelocityTemplateEngine())
                        .templateEngine(new FreemarkerTemplateEngine())
                        .templateEngine(new BeetlTemplateEngine())
                        */
                //6、执行
                .execute();
                /*
                模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                .templateEngine(new BeetlTemplateEngine())
                .templateEngine(new FreemarkerTemplateEngine())

                .execute();    */
    }

    // 处理 all 情况
    protected static List<String> getTables(String tables) {
        return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
    }

}

二,运行效果

代码已经写好了,接下来运行CodeGenerator文件的这个main方法,运行完之后控制台会打印出生成结果

生成完之后查看一下生成文件

三.总结

MyBatis-Plus自动生成代码简单的配置就是这样,在实际用的时候,可以根据自己的需求和个性自定义自己比较喜欢的代码样式和模板。

推荐阅读

7.SpringBoot使用Aop监控接口的执行状况 AOP(Aspect Oriented Programming),即面向切面编程,可以说是OOP(Object Oriented Programming,面向对… 4.SpringBoot配置MyBatis-Plus MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBa… 3.Springboot配置跨域 Springboot配置跨域有很多种方式,今天我们来看一下有哪几种方式,第一种方法还是比较常见的。… 2.SpringBoot配置lombok Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法,以及toString, hashCode等可能不会用到,但是某些时候仍然需要… 1.SpringBoot框架搭建 Spring Boot 是 Pivotal 团队在 Spring 的基础上提供的一套全新的开源框架,其目的是为了简化 Spring 应用的搭建和开发过程。… 8.Springboot整合log4j2日志 Apache Log4j 2 是对 Log4j 的升级,它比其前身 Log4j 1.x 提供了重大改进,并提供了 Logback 中可用的许多改进,同时修复了 … 9.SpringBoot配置Redis Redis(Remote Dictionary Server ),即远程字典服务,是一个开源的使用ANSI C语言编写、支持网络、可基于内存亦可持久化的日志型、… 10.SpringBoot配置Druid连接池 连接池的作用是为了提高性能,将已经创建好的连接保存在池中,当有请求来时,直接使用已经创建好的连接对Server端进行访问。这样省略(复用)了创建连接和销毁连接的… 11.SpringBoot配置Swagger3 Swagger3(也被称为OpenAPI 3)是一个开放源代码项目,它定义了用于描述、生产、消费和可视化RESTful Web服务的规范。… 12.SpringBoot统一异常处理 在 Spring Boot 应用中,统一异常处理是一种非常实用的技术,它可以帮助我们集中管理和处理应用程序中抛出的异常,避免在每个控制器方法中重复编写异常处理代… 13.SpringBoot配置Thymeleaf Thymeleaf是一个java类库,他是一个优秀的、面向Java 的xml/xhtml/html5的模板引擎,可以作为mvc的web应用的view层,具有丰富… 14.SpringBoot图片文件上传 图片文件上传是经常会用到的功能,尤其是做一些大型企业网站。… 15.Springboot多模块配置 在开发大型项目时,使用 Spring Boot 多模块配置可以将项目拆分成多个独立的模块,便于团队协作开发、代码管理和维护。以下为你详细介绍 Spring Bo… 16.SpringBoot配置SSL证书 在 Spring Boot 中配置 SSL 证书可以为应用程序提供安全的 HTTPS 连接,增强数据传输的安全性。… 17.SpringBoot项目打包成jar包 打包springboot项目有两种方法,一个是直接通过mvn命令打包,另一个是使用工具打包,例如idea… 18.SpringBoot实现图片压缩 在上传图片的时候进行图片压缩,这样虽然破环了原图片的清晰度,不影响图片的美感,博客用来作为缩略图正好。… 19.Java生成sitemap网站地图 Sitemap(网站地图)在网站管理和搜索引擎优化(SEO)中扮演着重要角色。在Java中生成网站地图(sitemap)通常涉及创建一个XML文件,该文件列出了… 20.springboot使用Jsoup解析html,抓取一个网站上的全部链接 soup 是一款Java 的HTML解析器,可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery… 21.Springboot使用Jsoup和sitemapgen4j动态生成网站地图 Sitemapgen4j是一个使用Java编写的Sitemap输出库包,通过使用SitemapGen4j你可以可以添加任意数量的URL,可以得到gzip压缩输出…

评论 (0)

暂无评论,快来抢沙发吧