关于java:SpringBoot中的自动代码生成-基于MybatisPlus

31次阅读

共计 5270 个字符，预计需要花费 14 分钟才能阅读完成。

作者：汤圆

集体博客：javalover.cc

前言

大家好啊，我是汤圆，明天给大家带来的是《SpringBoot 中的主动代码生成 – 基于 Mybatis-Plus》，心愿对大家有帮忙，谢谢

文章纯属原创，集体总结不免有过错，如果有，麻烦在评论区回复或后盾私信，谢啦

简介

基于 Mybatis-Plus 的主动代码生成有很多形式，这里介绍下我在用的两种：

  • 本地代码生成：Mybatis-Plus 官网
  • 在线代码生成：第三方

这两种各有优缺点，看喜爱哪一种了

据说 Idea 也有主动生成的插件，然而我还没去看，我感觉这俩就够用了（但也说不准哪天，用了插件后，才发现柳暗花明呢）

有的官人，可能要问了，既然 Mybatis-Plus 官网有例子了，为啥还要在这里写进去呢？

是因为对于我这种不相熟模板引擎的人来说，官网介绍的一些配置咱们能够省掉，从而缩小咱们调试的工夫（因为默认的模板生成配置就够用了，咱们不须要再去接触那些模板语法啥的）

本地代码生成

就是在本人的我的项目里，写一个 Java 程序，配置好各种参数，启动后就能够主动生成

这种办法的益处是，间接生成到本地我的项目，不须要手动再去复制粘贴

毛病就是，刚开始的配置比拟多（然而一劳永逸）

好了，上面开始 上代码，好消息是上面的代码都有正文阐明，另一个好消息是生成的代码也是有正文的（尤其是 entity 类的字段注解，很实用）

  1. 配置 pom.xml

    <!-- mybatis-plus 代码生成器 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<!-- velocity 模板引擎，用于 mybatis-plus 代码生成器 -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>
<!-- lombok 主动生成会用到 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.16</version>
</dependency>

  2. 主动生成代码 的 Java 主程序：参考官网

    // 演示例子，执行 main 办法控制台输出模块表名回车主动生成对应我的项目目录中
public class GenerateCode {

    /**
     * <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();

        // 1. 全局配置
        GlobalConfig gc = new GlobalConfig();
        // 我的项目根目录
        String projectPath = System.getProperty("user.dir");
        // 生成代码的输入目录：个别这个就是固定的，这里不必写到具体的哪个包，因为上面会独自配置包名
        gc.setOutputDir(projectPath + "/src/main/java");
        // 生成代码的 author
        gc.setAuthor("javalover");
        // 生成代码后，是否主动关上生成的目录：这里咱们不须要，因为就是生成到以后我的项目
        gc.setOpen(false);
        // 设置全局配置
        mpg.setGlobalConfig(gc);

        // 2. 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/guns?autoReconnect=true&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=CONVERT_TO_NULL&useSSL=false&serverTimezone=CTT&nullCatalogMeansCurrent=true");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 3. 包配置
        PackageConfig pc = new PackageConfig();
        // 设置包名：和下面的输入目录进行拼接(ourDir+parent)
        pc.setParent("cn.stylefeng.guns.modular.business");
        // 检测命令行输出的模块名：和下面的包名进行拼接（outDir+parent+moduleName)，生成代码都会放到这个模块下
        pc.setModuleName(scanner("模块名"));
        mpg.setPackageInfo(pc);

        // 4. 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 主动生成 实体类的命名：数据库映射到实体类，下划线转驼峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 这里如果不设置，会追随下面实体类的命名设置
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 字段注解：这里咱们把表字段的注解关上，比方 @TableField("car_name")
        strategy.setEntityTableFieldAnnotationEnable(true);
        // 实体类的父类：如果有就配置，记得加包名
        strategy.setSuperEntityClass("cn.stylefeng.roses.kernel.db.api.pojo.entity.BaseEntity");
        // 映射类的父类：如果有就配置，记得加包名
        strategy.setSuperMapperClass("com.baomidou.mybatisplus.core.mapper.BaseMapper");
        // 服务接口的父类：如果有就配置，记得加包名
        strategy.setSuperServiceClass("com.baomidou.mybatisplus.extension.service.IService");
        // 服务实现类的父类：如果有就配置，记得加包名
        strategy.setSuperServiceImplClass("com.baomidou.mybatisplus.extension.service.impl.ServiceImpl");
        // 控制器类的父类：如果有就配置，记得加包名
        // strategy.setSuperControllerClass("");

        // lombok：是否开启 Lombok 的注解，比方 @Data,@EqualsAndHashCode(callSuper = true)
        strategy.setEntityLombokModel(true);
        // 控制器的 @RestController 注解：是否开启，不开启则默认为 @Controller
        strategy.setRestControllerStyle(true);
        // 监测命令行的输出：表名
        strategy.setInclude(scanner("表名，多个英文逗号宰割").split(","));
        // 控制器的申请映射 url 格调：驼峰转连字符，比方 "carList"-> "car-list"
        strategy.setControllerMappingHyphenStyle(true);
        // 设置表的前缀：设置后，生成的类名和 Controller 的申请映射中就不会蕴含表前缀
        // 设置后为 @RequestMapping("/gps/car")，而不是 @RequestMapping("/gps/gps-car")
        // 类名同理
        strategy.setTablePrefix("gps");
        mpg.setStrategy(strategy);

        // 5. 配置模板引擎
        // 默认采纳 velocity 模板
//        mpg.setTemplateEngine(new VelocityTemplateEngine());
        mpg.execute();}
}

启动程序，在命令行顺次输出包名，表名，期待运行实现就能够了

生成后的目录构造如下：

能够看到，根本的框架都有了

上面咱们看下生成的 entity 文件：

Car.java

/**
 * <p>
 * 车辆管理
 * </p>
 *
 * @author javalover
 * @since 2021-04-22
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("gps_car")
public class Car extends BaseEntity {

    private static final long serialVersionUID = 1L;

    /**
     * 车辆 id
     */
    @TableId("car_id")
    private Long carId;

