Mybatis-plus——代码生成器

最新推荐文章于 2025-10-13 11:19:54 发布

原创最新推荐文章于 2025-10-13 11:19:54 发布 · 1k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis

Springboot 专栏收录该内容

12 篇文章

订阅专栏

一、介绍：

mybatis-plus代码生成器现在有新、旧两种：

新版本：适用版本于mybatis-plus-generator 3.5.1 及其以上版本
旧版本：适用版本于mybatis-plus-generator 3.5.1 以下版本

在这里，我教给大家这种旧的方法，可能新的方法更加便捷，但是用旧的代码生成器用的多了，就暂时不想研究新的（其实两种的技术，还有方式，都是挺相似的，就是使用方法不太相同，影响不大）

二、生成代码

1.加入依赖

我使用的旧的代码生成器，因此，我使用生成器依赖是3.5.1一下版本的

这里我用的是3.4.1版本的

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>

配置模板引擎，我用的是freemarker

<dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

加入swagger依赖

<dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>spring-boot-starter-swagger</artifactId>
            <version>1.5.1.RELEASE</version>
        </dependency>

2.连接数据库

给你们一个用来测试的表吧，数据库自己建一个就行了

create table user ( 
id int auto_increment comment '主键'
  primary key ,
	no varchar(20) null comment '账号',
	name varchar(100) not null comment '名字',
	password  varchar(20) not null comment '密码',
	age int null ,
	sex int null comment '性别',
	phone varchar(20) null comment '电话',
	role_id  int  null comment '角色 0超级管理员，1管理员，2普通账号',
	isValid varchar(4) default'Y' null comment '是否有效，Y有效，其他无效'
)
charset = utf8

3.写配置文件

server:
  port: 8090
spring:
  datasource:
  //mysql8一般用 com.mysql.cj.jdbc.Driver这个，mysql5~7一般用 com.mysql.jdbc.Driver
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/***?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2b8
    username: root
    password: ******

4.加入CodeGenerator类，也就是生成代码的类

这个官网上有，给你传送一下：mybatis-plus代码生成器

但是我的和官网的不太一样，我的比较全一些，我又加了一些更多的代码生成器的自带的API

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

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

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("ls");
        gc.setOpen(false);
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);
        gc.setServiceName("%sService");
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/***?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2b8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("******");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模块名"));
        pc.setParent("com.example.springboot")
                .setEntity("entity")
                .setController("controller")
                .setServiceImpl("service.impl")
                .setService("service")
                .setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        //strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

里面有一些东西需要注意（都改成自己的就行了）：

数据库的配置
包的配置

将这个类运行一下，控制台会出现以下：
在这里插入图片描述
将表的名字输入进去，点击Enter键，就可以运行了，代码生成的类如上图所示(那是我已经运行代码生成完成的)

对于生成的代码，我们需要改动的特别少

检查mapper上面是否有注解@Mapper
检查service的实现类上是否有@Service注解

自动生成的mapper.xml代码如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.springboot.mapper.UserMapper">

    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="com.example.springboot.entity.User">
        <result column="id" property="id" />
        <result column="no" property="no" />
        <result column="name" property="name" />
        <result column="password" property="password" />
        <result column="age" property="age" />
        <result column="sex" property="sex" />
        <result column="phone" property="phone" />
        <result column="role_id" property="roleId" />
        <result column="isValid" property="isvalid" />
    </resultMap>

    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
        id,no, name, password, age, sex, phone, role_id, isValid
    </sql>

</mapper>

5.测试运行

在controller类中加一些代码用来测试运行：

    @Autowired
    private UserService userService;
    @GetMapping("/list")
    public List<User> list(){
        return userService.list();
    }

当然，我们要在数据库中的user表里加入一些数据

运行之后，在浏览器中输入https://localhost:+端口号/user/list就会出现一下页面，你所加在数据中的数据就会被显示出来
在这里插入图片描述