Mybatis-Plus代码生成器插件的使用

最新推荐文章于 2024-09-04 11:16:56 发布

舞政

最新推荐文章于 2024-09-04 11:16:56 发布

阅读量817

点赞数 1

文章标签： java mybatis

本文链接：https://blog.csdn.net/wuzheng8023/article/details/110121419

版权

用途：可以帮助使用者快速生成代码Web后端的基本文件。

1、前提

Springboot项目，数据库已经建立了相应的数据库表格，则会根据数据库生成对应的实体类以及其它层。

2、依赖引入

 		<!-- 插件lombok -->

		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>


        <!--数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

<!-- 下面两个是代码生成插件的依赖代码生成器依赖,自3.0.3.以后被单独移出来了,使用完毕以后注释掉-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>

<!--        模板引擎依赖,使用完毕以后注释掉-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>

3、代码部分

编辑代码生成器部分的代码，通过运行此部分来自动生成项目工程基本目录；

这里下面的代码是经过我个人编写处理以后的，还可以直接在官网上复制相应代码进行修改使用。

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;

//代码自动生成器
public class Code {
    public static void main(String[] args) {

        // 1、创建代码生成器对象
        AutoGenerator mpg = new AutoGenerator();
        //如果使用非默认（Velocity）模板引擎，需要在 AutoGenerator 中 设置模板引擎。
//        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        //2、全局配置
        GlobalConfig gc = new GlobalConfig();
        //得到当前项目所在路径
        String projectPath = System.getProperty("user.dir");
        //设置产生文件的输出目录，文件会在设置的目录下生成
        gc.setOutputDir(projectPath + "/src/main/java");
        //设置作者名称
        gc.setAuthor("张三");
        gc.setOpen(false);//是否在文件夹中打开输出目录，默认为打开，不需要打开则设置为false
        gc.setFileOverride(false);//存在的文件是否覆盖，false是不覆盖
        // 使用实体属性 Swagger2 注解
//        gc.setSwagger2(true);
       //去掉Service的I 前缀，默认生成的service文件是以字母I开头的；这里相当于设置了驼峰式转换后的数据库表名+Service
        gc.setServiceName("%sService");
        //设置自定义了名字的实体类;这里相当于设置了驼峰式转换后的数据库表名+Po；
        gc.setEntityName("%sPo");;
        //为数据库主键设置生成策略
        gc.setIdType(IdType.ID_WORKER);
        //选择数据库中时间类型数据映射成为实体类时的数据类型
        gc.setDateType(DateType.TIME_PACK);//localDateTime   java.time包下
//        gc.setDateType(DateType.ONLY_DATE);//Date  java.util包下
//        gc.setDateType(DateType.SQL_PACK);//Timestamp java.sql.Timestamp包下
        mpg.setGlobalConfig(gc);

        //3、数据源配置

        DataSourceConfig dsc = new DataSourceConfig();
        //设置数据库类型
        dsc.setDbType(DbType.MYSQL);
        //下面是链接数据库需要的基本配置
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        //4、包配置

        PackageConfig pc = new PackageConfig();
        //设置要生成模块的名称，对应文件生成在对应模块中，如果不需要也可以直接删除这一句，则相当于取消了模块
        pc.setModuleName("user");
        //放置在那个包下面，即父级目录
        pc.setParent("com.study.mymybatisplus");
        //以下是设置对应层的文件夹名称
        pc.setEntity("entity");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //5、自定义配置

        //6、策略配置

        StrategyConfig strategy = new StrategyConfig();
        //设置要映射的表，依据那个表去生成代码，需要注意的是，数据库的表是提前创建好的，并不能由代码生成器去创建数据库中的表
        strategy.setInclude("user");
        //数据库表名称下划线转驼峰命名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //数据库表列名下划线转驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //使用lombok
        strategy.setEntityLombokModel(true);
        //使用RestController风格
        strategy.setRestControllerStyle(true);
        //逻辑删除
        strategy.setLogicDeleteFieldName("deleted");
        //以下为数据库表对应字段自动填充策略
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> list = new ArrayList<>();
        list.add(gmtCreate);
        list.add(gmtModified);
        //将填充策略添加到策略对象中
        strategy.setTableFillList(list);
        //controller 请求多字段连接 实现下划线连接 eg：localhost:8080/aa_bb，即驼峰转下划线连字符
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);

        //7、代码生成器开始执行

        mpg.execute();

    }
}