进阶，Mybatis-Plus代码生成器

最新推荐文章于 2022-08-06 21:16:03 发布

方糖敲代码

最新推荐文章于 2022-08-06 21:16:03 发布

阅读量1.2k

点赞数

分类专栏：技术总结文章标签： spring boot mybatis generator

本文链接：https://blog.csdn.net/u010679782/article/details/106274025

版权

技术总结专栏收录该内容

60 篇文章 2 订阅

订阅专栏

写在开始:一个搬砖程序员的随缘记录

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

Mybatis-Plus代码生成器方便的是可以自定义生成代码的模板，可以根据每个项目的不同配置不同的模板，也可以配置一个通用的进行简单的修改

一、准备工作

1、创建数据库

CREATE TABLE `tb_user_dat` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '姓名',
  `sex` int(11) DEFAULT NULL COMMENT '性别 1:男 2:女',
  `age` int(11) DEFAULT NULL COMMENT '年龄',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `create_user` int(11) DEFAULT NULL COMMENT '创建人',
  `update_time` datetime DEFAULT NULL COMMENT '修改时间',
  `update_user` int(11) DEFAULT NULL COMMENT '修改人',
  `is_delete` tinyint(1) DEFAULT '1' COMMENT '是否已删除 1:是 0:否',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

2、创建一个SpringBoot项目

可以看之前的文章：从零开始，SpringBoot项目快速搭建

也可以直接看：初识Mybatis-Plus

3、pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.cn</groupId>
    <artifactId>mybatis_plus_demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatis_plus_demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web-services</artifactId>
        </dependency>

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

        <!-- mysql -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

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

        <!--代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>

        <!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.8.1</version>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

4、application.yml

server:
  port: 8080 #端口号

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf-8 #数据库url
    username: root #数据库用户名
    password: admin #数据库密码
    driver-class-name: com.mysql.jdbc.Driver

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局逻辑删除字段值
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

二、Mybatis-Plus代码生成器

1、生成器代码

官网演示效果图：
在这里插入图片描述
下面是我结合官网修改后的代码：

package com.cn.mybatisplus.utils;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.*;

/**
 * Mybatis-Plus代码生成器
 * @Author: demo
 */
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.isNotEmpty(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("demo");
        gc.setOpen(false);
        //实体属性 Swagger2 注解
        gc.setSwagger2(true);
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&useSSL=false&characterEncoding=utf8");
        //dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("admin");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("mybatisplus");
        pc.setParent("com.cn");

        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/mybatis/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        String className = scanner("请输入类名简称：");
        String tableName = scanner("请输入表名描述：");
        Map<String, Object> map = new HashMap<>();
        map.put("className", className);
        map.put("tableName", tableName);

        cfg.setMap(map);

        focList.add(new FileOutConfig("/templates/add.java.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return projectPath + "/src/main/java/com/cn/mybatisplus/api/request/" + "AddOrUpdate" + className + "Req"
                        + StringPool.DOT_JAVA;
            }
        });

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null)
                .setServiceImpl("templates/serviceimpl.java")
                .setController("templates/controller.java")
                .setEntity("templates/entity.java")
                .setService("templates/service.java");


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

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        //表名
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        //strategy.setInclude("tbl_xb_user_dat");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        //自定义实体，公共字段(生成实体类不会生成)
        strategy.setSuperEntityColumns(
                new String[] { "id", "create_time", "create_user", "update_time", "update_user", "is_delete"});
        //自定义实体类父类
        //strategy.setSuperEntityClass("com.cn.xiaobai.entity.AbstractEntity");
        strategy.setSuperEntityClass("com.cn.mybatisplus.entity.AbstractEntity");
        mpg.setStrategy(strategy);
        //mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        //mpg.setTemplateEngine(new VelocityTemplateEngine());
        mpg.execute();
    }
}

2、个人需要修改配置的位置：

1、数据源

		// 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&useSSL=false&characterEncoding=utf8");
        //dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("admin");
        mpg.setDataSource(dsc);

2、包配置

		// 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("mybatisplus");
        pc.setParent("com.cn");

生成前的目录结构：
在这里插入图片描述
生成代码中：

生成代码后目录：

