mybatis-plus自动生成实体类(包含swagger注解)

最新推荐文章于 2024-04-07 09:59:07 发布
最新推荐文章于 2024-04-07 09:59:07 发布
阅读量2.5w 收藏 29
点赞数 4
分类专栏： Mybatis 文章标签： java mybatis spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/A_Java_Dog/article/details/108147114
版权

mybatis-plus自动生成实体类(包含swagger注解)

mybatis-plus逆向工程, 自动生成实体类,带swaager注解

    1. 首先导入相应的jar包
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.1.14.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>5.1.5.RELEASE</version>
        </dependency>
        <!--就不需要手动引入mybatis -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity</artifactId>
            <version>1.7</version>
        </dependency>
        <!--mybatisplus 代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.2</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.45</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.0.31</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.51</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>
        <!--slf4j-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.10.5</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.10.5</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.24</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.24</version>
        </dependency>
    </dependencies>
  • 2.然后编写自动生成代码类
package com;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.IColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class GeneratorCommon {
    /**
     * <p> Mr.Chen
     * MySQL 生成演示
     * </p>
     */

    //获取 项目绝对路径
    private static String canonicalPath = "";

    public static void main(String[] args) {

        //获取项目路径
        try {
            canonicalPath = new File("").getCanonicalPath();
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.out.println("canonicalPath=" + canonicalPath);
//        String filePath = canonicalPath+"\\mybatisPlusGer\\src\\main\\";
        String filePath = canonicalPath + "\\src\\main\\";

        AutoGenerator mpg = new AutoGenerator();
        // 选择 freemarker 引擎，默认 Veloctiy
        //mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setAuthor("Mr.Chen");
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        gc.setOutputDir(filePath + "java");//代码生成路径
        gc.setFileOverride(true);// 是否覆盖同名文件，默认是false
        gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
        gc.setEnableCache(false);// XML 二级缓存
        gc.setBaseResultMap(true);// XML ResultMap
        gc.setBaseColumnList(false);// XML columList
        gc.setOpen(false);//生成后打开文件夹
        /* 自定义文件命名，注意 %s 会自动填充表实体属性！ */
        gc.setControllerName("%sController");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setTypeConvert(new MySqlTypeConvert() {
            // 自定义数据库表字段类型转换【可选】
            @Override
            public IColumnType processTypeConvert(GlobalConfig gc, String fieldType) {
                System.out.println("转换类型：" + fieldType);
                // 注意！！processTypeConvert 存在默认类型转换，如果不是你要的效果请自定义返回、非如下直接返回。
                //默认会把日期类型 转为LocalDateTime ，在查询的时候会报错，这里改为Date
                String t = fieldType.toLowerCase();
                if (t.contains("date") || t.contains("time") || t.contains("year")) {
                    return DbColumnType.DATE;
                } else {
                    return super.processTypeConvert(gc, fieldType);
                }

            }
        });
        //数据库连接配置
        dsc.setDriverName("com.mysql.jdbc.Driver");
//      dsc.setDriverName("com.mysql.cj.jdbc.Driver"); //mysql8.0使用
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setUrl("jdbc:mysql://192.168.1.199/cloud_shop?useUnicode=true&characterEncoding=utf8");
        mpg.setDataSource(dsc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
        //strategy.setTablePrefix("tb_");// 此处可以修改为您的表前缀
        strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//采用驼峰映射
        strategy.setEntityLombokModel(true);//【实体】是否为lombok模型（默认 false）
        strategy.setInclude(new String[]{"article", "article_data"}); // 需要生成的表.如果需要生成所有的, 注释掉此行就可以
        // strategy.setExclude(new String[]{"test"}); // 排除生成的表
        // 自定义实体父类
        // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
        // 自定义实体，公共字段
        // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
        // 自定义 mapper 父类
        // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
        // 自定义 service 父类
        // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
        // 自定义 service 实现类父类
        // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
        // 自定义 controller 父类
        // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
        // 【实体】是否生成字段常量（默认 false）
        // public static final String ID = "test_id";
        // strategy.setEntityColumnConstant(true);
        // 【实体】是否为构建者模型（默认 false）
        // public User setName(String name) {this.name = name; return this;}
        // strategy.setEntityBuilderModel(true);
        mpg.setStrategy(strategy);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.faw.jetta");// 自定义包路径
        pc.setController("controller");// 这里是控制器包名，默认 web
        pc.setMapper("mapper");// 设置Mapper包名，默认mapper
        pc.setService("service");// 设置Service包名，默认service
        pc.setEntity("pojo.entity");// 设置Entity包名，默认entity,继承的父类  已序列化
        pc.setXml("mapper.xml");// 设置Mapper XML包名，默认mapper.xml
        mpg.setPackageInfo(pc);


        // 注入自定义配置，可以在 VM 中使用 cfg.abc 设置的值
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<String, Object>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                this.setMap(map);
            }
        };
        // 调整 xml 生成目录演示
        List<FileOutConfig> focList = new ArrayList<>();

        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {

                return filePath + "\\resources\\mapper\\xml\\" + tableInfo.getEntityName() + "Mapper.xml";
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        // 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】
//        InjectionConfig cfg = new InjectionConfig() {
//            @Override
//            public void initMap() {
//                Map<String, Object> map = new HashMap<String, Object>();
//                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
//                this.setMap(map);
//            }
//        };
//
//        // 自定义 xxList.jsp 生成
//        List<FileOutConfig> focList = new ArrayList<>();
//        focList.add(new FileOutConfig("/template/list.jsp.vm") {
//            @Override
//            public String outputFile(TableInfo tableInfo) {
//                // 自定义输入文件名称
//                return "D://my_" + tableInfo.getEntityName() + ".jsp";
//            }
//        });
//        cfg.setFileOutConfigList(focList);
//        mpg.setCfg(cfg);
//
//        // 调整 xml 生成目录演示
//        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
//            @Override
//            public String outputFile(TableInfo tableInfo) {
//                return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
//            }
//        });
//        cfg.setFileOutConfigList(focList);
//        mpg.setCfg(cfg);
//
//        // 关闭默认 xml 生成，调整生成 至 根目录
//        TemplateConfig tc = new TemplateConfig();
//        tc.setXml(null);
//        mpg.setTemplate(tc);

        // 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改，
        // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称
        // TemplateConfig tc = new TemplateConfig();
        // tc.setController("...");
        // tc.setEntity("...");
        // tc.setMapper("...");
        // tc.setXml("...");
        // tc.setService("...");
        // tc.setServiceImpl("...");
        // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
        // mpg.setTemplate(tc);

        // 执行生成
        mpg.execute();

        // 打印注入设置【可无】
//        System.err.println(mpg.getCfg().getMap().get("abc"));
    }
}

生成的代码展示
在这里插入图片描述

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="Article对象", description="文章")
public class Article extends Model<Article> {

private static final long serialVersionUID=1L;

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