    /**
     * 所属公司 id
     */
    @TableField("company_id")
    private Long companyId;

    /**
     * 车辆名称
     */
    @TableField("car_name")
    private String carName;

    /**
     * 车辆品种
     */
    @TableField("car_type")
    private Integer carType;

    /**
     * 车辆色彩
     */
    @TableField("car_color")
    private String carColor;

    /**
     * 司机
     */
    @TableField("car_driver")
    private String carDriver;

    /**
     * 车辆价格
     */
    @TableField("car_price")
    private BigDecimal carPrice;

    /**
     * 油耗
     */
    @TableField("fuel_consumption")
    private BigDecimal fuelConsumption;

    /**
     * 车牌号
     */
    @TableField("car_number")
    private String carNumber;

    /**
     * 车架号
     */
    @TableField("frame_number")
    private String frameNumber;

    /**
     * 载重
     */
    @TableField("load_weight")
    private BigDecimal loadWeight;

    /**
     * 车照片
     */
    @TableField("car_img")
    private String carImg;

    /**
     * 车辆实时定位
     */
    @TableField("car_location")
    private String carLocation;
}

能够看到，正文的很具体啊，多好(字段的正文是依据数据库的正文来的)

在线代码生成

就是在第三方的网站，配置各种参数，点击生成就能够了，而后下载到本地

这种办法的益处是，后期不必太多配置，使用方便

毛病就是

  • 须要在线配置一个小型的数据库，上传 SQL 语句
  • 生成后，须要拉到本地我的项目中
  • 不够灵便，比方父类的配置等

其实它的毛病就是因为它的简略导致的

这种就比拟适宜新的我的项目，想要疾速上手体验的敌人

因为在线的操作很简略，这里给出链接，具体操作大家体验下就晓得了

在线链接：https://gen.stylefeng.cn/#/cr…

总结

主动生成代码的形式有很多，而这里的只是冰山一角

角 1：基于 Mybatis-Plus 官网的例子（灵便，性能全）

角 2：基于第三方的在线生成（简略，上手快）

后记

最初，感激大家的观看，谢谢

期待官人们的点赞哦

正文完
java
发表至： java
2021-04-22
 0
长连接短连接长轮询短轮询WebSocket释疑
关于java:20篇精品文章视频手把手带你攻克OOM难题｜HeapDump性能社区专题精选
关于java:Java时间和日期处理
关于java:APICloud开发者进阶之路-FNScanner二维码接口openView自定义扫码Demo