Generator【SpringBoot集成】代码生成+knife4j接口文档（2种模板设置、逻辑删除(1)

2401_84563320

于 2024-05-09 19:13:21 发布

阅读量299

点赞数 3

分类专栏：程序员文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/2401_84563320/article/details/138627379

版权

程序员专栏收录该内容

189 篇文章 0 订阅

订阅专栏

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取

2.代码生成类

如果要使用freemarker模板，需要额外配置 .setTemplateEngine(new FreemarkerTemplateEngine()); 启用 .setSwagger2(true);

class CodeGenerator {

    /\*\*
 \* 项目根路径
 \*/
    private static final String PROJECT_PATH = "E:\yuanzheng-codebase\m-framework\codegenerator";

    /\*\*
 \* 注释@auth 名称
 \*/
    private static final String AUTH = "auth";

    /\*\*
 \* 父包全限定类名
 \*/
    private static final String PARENT = "com.example.demo";

    /\*\*
 \* 模块名称
 \*/
    private static final String MODEL_NAME = "student";

    /\*\*
 \* 忽略的表前缀
 \*/
    private static final String[] IGNORE_TABLE_PFX = new String[]{"table\_", "t\_"};

    /\*\*
 \* 要生成的表名
 \*/
    private static final String TABLE_NAMES = "student";

    /\*\*
 \* 数据源配置
 \*/
    private static final DataSourceConfig DSC = new DataSourceConfig();

    static {
        DSC.setDbType(DbType.MYSQL);
        DSC.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true");
        DSC.setDriverName("com.mysql.cj.jdbc.Driver");
        DSC.setUsername("root");
        DSC.setPassword("root");
    }

    @Test
    void test() {
        main(null);
    }

    static void main(String[] args) {

        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        /\*
 \* 全局配置
 \*/
        GlobalConfig gc = new GlobalConfig();
        // 输出路径
        gc.setOutputDir(PROJECT_PATH + "/src/main/java");
        // 设置作者
        gc.setAuthor(AUTH);
        // 生成代码后，是否打开文件夹
        gc.setOpen(false);
        // 是否覆盖原来代码
        gc.setFileOverride(false);
        // 去掉service的I前缀,一般只需要设置service就行
// gc.setServiceName("%sService");
// gc.setMapperName("%sMapper");
// gc.setXmlName("%sMapper");
// gc.setServiceImplName("%sServiceImpl");
// gc.setControllerName("%sController");
        // 日期格式
        gc.setDateType(DateType.ONLY_DATE);
        // 实体属性 Swagger2 注解,实体类上会增加注释
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        /\*
 \* 数据源配置
 \*/
        mpg.setDataSource(DSC);

        /\*
 \* 配置模板（generator默认的是velocity，使用freemarker的话要打开此项设置）
 \*/
        // mpg.setTemplateEngine(new FreemarkerTemplateEngine());


        /\*
 \* 包配置
 \*/
        PackageConfig pc = new PackageConfig();
        pc.setParent(PARENT);
        pc.setModuleName(MODEL_NAME);
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        /\*
 \* 策略配置
 \*/
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude(TABLE_NAMES);
        strategy.setTablePrefix(IGNORE_TABLE_PFX);
        // 包的命名规则，使用驼峰规则
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 列的名称，使用驼峰规则
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 是否使用lombok（要确认项目是否有lombok）
        strategy.setEntityLombokModel(true);
        // 是否使用
        strategy.setRestControllerStyle(true);
        // 逻辑删除（要结合数据表字段使用）
        strategy.setLogicDeleteFieldName("is\_delete");

        // 自动填充字段
        TableFill fillInsert = new TableFill("create\_time", FieldFill.INSERT);
        TableFill fillUpdate = new TableFill("update\_time", FieldFill.UPDATE);
        List fillLists = new ArrayList();
        fillLists.add(fillInsert);
        fillLists.add(fillUpdate);
        strategy.setTableFillList(fillLists);
        //乐观锁
        //strategy.setVersionFieldName("version");
        mpg.setStrategy(strategy);

        // 执行
        mpg.execute();

    }
}

3.生成后的结构

在这里插入图片描述

Student
可以看到代码生成设置的逻辑删除字段、INSERT和UPDATE填充字段的注释。

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="Student对象", description="")
public class Student implements Serializable {

    private static final long serialVersionUID=1L;

    @ApiModelProperty(value = "编号")
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "年龄")
    private Integer age;

    @ApiModelProperty(value = "是否删除")
    @TableLogic
    private Integer isDelete;

    @ApiModelProperty(value = "入库时间")
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @ApiModelProperty(value = "修改时间")
    @TableField(fill = FieldFill.UPDATE)
    private Date updateTime;
}

DateObjectHandler
处理一下填充字段。

@Component
public class DateObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

Controller
简单测试一下。