3、项目源码

下面贴出相关源码：
启动类：

package com.cn.mybatisplus;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.pagination.optimize.JsqlParserCountOptimize;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * @author demo
 */
@SpringBootApplication
@EnableTransactionManagement
@Configuration
@MapperScan("com.cn.mybatisplus.mapper")
public class MybatisPlusDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(MybatisPlusDemoApplication.class, args);
	}

	@Bean
	public PaginationInterceptor paginationInterceptor() {
		PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
		// 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
		// paginationInterceptor.setOverflow(false);
		// 设置最大单页限制数量，默认 500 条，-1 不受限制
		// paginationInterceptor.setLimit(500);
		// 开启 count 的 join 优化,只针对部分 left join
		paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
		return paginationInterceptor;
	}
}

用户新增/修改实体类
AddOrUpdateUserReq.Java

package com.cn.mybatisplus.api.request;


import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

/**
 * @author demo
 * @since 2020-05-22
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "用户新增/修改实体类")
public class AddOrUpdateUserReq implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "id(修改使用))")
    private Integer id;

    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "性别 1:男 2:女")
    private Integer sex;

    @ApiModelProperty(value = "年龄")
    private Integer age;

}

通用字段实体类
AbstractEntity.Java

package com.cn.mybatisplus.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.format.annotation.DateTimeFormat;

import java.util.Date;

/**
 * @Author: demo
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class AbstractEntity {
    @TableId(type = IdType.AUTO)
    private Integer id;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    private Integer createUser;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    private Integer updateUser;

    @TableLogic
    private Boolean isDelete;
}

用户实体类
TbUserDat.Java

package com.cn.mybatisplus.entity;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import com.baomidou.mybatisplus.annotation.TableName;

/**
 * <p>
 * TbUserDat对象
 * </p>
 *
 * @author demo
 * @since 2020-05-22
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user_dat")
@ApiModel(value = "用户对象")
public class TbUserDat extends AbstractEntity {
    private static final long serialVersionUID = 1L;
    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "性别 1:男 2:女")
    private Integer sex;

    @ApiModelProperty(value = "年龄")
    private Integer age;


}

controller:

package com.cn.mybatisplus.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.cn.mybatisplus.api.request.AddOrUpdateUserReq;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import com.cn.mybatisplus.service.TbUserDatService;
import com.cn.mybatisplus.entity.TbUserDat;

/**
 * @author demo
 * @since 2020-05-22
 */
@Api(tags = "用户控制层")
@RestController
@Slf4j
public class TbUserDatController {

    @Autowired
    private TbUserDatService tbUserDatService;

    /**
     * 分页查询用户列表
     *
     * @param pageNum
     * @param pageSize
     * @return
     */
    @ApiOperation("分页查询用户列表")
    @GetMapping("/user/page")
    public IPage<TbUserDat> getPageList(@RequestParam("pageNum") Integer pageNum, @RequestParam("pageSize") Integer pageSize) {
        return tbUserDatService.getPageList(pageNum, pageSize);
    }

    /**
     * 添加用户
     *
     * @param req
     * @return
     */
    @ApiOperation("添加用户")
    @PostMapping("/user")
    public Integer add(@RequestBody AddOrUpdateUserReq req) {
        return tbUserDatService.add(req);
    }

    /**
     * 修改用户
     *
     * @param req
     * @return
     */
    @ApiOperation("修改用户")
    @PatchMapping("/user")
    public Integer update(@RequestBody AddOrUpdateUserReq req) {
        if (req.getId() == null) {
            return -1;
        }
        return tbUserDatService.update(req);
    }

    /**
     * 根据id查询用户详情
     *
     * @param id
     * @return
     */
    @ApiOperation("根据id获取用户详情")
    @GetMapping("/user/{id}")
    public TbUserDat edit(@PathVariable("id") Integer id) {
        return tbUserDatService.edit(id);
    }


    /**
     * 根据id删除用户数据
     *
     * @param id
     * @return
     */
    @ApiOperation("根据id删除用户")
    @DeleteMapping("/user/{id}")
    public Integer delete(@PathVariable("id") Integer id) {
        if (id == null) {
            return -1;
        }
        return tbUserDatService.delete(id);
    }
}

