前言

提示:Mybatis-puls使用代码生成器的笔记

导包

    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.5.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity</artifactId>
        <version>1.7</version>
    </dependency>

一、创建utils包

创建CodeGenerator类,粘贴以下代码

根据自己的项目情况修改以下必要的操作
url:
username:
password:
输出路径:
sql映射xml文件路径:
设置父包名:
设置表名:
过滤前缀:

/*
 * mp 代码生成器
 * by 汤哥哥
 * @since 2022-08-17
 * */

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;

import java.util.Collections;

public class CodeGenerator {

    public static void main(String[] args) {
        generate();
    }

    private static void generate() {
        /*
         * 官网复制源码粘贴
         * */
        FastAutoGenerator.create("url", "username", "password")
                .globalConfig(builder -> {
                    builder.author("汤哥哥") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("C:/Users/帅气汤哥哥/Desktop/springboot/src/main/java/"); // 指定输出目录,到java文件
                })
                .packageConfig(builder -> {
                    builder.parent("com.yyl.springboot") // 设置父包名,  --copy Reference
                            .moduleName(null) // 设置父包模块名,设置“”,生成时路径“//user”(双杠), null时"/user“(单杠)
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "C:/Users/帅气汤哥哥/Desktop/springboot/src/main/resources/com/yyl/springboot/mapper/")); // 设置mapperXml生成路径,Sql映射xml文件的路径
                })
                .strategyConfig(builder -> {
                    builder.entityBuilder().enableLombok();  //注解的生成方式
                    builder.mapperBuilder().enableMapperAnnotation().build();  //在每一个mapper接口加一个@Mapper注解
                    builder.controllerBuilder().enableHyphenStyle()  // 开启驼峰转连字符
                            .enableRestStyle();  // 开启生成@RestController 控制器
                    builder.addInclude("sys_user") // 设置需要生成的表名
                            .addTablePrefix("tb_", "sys_"); // 设置过滤表前缀
                })
//                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
                .execute();

    }
}

二、设置模板(控制类)

1.复制文件

在这里插入图片描述

2.粘贴到此文件下

在这里插入图片描述

3.将以下代码替换

模块可自定义,我这里做一个演示模范。

代码如下(示例):

package ${package.Controller};


import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.util.List;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;

#*
* entity: 类的包名
* *#
import $!{package.Service}.$!{table.serviceName};
import ${package.Entity}.${entity};




#if(${restControllerStyle})
import org.springframework.web.bind.annotation.RestController;
#else
import org.springframework.stereotype.Controller;
#end
#if(${superControllerClassPackage})
import ${superControllerClassPackage};
#end

/**
 * <p>
 * $!{table.comment} 前端控制器
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${restControllerStyle})
@RestController
#else
@Controller
#end
@RequestMapping("#if(${package.ModuleName})/${package.ModuleName}#end/#if(${controllerMappingHyphenStyle})${controllerMappingHyphen}#else${table.entityPath}#end")
#if(${kotlin})
class ${table.controllerName}#if(${superControllerClass}) : ${superControllerClass}()#end

#else
#if(${superControllerClass})
public class ${table.controllerName} extends ${superControllerClass} {
#else
public class ${table.controllerName} {
#end

        #*
        * 模块加在end下面
        * ${entity} == User
        * ${table.entityPath} == user
        * private ${table.serviceName} ${table.entityPath}Service == private UserService userService;
        * *#

        #*@Resource*#
        @Autowired
        @Qualifier("${table.entityPath}ServiceImpl")
        private ${table.serviceName} ${table.entityPath}Service;

        #*
        *  新增或者修改
        * *#
        @PostMapping
        public Boolean save(@RequestBody ${entity} ${table.entityPath}){
                return ${table.entityPath}Service.saveOrUpdate(${table.entityPath});
                }

         #*
         *  根据id删除
         * *#
        @DeleteMapping("/{id}")
        public Boolean delete(@PathVariable Integer id){
                return ${table.entityPath}Service.removeById(id);
                }

         #*
         * 批量删除
         * *#
        @PostMapping("del/batch")
        public boolean deleteBatch(@RequestBody List<Integer> ids) {   //处理的是[1,2,3]这样的数组,而主键id不一定是这样的,需要在前端扁平化处理一下
                return ${table.entityPath}Service.removeByIds(ids);
                }

        #*
        * 查询所有
        * *#
        @GetMapping
        public List<${entity}> findAll(){
                return ${table.entityPath}Service.list();
                }

         #*
         * 根据id查询一个
         * *#
        @GetMapping("/{id}")
        public ${entity} findOne(@PathVariable Integer id){
                return ${table.entityPath}Service.getById(id);
                }

        #*
        * 分页查询
        * *#
        @GetMapping("/page")
        public Page<${entity}> findPage(@RequestParam Integer pageNum,
                                        @RequestParam Integer pageSize
        ){
                QueryWrapper<User> queryWrapper = new QueryWrapper<>(); //对值空不空的做判断,如果空,那就不添加到里面去
                queryWrapper.orderByDesc("id");  //倒叙
                return ${table.entityPath}Service.page(new Page<>(pageNum,pageSize),queryWrapper);
        }

}

#end

三、对CodeGenerator运行即可


总结

代码生成器的使用基本就这样,另外还可以有自定义的模板需求,更多的可以去官方文档看以下是怎么使用的。

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