SpringBoot基于Mybatis-Plus自动代码生成

前言

大家好啊，我是汤圆，今天给大家带来的是《SpringBoot中的自动代码生成 - 基于Mybatis-Plus》，希望对大家有帮助，谢谢

简介

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

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

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

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

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

是因为对于我这种不熟悉模板引擎的人来说，官网介绍的一些配置我们可以省掉，从而减少我们调试的时间（因为默认的模板生成配置就够用了，我们不需要再去接触那些模板语法啥的）

本地代码生成

就是在自己的项目里，写一个Java程序，配置好各种参数，启动后就可以自动生成

这种方法的好处是，直接生成到本地项目，不需要手动再去复制粘贴

缺点就是，刚开始的配置比较多（但是一劳永逸）

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

配置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>

自动生成代码的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');// 生成代码的authorgc.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注解：是否开启，不开启则默认为@Controllerstrategy.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/#/createCode

总结

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

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

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

到此这篇关于SpringBoot基于Mybatis-Plus自动代码生成的文章就介绍到这了,更多相关SpringBoot Mybatis-Plus自动代码生成内容请搜索好吧啦网以前的文章或继续浏览下面的相关文章希望大家以后多多支持好吧啦网！