service

package com.cn.mybatisplus.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;

import com.cn.mybatisplus.api.request.AddOrUpdateUserReq;
import com.cn.mybatisplus.entity.TbUserDat;

/**
 * <p>
 * 用户服务类
 * </p>
 *
 * @author demo
 * @since 2020-05-22
 */
public interface TbUserDatService extends IService<TbUserDat> {
    /**
     * 分页查询用户列表
     *
     * @param pageNum
     * @param pageSize
     * @return
     */
    IPage<TbUserDat> getPageList(Integer pageNum, Integer pageSize);

    /**
     * 添加用户
     *
     * @param req
     * @return
     */
    Integer add(AddOrUpdateUserReq req);

    /**
     * 修改用户
     *
     * @param req
     * @return
     */
    Integer update(AddOrUpdateUserReq req);

    /**
     * 根据id查询用户详情
     *
     * @param id
     * @return
     */
    TbUserDat edit(Integer id);

    /**
     * 根据id删除用户数据
     *
     * @param id
     * @return
     */
    Integer delete(Integer id);

}

serviceImpl

package com.cn.mybatisplus.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.cn.mybatisplus.api.request.AddOrUpdateUserReq;
import com.cn.mybatisplus.mapper.TbUserDatMapper;
import com.cn.mybatisplus.service.TbUserDatService;
import com.cn.mybatisplus.entity.TbUserDat;

import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service;

/**
 * <p>
 * 用户服务类
 * </p>
 *
 * @author demo
 * @since 2020-05-22
 */
@Service
public class TbUserDatServiceImpl extends ServiceImpl<TbUserDatMapper, TbUserDat> implements TbUserDatService {

    @Override
    public IPage<TbUserDat> getPageList(Integer pageNum, Integer pageSize) {
        //分页
        Page<TbUserDat> page = new Page<>(pageNum, pageSize);
        //加入筛选条件
        QueryWrapper queryWrapper = new QueryWrapper();
        queryWrapper.eq("is_delete", false);
        Page<TbUserDat> tbUserDatPage = page(page, queryWrapper);
        return tbUserDatPage;
    }

    @Override
    public Integer add(AddOrUpdateUserReq req) {
        TbUserDat data = new TbUserDat();
        BeanUtils.copyProperties(req, data);
        save(data);
        return data.getId();
    }

    @Override
    public Integer update(AddOrUpdateUserReq req) {
        TbUserDat data = new TbUserDat();
        BeanUtils.copyProperties(req, data);
        updateById(data);
        return data.getId();
    }

    @Override
    public TbUserDat edit(Integer id) {
        return getById(id);
    }

    @Override
    public Integer delete(Integer id) {
        removeById(id);
        return id;
    }
}

mapper

package com.cn.mybatisplus.mapper;

import com.cn.mybatisplus.entity.TbUserDat;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
 * <p>
 * Mapper 接口
 * </p>
 *
 * @author demo
 * @since 2020-05-22
 */
public interface TbUserDatMapper extends BaseMapper<TbUserDat> {

}

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.cn.mybatisplus.mapper.TbUserDatMapper">

</mapper>

下面是代码生成模板
新增/修改实体类模板
add.java.vm

package com.cn.mybatisplus.api.request;


#foreach($pkg in ${table.importPackages})
#end
#if(${swagger2})
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#end
#if(${entityLombokModel})
#end
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

/**
 *
 * @author ${author}
 * @since ${date}
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "${cfg.tableName}新增/修改实体类")
public class AddOrUpdate${cfg.className}Req implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "id(修改使用))")
    private Integer id;

    #foreach($field in ${table.fields})
        #if("$!field.comment" != "")
            @ApiModelProperty(value = "${field.comment}")
            private ${field.propertyType} ${field.propertyName};

        #end
    #end
}

controller模板
controller.java.vm

package ${package.Controller};

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};

/**
 * @author ${author}
 * @since ${date}
 */
@Api(tags = "${cfg.tableName}控制层")
@RestController
@Slf4j
public class ${table.controllerName}  {

@Autowired
private ${table.serviceName}  ${table.entityPath}Service;