    @ApiModelProperty(value = "公司(厂家)id")
    private Integer companyId;

    @ApiModelProperty(value = "经销商ID")
    private Integer dealerId;

    @ApiModelProperty(value = "文章标题")
    private String title;

    @ApiModelProperty(value = "文章内容")
    private String content;

    @ApiModelProperty(value = "图片链接")
    private String imageUrl;

    @ApiModelProperty(value = "栏目ID")
    private Integer topicId;

    @ApiModelProperty(value = "状态 0: 下架, 1:上架(正常)")
    private Integer state;

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

    @ApiModelProperty(value = "发布时间")
    private Date releaseTime;

    @ApiModelProperty(value = "下架时间")
    private Date outTime;

    @ApiModelProperty(value = "创建时间")
    private Date createTime;

    @ApiModelProperty(value = "更新时间")
    private Date updateTime;


    @Override
    protected Serializable pkVal() {
        return this.id;
    }

}
意田天
关注
  • 4
    点赞
  • 踩
  • 29
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
springboot+swagger3+mybatis-plus3.5.1代码生成+druid+log4j2【最完美】的一次配置
12-21
在SpringBoot项目中集成Swagger3，我们可以使用`springfox-swagger2`和`springfox-swagger-ui`库，通过注解来定义API信息，然后Swagger UI界面会自动生成交互式的文档。 MyBatis-Plus是MyBatis的扩展，它提供了一些...
mybatis-plus自动生成代码(包含swaager注解)
08-21
使用mybatis-plus代码生成器自动生成实体类,service, mapper, xml, 内含单表的增删改查和丰富的条件构造器
mybatis-plus实体类
weixin_41066675的博客
11-26 9978
@Data @TableName(value = “tb_employee”)//指定表名 public class Employee { //value与数据库主键列名一致，若实体类属性名与表主键列名一致可省略value @TableId(value = “id”,type = IdType.AUTO)//指定自增策略 private Integer id; //若没有开启驼峰命名，或者表中列名...
使用MyBatis-plus自动生成实体类和业务代码
最新发布
dream_xin2013的专栏
04-07 573
使用mybatis-plus自动生成业务代码
使用mybatis_plus实现根据数据表自动生成实体类entity、controller层、service层、mapper层 极大提高开发效率
Coastlise的博客
08-18 6699
我们都知道，在开发过程中最无聊并且又必不可少的一个过程就是根据数据表去创建相应的实体类entity，以及与前端交互的controlle层和业务实现service层接口及其实现类impl，以及与持久层（数据库）交接的mapper层接口。今天在这里我又总结了mybatis_plus的又一大功能，它可以极大的提高我们呢的开发效率！如果说上述的过程都可以自动生成的话，那将会大大的减轻开发者的工作量，提高开发效率！于是乎mybatis_plus的代码自动生成功能应运而生！
Mybatis-plus-generator代码自动生成工具，自动生成实体类
热门推荐
夕颜的博客
04-27 1万+
效果：可以自动生成ControllerServiceMapperDAO层的基本代码，免去自己去写实体类映射数据库的繁琐操作 提效神器之代码自动生成MybatisPlus-Generator+Lombok Mybatis-plus-generator介绍 AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升...
2022mybatis-plus超详细教程
java小豪的博客
03-05 3060
Mybatis-plus学习笔记 1、创建数据库及表 1.1、创建表 CREATE DATABASE `mybatis_plus`; USE `mybatis_plus`; CREATE TABLE `user` ( `id` BIGINT(20) NOT NULL COMMENT '主键ID', `name` VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名', `age` INT(11) NULL DEFAULT NULL COMMENT '年龄',
java ~ mybatis-plus 自动生成实体类
唐唐
03-06 724
java ~ mybatis-plus 自动生成实体类
mybatis-plus生成的实体类支持swagger2
07-23
然而，MyBatis-Plus 的实体类并不直接与 Swagger2 的注解结合，这意味着我们无法直接通过实体类让 Swagger2 生成文档。为了实现这一目标，我们需要手动在实体类上添加 Swagger2 的注解，或者使用第三方库如 ` ...
整合案例springboot整合swagger+mybatis-plus
08-16
同时，代码文件则包含了SpringBoot项目的所有源代码，包括Swagger和MyBatis-Plus的配置、实体类、Mapper接口和实现、以及相关的控制器和服务类。 通过这个案例，初学者可以学习到如何在SpringBoot项目中集成这两个...
springboot+mybatis-plus+gradle+mysql+swagger基础增删改查、树形查询
02-20
本项目基于一系列技术栈，包括Spring Boot、MyBatis Plus、Gradle、MySQL和Swagger，实现了一个基础的增删改查（CRUD）功能，并提供了树形查询的能力。下面将详细介绍这些技术及其在项目中的应用。 **1. Spring ...
MybatisPlus自动生成实体类
weixin_41987908的博客
07-06 5019
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.2.0</version> </dependency> <dependency> <groupId>org.apache.veloci
MyBatis-Plus 代码自动生成
qq_41775769的博客
02-23 2063
8. MyBatis-Plus 代码自动生成 MyBatis-Plus 代码自动生成：可以根据数据表自动⽣成实体类Entity、Mapper、Service、 ServiceImpl 以及 Controller。 步骤一：创建 SpringBoot 空白项目，并勾选相关依赖； 步骤二：在 pom.xml 中导入 MyBatis Plus Generator； AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、 Mappe
MybatisPlus创建实体类步骤
m0_51492817的博客
11-06 385
MybatisPlus创建实体类步骤 1.对应数据库创建实体类 2.Mapper层: 创建Mapper接口 继承BaseMapper<实体类> 并加上@Mapper注解 3.Service层： 创建Service接口 继承IService<实体类> 4.实现类： 创建Impl 继承ServiceImpl<mapper接口，实体类> 实现service接口 并加上@Service注解
Mybatis-plus自动生成成实体类、Mapper、Mapper.xml(超级详细)
weixin_68170883的博客
09-17 9135
1.一般jdbc数据库的版本6.x以上，都是com.mysql.cj.jdbc.Driver 其他的低版本就是com.mysql.cj.jdbc.Driver。-- 要生成的表 tableName:数据库中的表名或视图名 domainObjectName:实体类名-->-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->-- 生成mapper映射文件的包名和位置-->-- 生成mapper的包名和位置-->-- 生成实体类的包名和位置-->干饭去了有缘再见ヾ(•ω•`)o。
Mybatis-puls 快速生成实体类(根据数据库字段及注释)
weixin_57929476的博客
12-04 1501
1--依赖 <!--mybatis plus 代码反向生成器--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.3.1.tmp</version> </dependency> <dependency&gt
mybatisPlus快速生成对应的实体类及mapper文件
m0_60524086的博客
10-25 2220
mybatisPlus快速生成对应的实体类及mapper文件
Mybatis-plus通过AutoGenerator对象自动生成实体对象【包括controller、service、entity、mapper】
ZXD_ZSL的博客
07-13 1414
Mybatis-plus通过AutoGenerator对象自动生成实体对象【包括controller、service、entity、mapper】 前言： 通过Mybatis-plus的AutoGenerator对象自动生成实体类，极大的节约了我们开发时间，我们只需要关注业务逻辑代码即可，这些没有任何技术含量的体力活就让Mybatis-plus来帮我们完成吧！！！ 一、首先引入两个关键的jar包 <dependency> <groupId>com.baomidou</grou
Mybatis-plus 实体类生成器
Hibiki的博客
08-07 175
【代码】Mybatis-plus 实体类生成器。
mybatis-plus 代码生成器集成 swagger3
06-02
Mybatis-Plus 的代码生成器可以大大提高开发效率，能够快速生成基本的 Mapper、Entity、Service、Controller 等代码。如果想要在生成的 Controller 中集成 Swagger3，可以按照以下步骤进行操作： 1. 在 pom.xml 文件中添加 Swagger3 依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2. 在代码生成器的配置文件 `generatorConfig.xml` 中添加 Swagger3 相关注释插件： ```xml <plugin type="io.github.swagger2markup.Swagger2MarkupConverterMojo"> <configuration> <swaggerInput>http://localhost:8080/v3/api-docs</swaggerInput> <outputFile>src/main/resources/docs/swagger</outputFile> <config> <swagger2MarkupConfig> <swaggerMarkupLanguage>MARKDOWN</swaggerMarkupLanguage> </swagger2MarkupConfig> </config> </configuration> </plugin> ``` 其中，`swaggerInput` 是指定 Swagger3 的 API 文档地址，`outputFile` 是指定生成的文档存储路径。 3. 在生成的 Controller 类中添加 Swagger3 注解，如： ```java @RestController @RequestMapping("/user") @Api(tags = "用户管理") public class UserController { @Autowired private UserService userService; @ApiOperation(value = "根据用户ID获取用户信息") @GetMapping("/{id}") public User getUserById(@PathVariable Long id) { return userService.getById(id); } } ``` 其中，`@Api` 注解用于描述 Controller 的作用，`@ApiOperation` 注解用于描述 Controller 中的方法作用。其他注解可以根据实际需要进行添加。 4. 运行代码生成器，生成的 Controller 类中就会包含 Swagger3 相关注解。 以上是 Mybatis-Plus 代码生成器集成 Swagger3 的简单示例，具体实现方式可以根据项目需要进行调整。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

意田天

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值