• (九)admin-boot项目之代码生成器


    (九)代码生成器

    项目地址:https://gitee.com/springzb/admin-boot
    如果觉得不错,给个 star

    简介:
    这是一个基础的企业级基础后端脚手架项目,主要由springboot为基础搭建,后期整合一些基础插件例如:redis、xxl-job、flowable、minioio、easyexcel、skyWalking、rabbitmq

    一、引入maven依赖

    
        
        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-generatorartifactId>
            <version>3.5.1version>
        dependency>
    
        
        <dependency>
            <groupId>org.apache.velocitygroupId>
            <artifactId>velocity-engine-coreartifactId>
            <version>2.3version>
        dependency>
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14

    二、编写代码生成器

    package cn.mesmile.admin.modules.generator;
    
    import cn.mesmile.admin.common.constant.BaseEntity;
    import cn.mesmile.admin.common.constant.IBaseService;
    import cn.mesmile.admin.common.constant.BaseServiceImpl;
    import com.baomidou.mybatisplus.annotation.FieldFill;
    import com.baomidou.mybatisplus.annotation.IdType;
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.baomidou.mybatisplus.extension.service.IService;
    import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    import com.baomidou.mybatisplus.generator.FastAutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.OutputFile;
    import com.baomidou.mybatisplus.generator.config.TemplateConfig;
    import com.baomidou.mybatisplus.generator.config.rules.DateType;
    import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
    import com.baomidou.mybatisplus.generator.fill.Column;
    
    import java.util.Arrays;
    import java.util.Collections;
    import java.util.List;
    import java.util.Scanner;
    import java.util.function.Consumer;
    
    /**
     * @author zb
     * @Description 在开发过程中使用,其余时候不会用
     *      相关配置 https://baomidou.com/pages/981406/
     */
    public class GeneratorCode {
    
        /** 数据库配置 */
        private final static String JDBC_URL = "jdbc:mysql://81.69.43.78:3306/admin-boot?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8";
        private final static String USERNAME = "root";
        private final static String PASSWORD = "task,.123";
    
        /**  项目所在目录  */
        private static String projectPath = System.getProperty("user.dir");
        /** Java文件输出目录 */
        private  static   String outputDir = projectPath + "/src/main/java";
        /** xml输出目录 */
        private  static String mapperOutputDir = projectPath +"/src/main/resources/mapper";
        /** 表前缀 */
        private static String[] tablePreFix = new String[]{};
    
        /**
         * 数据源配置
         */
        private static final DataSourceConfig.Builder DATA_SOURCE_CONFIG = new DataSourceConfig.Builder(JDBC_URL, USERNAME, PASSWORD);
    
        public static void main(String[] args) {
            System.out.println("公共字段有 create_by  create_time  update_by  update_time  deleted  status");
            System.out.println("请输入需要父类,即检查表中是否有所有的公共字段? y / n");
            Scanner scannerResult = new Scanner(System.in);
            String next = scannerResult.next();
            if ("Y".equalsIgnoreCase(next)){
                // 存在父类,父类中字段为;父类字段 "create_by", "create_time", "update_by", "update_time","deleted","status"
                hasSuperClass();
            }else {
                // 不存在父类
                notHasSuperClass();
            }
        }
    
        private static void hasSuperClass() {
            FastAutoGenerator.create(DATA_SOURCE_CONFIG)
                    // 全局配置
                    .globalConfig((scanner, builder) ->
                            builder.author(scanner.apply("请输入作者名称?"))
                                    .outputDir(outputDir)
                                    // 禁止打开输出目录
                                    .disableOpenDir()
                                    // 开启swagger
                                    .enableSwagger()
                                    // 指定日期类型
                                    .dateType(DateType.TIME_PACK)
                                    // 覆盖已生成的文件
                                    .fileOverride())
                    // 包配置
                    .packageConfig((scanner, builder) ->
                            builder.parent(scanner.apply("请输入父级包名?"))
                            .pathInfo(Collections.singletonMap(OutputFile.xml, mapperOutputDir))
                    )
                    // 策略配置
                    .strategyConfig((scanner, builder) ->
                            builder
                                    .addTablePrefix(tablePreFix)
                                    .addInclude(getTables(scanner.apply("请输入表名,多个英文逗号分隔?所有输入 all")))
                                    // controller配置
                                    .controllerBuilder().enableRestStyle().enableHyphenStyle().build()
                                    // 实体配置
                                    .entityBuilder().enableLombok().addTableFills(
                                    new Column("create_time", FieldFill.INSERT),
                                    new Column("create_by", FieldFill.INSERT),
                                    new Column("update_time", FieldFill.INSERT_UPDATE),
                                    new Column("update_by", FieldFill.INSERT_UPDATE)
                                    )
                                    .addSuperEntityColumns("create_by", "create_time", "update_by", "update_time","deleted","status")
                                    .superClass(BaseEntity.class)
                                    .logicDeleteColumnName("deleted")
                                    .logicDeletePropertyName("deleted")
                                    .idType(IdType.ASSIGN_ID).build()
    
                                    // service配置
                                    .serviceBuilder()
                                    .superServiceClass(IBaseService.class)
                                    .superServiceImplClass(BaseServiceImpl.class)
    //                                .formatServiceFileName("I%sService").formatServiceImplFileName("I%sServiceImpl")
                                    .build()
                                    // mapper配置
                                    .mapperBuilder().superClass(BaseMapper.class)
                                    .enableBaseResultMap()
                                    .enableBaseColumnList()
                                    .build()
                    )
                    // 模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                    .templateEngine(new VelocityTemplateEngine())
                    .templateConfig(
                            new Consumer<TemplateConfig.Builder>() {
                                @Override
                                public void accept(TemplateConfig.Builder builder) {
                                    // 指定模板路径
                                    builder.entity("/templates/entity.java")
                                            .service("/templates/service.java")
                                            .serviceImpl("/templates/serviceImpl.java")
                                            .mapper("/templates/mapper.java")
                                            .xml("/templates/mapper.xml")
                                            .controller("/templates/controller.java")
                                            .build();
                                }
                            }
                    )
                    /*
                        模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                       .templateEngine(new BeetlTemplateEngine())
                       .templateEngine(new FreemarkerTemplateEngine())
                     */
                    .execute();
        }
    
        private static void notHasSuperClass() {
            FastAutoGenerator.create(DATA_SOURCE_CONFIG)
                    // 全局配置
                    .globalConfig((scanner, builder) ->
                            builder.author(scanner.apply("请输入作者名称?"))
                                    .outputDir(outputDir)
                                    // 禁止打开输出目录
                                    .disableOpenDir()
                                    // 开启swagger
                                    .enableSwagger()
                                    // 指定日期类型
                                    .dateType(DateType.TIME_PACK)
                                    // 覆盖已生成的文件
                                    .fileOverride())
                    // 包配置
                    .packageConfig((scanner, builder) ->
                            builder.parent(scanner.apply("请输入包名?"))
                                    .pathInfo(Collections.singletonMap(OutputFile.xml, mapperOutputDir))
                    )
                    // 策略配置
                    .strategyConfig((scanner, builder) ->
                            builder
                                    .addTablePrefix(tablePreFix)
                                    .addInclude(getTables(scanner.apply("请输入表名,多个英文逗号分隔?所有输入 all")))
                                    // controller配置
                                    .controllerBuilder().enableRestStyle().enableHyphenStyle().build()
                                    // 实体配置
                                    .entityBuilder().enableLombok().addTableFills(
                                    new Column("create_time", FieldFill.INSERT),
                                    new Column("create_by", FieldFill.INSERT),
                                    new Column("update_time", FieldFill.INSERT_UPDATE),
                                    new Column("update_by", FieldFill.INSERT_UPDATE)
                            )
                                    .logicDeleteColumnName("deleted")
                                    .logicDeletePropertyName("deleted")
                                    .idType(IdType.ASSIGN_ID).build()
                                    // service配置
                                    .serviceBuilder()
                                    .superServiceClass(IService.class)
                                    .superServiceImplClass(ServiceImpl.class)
    //                                .formatServiceFileName("I%sService").formatServiceImplFileName("%sServiceImpl")
                                    .build()
                                    // mapper配置
                                    .mapperBuilder().superClass(BaseMapper.class)
                                    .enableBaseResultMap()
                                    .enableBaseColumnList()
                                    .build()
                    )
                    // 模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                    .templateEngine(new VelocityTemplateEngine())
                    .templateConfig(
                            new Consumer<TemplateConfig.Builder>() {
                                @Override
                                public void accept(TemplateConfig.Builder builder) {
                                    // 指定模板路径
                                    builder.entity("/templates/entity.java")
                                            .service("/templates/service.java")
                                            .serviceImpl("/templates/serviceImpl.java")
                                            .mapper("/templates/mapper.java")
                                            .xml("/templates/mapper.xml")
                                            .controller("/templates/controller.java")
                                            .build();
                                }
                            }
                    )
                    /*
                        模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                       .templateEngine(new BeetlTemplateEngine())
                       .templateEngine(new FreemarkerTemplateEngine())
                     */
                    .execute();
        }
    
        /**
         * 处理 all 情况
         *
         * @param tables
         * @return
         */
        protected static List<String> getTables(String tables) {
            return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
        }
    }
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118
    • 119
    • 120
    • 121
    • 122
    • 123
    • 124
    • 125
    • 126
    • 127
    • 128
    • 129
    • 130
    • 131
    • 132
    • 133
    • 134
    • 135
    • 136
    • 137
    • 138
    • 139
    • 140
    • 141
    • 142
    • 143
    • 144
    • 145
    • 146
    • 147
    • 148
    • 149
    • 150
    • 151
    • 152
    • 153
    • 154
    • 155
    • 156
    • 157
    • 158
    • 159
    • 160
    • 161
    • 162
    • 163
    • 164
    • 165
    • 166
    • 167
    • 168
    • 169
    • 170
    • 171
    • 172
    • 173
    • 174
    • 175
    • 176
    • 177
    • 178
    • 179
    • 180
    • 181
    • 182
    • 183
    • 184
    • 185
    • 186
    • 187
    • 188
    • 189
    • 190
    • 191
    • 192
    • 193
    • 194
    • 195
    • 196
    • 197
    • 198
    • 199
    • 200
    • 201
    • 202
    • 203
    • 204
    • 205
    • 206
    • 207
    • 208
    • 209
    • 210
    • 211
    • 212
    • 213
    • 214
    • 215
    • 216
    • 217
    • 218
    • 219
    • 220
    • 221
    • 222
    • 223
    • 224

    BaseEntity基础类

    package cn.mesmile.admin.common.constant;
    
    import com.baomidou.mybatisplus.annotation.FieldFill;
    import com.baomidou.mybatisplus.annotation.TableField;
    import com.baomidou.mybatisplus.annotation.TableLogic;
    import com.fasterxml.jackson.annotation.JsonFormat;
    import com.fasterxml.jackson.databind.annotation.JsonSerialize;
    import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.Data;
    import org.springframework.format.annotation.DateTimeFormat;
    
    import java.io.Serializable;
    import java.time.LocalDateTime;
    
    /**
     * @author zb
     * @Description 父类
     */
    @Data
    public class BaseEntity implements Serializable {
    
        @JsonSerialize(using = ToStringSerializer.class)
        @TableField(fill = FieldFill.INSERT)
        @ApiModelProperty("创建人")
        private Long createBy;
    
        @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @TableField(fill = FieldFill.INSERT)
        @ApiModelProperty("创建时间")
        private LocalDateTime createTime;
    
        @JsonSerialize(using = ToStringSerializer.class)
        @TableField(fill = FieldFill.INSERT_UPDATE)
        @ApiModelProperty("更新人")
        private Long updateBy;
    
        @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @TableField(fill = FieldFill.INSERT_UPDATE)
        @ApiModelProperty("更新时间")
        private LocalDateTime updateTime;
    
        @ApiModelProperty("删除标志(0代表存在 1代表删除)")
        @TableLogic
        private String deleted;
    
        @ApiModelProperty("业务状态(0正常 1停用)")
        private String status;
    }
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52

    代码模板详见项目:\admin-boot\src\main\resources\templates 目录

    三、在数据库中新建表测试

    在对应的数据库,新建表测试:

    启动 cn.mesmile.admin.modules.generator.GeneratorCode 代码生成类

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jg2DmxjT-1660385935114)(image/image_z6zurs8twg.png)]

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cwO3zhUu-1660385935115)(image/image_6ULSaXNf3A.png)]

  • 相关阅读:
    vue-ant design示例大全——按钮本地css/js资源
    通过一个案例轻松入门OAuth协议
    聊一聊安全且正确使用缓存的那些事 —— 关于缓存可靠性、关乎数据一致性
    CPT205-Computer Graphics
    Math.abs一定大于等于0吗?
    Spacedrive:开源跨平台文件管理 | 开源日报 No.57
    Vue3 快速入门和模板语法
    Tomcat的类加载器
    Opencv学习项目3——pytesseract
    CIFAR-10 数据集简介
  • 原文地址:https://blog.csdn.net/suprezheng/article/details/126322746