    /**
     * 分页查询${cfg.tableName}列表
     *
     * @param pageNum
     * @param pageSize
     * @return
     * */
@ApiOperation("分页查询${cfg.tableName}列表")
@GetMapping("/user/page")
public IPage<${entity}> getPageList(@RequestParam("pageNum") Integer pageNum, @RequestParam("pageSize") Integer pageSize) {
        return ${table.entityPath}Service.getPageList(pageNum, pageSize);
        }

/**
* 添加${cfg.tableName}
*
* @param req
* @return
* */
@ApiOperation("添加${cfg.tableName}")
@PostMapping("/user")
public Integer add(@RequestBody AddOrUpdate${cfg.className}Req req){
        return ${table.entityPath}Service.add(req);
        }

/**
* 修改${cfg.tableName}
*
* @param req
* @return
* */
@ApiOperation("修改${cfg.tableName}")
@PatchMapping("/user")
public Integer update(@RequestBody AddOrUpdate${cfg.className}Req req){
        if (req.getId() == null) {
        return -1;
        }
        return ${table.entityPath}Service.update(req);
        }

/**
* 根据id查询${cfg.tableName}详情
*
* @param id
* @return
* */
@ApiOperation("根据id获取${cfg.tableName}详情")
@GetMapping("/user/{id}")
public ${entity} edit(@PathVariable("id") Integer id){
        return ${table.entityPath}Service.edit(id);
        }


/**
* 根据id删除${cfg.tableName}数据
*
* @param id
* @return
* */
@ApiOperation("根据id删除${cfg.tableName}")
@DeleteMapping("/user/{id}")
public Integer delete(@PathVariable("id") Integer id){
        if (id == null) {
        return -1;
        }
        return ${table.entityPath}Service.delete(id);
        }
        }

实体类模板
entity.java.vm

package ${package.Entity};

    #foreach($pkg in ${table.importPackages})
    import ${pkg};
    #end
    #if(${swagger2})
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    #end
    #if(${entityLombokModel})
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    #end
import com.baomidou.mybatisplus.annotation.TableName;
/**
 * <p>
 * ${entity}对象
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${entityLombokModel})
@Data
@NoArgsConstructor
@AllArgsConstructor
#end
@TableName("${table.name}")
#if(${swagger2})
@ApiModel(value = "${cfg.tableName}对象")
#end
#if(${superEntityClass})
public class ${entity} extends ${superEntityClass}#if(${activeRecord})<${entity}>#end {
#elseif(${activeRecord})
public class ${entity} extends Model<${entity}> {
#else
public class ${entity} implements Serializable {
#end
private static final long serialVersionUID = 1L;
## ----------  BEGIN 字段循环遍历  ----------
#foreach($field in ${table.fields})
    #if(${field.keyFlag})
        #set($keyPropertyName=${field.propertyName})
    #end
    #if("$!field.comment" != "")
        #if(${swagger2})
        @ApiModelProperty(value = "${field.comment}")
        #end
    #end
    #if(${field.keyFlag})
        #if(${field.keyIdentityFlag})
        @TableId(value = "${field.name}", type = IdType.AUTO)
        #elseif(!$null.isNull(${idType}) && "$!idType" != "")
        @TableId(value = "${field.name}", type = IdType.${idType})
        #elseif(${field.convert})
        @TableId("${field.name}")
        #end
    #elseif(${field.fill})
        #if(${field.convert})
        @TableField(value = "${field.name}", fill = FieldFill.${field.fill})
        #else
        @TableField(fill = FieldFill.${field.fill})
        #end
    #elseif(${field.convert})
    @TableField("${field.name}")
    #end
    #if(${logicDeleteFieldName}==${field.name})
    @TableLogic
    #end
private ${field.propertyType} ${field.propertyName};

#end
#if(!${entityLombokModel})
    #foreach($field in ${table.fields})
        #if(${field.propertyType.equals("boolean")})
            #set($getprefix="is")
        #else
            #set($getprefix="get")
        #end
    public ${field.propertyType} ${getprefix}${field.capitalName}() {
            return ${field.propertyName};
            }
        #if(${entityBuilderModel})
        public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        #else
        public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        #end
            this.${field.propertyName} = ${field.propertyName};
        #if(${entityBuilderModel})
                return this;
        #end
            }
    #end
#end

#if(${entityColumnConstant})
    #foreach($field in ${table.fields})
    public static final String ${field.name.toUpperCase()} = "${field.name}";
    #end
#end
#if(${activeRecord})
@Override
protected Serializable pkVal() {
    #if(${keyPropertyName})
            return this.${keyPropertyName};
    #else
            return null;
    #end
        }
#end
#if(!${entityLombokModel})
@Override
public String toString() {
        return "${entity}{" +
    #foreach($field in ${table.fields})
        #if($!{foreach.index}==0)
                "${field.propertyName}=" + ${field.propertyName} +
        #else
                ", ${field.propertyName}=" + ${field.propertyName} +
        #end
    #end
        "}";
        }
#end
        }

service模板
service.java.vm

package ${package.Service};

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;

import ${package.Entity}.${entity};

/**
 * <p>
 * ${cfg.tableName}服务类
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
public interface ${table.serviceName} extends IService<${entity}> {
        /**
         * 分页查询${cfg.tableName}列表
         *
         * @param pageNum
         * @param pageSize
         * @return
         * */
        IPage<${entity}> getPageList(Integer pageNum, Integer pageSize);

        /**
        * 添加${cfg.tableName}
        *
        * @param req
        * @return
        * */
        Integer add(AddOrUpdate${cfg.className}Req req);

        /**
        * 修改${cfg.tableName}
        *
        * @param req
        * @return
        * */
        Integer update(AddOrUpdate${cfg.className}Req req);

        /**
       * 根据id查询${cfg.tableName}详情
       *
       * @param id
       * @return
       * */
    ${entity} edit(Integer id);

        /**
        * 根据id删除${cfg.tableName}数据
        *
        * @param id
        * @return
        * */
        Integer delete(Integer id);

        }

