MyBatis-Plus-Generator 自动生成代码

兜小满

已于 2023-03-07 11:18:49 修改

阅读量1.8k

点赞数

文章标签：学习

于 2022-12-09 11:21:24 首次发布

本文链接：https://blog.csdn.net/qq_46079815/article/details/128249970

版权

MyBatis-Plus-Generator 自动生成代码

在平时写代码的时候有没有觉得写实体类和 Dao 层的接口比较麻烦呢 MyBatis-Plus 的 Generator 为我们解决了这个问题，它可以根据一张表的字段信息推演出 Domain 以及 Dao层的接口，下面记录一下 Generator 具体用法

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

文章目录

MyBatis-Plus-Generator 自动生成代码
@[toc]
1. MyBatisPlus 提供模板
2. 工程搭建和基本代码编写
创建SpringBoot工程，添加代码生成器相关依赖，其他依赖自行添加
编写代码生成器类
开发者自定义配置

3. 示例源码
4. 结果展示

1. MyBatisPlus 提供模板

传送门：适用版本：mybatis-plus-generator 3.5.1 及其以上版本，对历史版本不兼容！代码生成器（新）

		适用版本：mybatis-plus-generator 3.5.1 以下版本 [代码生成器（旧）](https://baomidou.com/pages/d357af/#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B)

2. 工程搭建和基本代码编写

创建SpringBoot工程，添加代码生成器相关依赖，其他依赖自行添加

<!--代码生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>

<!--velocity模板引擎-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

编写代码生成器类

package run.xiaoliu;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;

public class Generator {
    public static void main(String[] args) {
        //1. 创建代码生成器对象，执行生成代码操作
        AutoGenerator autoGenerator = new AutoGenerator();

        //2. 数据源相关配置：读取数据库中的信息，根据数据库表结构生成代码
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/generator?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("123456");
        autoGenerator.setDataSource(dataSource);

         //3. 执行生成操作
        autoGenerator.execute();
    }
}

开发者自定义配置

设置全局配置

//设置全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir")+"/generator/src/main/java"); //设置代码生成位置
globalConfig.setOpen(false);    			//设置生成完毕后是否打开生成代码所在的目录
globalConfig.setAuthor("小六");    		   //设置作者
globalConfig.setFileOverride(true);     	//设置是否覆盖原始生成的文件
globalConfig.setMapperName("%sDao");    	//设置数据层接口名，%s为占位符，指代模块名称
globalConfig.setIdType(IdType.ASSIGN_ID);   //设置Id生成策略
autoGenerator.setGlobalConfig(globalConfig);

设置包名相关配置

//设置包名相关配置
PackageConfig packageInfo = new PackageConfig();
packageInfo.setParent("run.xiaoliu.test");   //设置生成的包名，与代码所在位置不冲突，二者叠加组成完整路径
packageInfo.setEntity("domain");    //设置实体类包名
packageInfo.setMapper("dao");   	//设置数据层包名
autoGenerator.setPackageInfo(packageInfo);

策略设置

//策略设置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tb_user");  //设置当前参与生成的表名，参数为可变参数
strategyConfig.setTablePrefix("tb_");  //设置数据库表的前缀名称，模块名 = 数据库表名 - 前缀名  例如： User = tbl_user - tbl_
strategyConfig.setRestControllerStyle(true);    	//设置是否启用Rest风格
strategyConfig.setVersionFieldName("version");  	//设置乐观锁字段名
strategyConfig.setLogicDeleteFieldName("deleted");  //设置逻辑删除字段名
strategyConfig.setEntityLombokModel(true);  		//设置是否启用lombok
autoGenerator.setStrategy(strategyConfig);

3. 示例源码

数据表标准

编辑自动生成类

package run.xiaoliu.mpgenerator;

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;

public class CodeGenerator {
    public static void main(String[] args) {
        // 获取代码生成器的对象
        AutoGenerator autoGenerator = new AutoGenerator();

        // 设置数据库相关配置
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/ts_generator?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("123456");
        autoGenerator.setDataSource(dataSource);

        // 设置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir")+"/src/main/java");    //设置代码生成位置
        globalConfig.setOpen(false);                 //设置生成完毕后是否打开生成代码所在的目录
        globalConfig.setAuthor("小六");              //设置作者
        globalConfig.setFileOverride(true);         //设置是否覆盖原始生成的文件
        globalConfig.setMapperName("%sDao");        //设置数据层接口名，%s为占位符，指代模块名称
        globalConfig.setIdType(IdType.ASSIGN_ID);   //设置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);

        // 设置包名相关配置
        PackageConfig packageInfo = new PackageConfig();
        packageInfo.setParent("run.xiaoliu");   //设置生成的包名，与代码所在位置不冲突，二者叠加组成完整路径
        packageInfo.setEntity("domain");        //设置实体类包名
        packageInfo.setMapper("dao");           //设置数据层包名
        autoGenerator.setPackageInfo(packageInfo);

        // 策略设置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("tb_user");  //设置当前参与生成的表名，参数为可变参数
        strategyConfig.setTablePrefix("tb_");  //设置数据库表的前缀名称，模块名 = 数据库表名 - 前缀名  例如： User = tbl_user - tbl_
        strategyConfig.setRestControllerStyle(true);        //设置是否启用Rest风格
        strategyConfig.setVersionFieldName("version");      //设置乐观锁字段名
        strategyConfig.setLogicDeleteFieldName("deleted");  //设置逻辑删除字段名
        strategyConfig.setEntityLombokModel(true);          //设置是否启用lombok
        autoGenerator.setStrategy(strategyConfig);
        // 执行生成操作
        autoGenerator.execute();
    }
}

4. 结果展示

生成的目录结构（不包括 mpgenerator）：

控制器 controller.UserController

package run.xiaoliu.controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

/**
 *  前端控制器
 *
 * @author 小六
 * @since 2022-11-05
 */
@RestController
@RequestMapping("/user")
public class UserController {

}

Mapper接口 dao.UserDao

package run.xiaoliu.dao;
import run.xiaoliu.domain.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
 *  Mapper 接口
 *
 * @author 小六
 * @since 2022-11-05
 */
public interface UserDao extends BaseMapper<User> {
}

实体类 domain.User

package run.xiaoliu.domain;

import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.Version;
import com.baomidou.mybatisplus.annotation.TableId;
import java.io.Serializable;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * 实体类
 *
 * @author 小六
 * @since 2022-11-05
 */
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("tb_user")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主键id
     */
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Integer id;

    /**
     * 用户名
     */
    private String username;

    /**
     * 年龄
     */
    private Integer age;

    /**
     * 性别
     */
    private Integer gender;
}

服务类接口 service.IUserService

package run.xiaoliu.service;

import run.xiaoliu.domain.User;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 *  服务类
 *
 * @author 小六
 * @since 2022-11-05
 */
public interface IUserService extends IService<User> {

}

服务实现类 service.impl.UserServiceImpl

package run.xiaoliu.service.impl;
import run.xiaoliu.domain.User;
import run.xiaoliu.dao.UserDao;
import run.xiaoliu.service.IUserService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
/**
 *  服务实现类
 *
 * @author 小六
 * @since 2022-11-05
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserDao, User> implements IUserService {
}

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="run.xiaoliu.dao.UserDao">
</mapper>

以上即使用 MyBatis-Plus-Generator 自动生成代码的简单演示，特此记录！

兜小满

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
MyBatis-Plus-Generator 自动生成代码

在平时写代码的时候有没有觉得写实体类和 Dao 层的接口比较麻烦呢 MyBatis-Plus 的 Generator 为我们解决了这个问题，它可以根据一张表的字段信息推演出 Domain 以及 Dao层的接口，下面记录一下 Generator 具体用法AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
复制链接

扫一扫