Java项目实战4——代码生成

mybatis-plus代码生成

导入依赖

<dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-generator</artifactId>
       <version>XXX</version>
   </dependency>
   <dependency>
       <groupId>org.freemarker</groupId>
       <artifactId>freemarker</artifactId>
       <version>XXX</version>
   </dependency>
XML

测试类中编写如下：

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.Collections;

public class GeneratorTest {
    //参考地址
    //https://baomidou.com/pages/981406/#%E7%AD%96%E7%95%A5%E9%85%8D%E7%BD%AE-strategyconfig
    public static void main(String[] args) {
        String url = "jdbc:mysql://localhost:3306/hao?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8";
        String userName = "XXXXXX";
        String password = "XXXXXX";
        FastAutoGenerator.create(url, userName, password)
                .globalConfig(builder -> {
                    builder.author("lihao") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .disableOpenDir()
                            .outputDir("E:\\code\\gitee\\hao\\hao-blog\\src\\main\\java"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.hao") // 设置父包名
                            .moduleName("") // 设置父包模块名
                            .entity("entity") //entity名称
                            .service("service")
                            .serviceImpl("service.impl")
                            .mapper("mapper")
                            .xml("mapper.xml")
                            .controller("controller")
                            .other("other")
                            .pathInfo(Collections.singletonMap(OutputFile.xml, "E:\\code\\gitee\\hao\\hao-blog\\src\\main\\java\\com\\hao\\mapper")); // 设置mapperXml生成路径
                })
                //entity配置
                .strategyConfig(builder -> {
                    builder.entityBuilder()
                            .enableLombok();
                })
                //controller
                .strategyConfig(builder -> {
                    builder.controllerBuilder()
                            .enableRestStyle();
                })
                //service

                //mapper
                .strategyConfig(builder -> {
                    builder.mapperBuilder()
                            .enableBaseResultMap()
                            .enableBaseColumnList();
                })
                .strategyConfig(builder -> {
                    builder.addInclude("xxx", "xxx") // 设置需要生成的表名
                            .addTablePrefix(""); // 设置过滤表前缀
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();

    }
}
JAVA

编辑好后，运行即可生成基础代码。

更改springfox 格式的doc为springdoc格式

因为默认生成的代码中，model的doc为springfox，我们需要调整为springdoc。
映射关系如下：

@Api -> @Tag
@ApiIgnore -> @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam -> @Parameter
@ApiImplicitParams -> @Parameters
@ApiModel -> @Schema
@ApiModelProperty(hidden = true) -> @Schema(accessMode = READ_ONLY)
@ApiModelProperty -> @Schema
@ApiOperation(value = "foo", notes = "bar") -> @Operation(summary = "foo", description = "bar")
@ApiParam -> @Parameter
@ApiResponse(code = 404, message = "foo") -> @ApiResponse(responseCode = "404", description = "foo")
LESS

例如：

package com.hao.entity;

import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * <p>
 * 用户信息表
 * </p>
 *
 * @author lihao
 * @since 2022-07-03
 */
@Data
@TableName("user")
@Schema(title = "User对象")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    @Schema(title = "用户ID")
    private String id;

    @Schema(title = "用户昵称")
    private String nickName;

    @Schema(title = "用户姓名")
    private String userName;

    @Schema(title = "年龄")
    private Integer age;

    @Schema(title = "性别-1男2女-默认1")
    private Integer sex;

    @Schema(title = "电子邮箱")
    private String email;

    @Schema(title = "手机号")
    private String phone;

    @Schema(title = "状态-1.正常-2.锁定-默认1")
    private Integer status;

    @Schema(title = "创建时间")
    private LocalDateTime createTime;

    @Schema(title = "修改时间")
    private LocalDateTime updateTime;

    @Schema(title = "创建者")
    private String createUser;

    @Schema(title = "修改者")
    private String updateUser;
}
JAVA

彩蛋

idea免重启自动部署已修改的Java文件。
当我们以debug模式启动springboot项目后，如果有对Java代码做修改，但我们又不想每次修改完之后重启项目，想立马看到修改后的效果。
其实idea有自带这个特性，比devtools个人感觉好用，也比较简单。
在idea的启动配置里，选择modify options，配置 on update action即可。