serviceimpl模板

package ${package.Service}.impl;

import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};

import org.springframework.stereotype.Service;

/**
 * <p>
 * ${cfg.tableName}服务类
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
@Service
public class ${table.serviceName}Impl extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {

@Override
public IPage<${entity}> getPageList(Integer pageNum, Integer pageSize) {
        //分页
        Page<${entity}> page = new Page<>(pageNum,pageSize);
        //加入筛选条件
        QueryWrapper queryWrapper = new QueryWrapper();
        queryWrapper.eq("is_delete", false);
        Page<${entity}> tbUserDatPage = page(page, queryWrapper);
        return tbUserDatPage;
        }

@Override
public Integer add(AddOrUpdate${cfg.className}Req req){
    ${entity} data=new  ${entity}();
        BeanUtils.copyProperties(req,data);
        save(data);
        return data.getId();
        }

@Override
public Integer update(AddOrUpdate${cfg.className}Req req){
    ${entity} data=new  ${entity}();
        BeanUtils.copyProperties(req,data);
        updateById(data);
        return data.getId();
        }

@Override
public ${entity} edit(Integer id){
        return getById(id);
        }

@Override
public Integer delete(Integer id){
        removeById(id);
        return id;
        }
        }

swagger相关代码：
swaggerConfig.Java

package com.cn.mybatisplus.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Author: demo
 * @Date: 2020-04-15 17:21
 */
@Configuration
@EnableSwagger2
public class swaggerConfig {
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger RESTful APIs")
                .description("swagger RESTful APIs")
                .termsOfServiceUrl("http://www.test.com/")
                .contact("xiaoymin@foxmail.com")
                .version("1.0")
                .build();
    }
}

WebMvcConfig.Java

package com.cn.mybatisplus.config;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

/**
 * @Author: demo
 */
@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

4、项目源码链接

mybatis_plus_demo.zip

Over

方糖敲代码

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
进阶，Mybatis-Plus代码生成器

写在开始:一个搬砖程序员的随缘记录AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。Mybatis-Plus代码生成器方便的是可以自定义生成代码的模板，可以根据每个项目的不同配置不同的模板，也可以配置一个通用的进行简单的修改文章目录一、准备工作1、创建数据库2、创建一个SpringBoot项目3、pom.
复制链接

扫一扫