使用mybatis-plus-generator配置一套适合你的CRUD

已于 2023-04-03 14:56:00 修改
阅读量1.4k 收藏 3
点赞数
分类专栏： Java 文章标签： mybatis java 开发语言
于 2023-03-28 18:07:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37346639/article/details/129721112
版权

1、maven引入 mybatis-plus-generator 和模板引擎，你也可以使用freemarker之类的，看个人

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

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

2、创建MybatisCrud工具类，这里可以做很多个性化配置，比如改名他默认的 IService之类的，指定表，忽略某些字段等。更多详情见官网 代码生成器配置新 | MyBatis-Plus

package com.XXXX.utils;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.XXXX.entity.BaseEntity;

import java.util.Collections;

/**
 * @Auther:Tiancong Zou
 * @Date: 2023/3/16 21:46
 * @Description:
 */
public class MybatisCrud {
    public static void main(String[] args) {
        FastAutoGenerator.create(
                        "jdbc:mysql://127.0.0.1:3306/数据库名" ,
                        "root" ,
                        "")
                .globalConfig(builder -> {
                    builder.author("Tiancong Zou") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("D:\\myJavaTest\\"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.XXXX") // 设置父包名
                            .mapper("dao")
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D:\\myJavaTest\\mapper\\")); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.serviceBuilder()
                            .formatServiceFileName("%sService")
                            .formatServiceImplFileName("%sServiceImpl")
                            .convertServiceFileName((entityName -> entityName + "Service"));
                    builder.addInclude("sys_dict_item");// 设置需要生成的表名
                    builder.entityBuilder()
                            .superClass(BaseEntity.class )
                            .addIgnoreColumns("deleted","create_date","update_date");
                })
                .execute();
    }
}

3、copy模板，进行定制配置，找到jar包下的模板，复制templates到resources文件夹下，删除其他你不需要的模板。

f9953a3a69b04afe96e1b605cee92e1c.png

4、模板配置，这边使用 velocity 模板做演示

      4.1  controller.java.vm

package ${package.Controller};

import org.springframework.web.bind.annotation.*;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
import com.muchuantong.utils.Result;
import com.muchuantong.utils.SnowFlake;
import org.springframework.beans.factory.annotation.Autowired;

import java.sql.Timestamp;
import java.util.Date;
import java.util.List;
import java.util.Map;

#if(${superControllerClassPackage})
import ${superControllerClassPackage};
#end

/**
 * <p>
 * $!{table.comment} 前端控制器
 * </p>
 *
 * @Author: ${author}
 * @Date: ${date}
 * @Annotation:
 */

@RestController
@RequestMapping("#if(${package.ModuleName})/${package.ModuleName}#end/#if(${controllerMappingHyphenStyle})${controllerMappingHyphen}#else${table.entityPath}#end")
public class ${table.controllerName} {


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

// 分页
@GetMapping("getPage")
public  Result<Object> page(@ModelAttribute DTO dto){
        return ${table.entityPath}Service.getPage(dto);
        }

// 新增
@PostMapping("save")
public Result<Object> save(@RequestBody ${entity} ${table.entityPath}){
    ${table.entityPath}.setId(Long.toString(SnowFlake.nextId()));
    ${table.entityPath}.setCreateDate(new Timestamp(new Date().getTime()));
    ${table.entityPath}.setUpdateDate(new Timestamp(new Date().getTime()));
        try{
    ${table.entityPath}Service.save(${table.entityPath});
        return new Result<>();
        }catch(Exception e){
        e.printStackTrace();
        return new Result<>("201" ,"未知错误");
        }
        }
// 修改
@PostMapping("update")
public  Result<Object> update(@RequestBody ${entity} ${table.entityPath}){
        try{
    ${table.entityPath}.setUpdateDate(new Timestamp(new Date().getTime()));
    ${table.entityPath}Service.updateById(${table.entityPath});
        return new Result<>();
        }catch(Exception e){
        e.printStackTrace();
        return new Result<>("201" ,"未知错误");
        }

        }

// 根据id获取
@GetMapping("getById/{id}")
public  Result<Object> getById(@PathVariable("id") Long id){
    ${entity} ${table.entityPath} = ${table.entityPath}Service.getById(id);
        return new Result<>(${table.entityPath});
        }

// 逻辑删除
@PostMapping("deleteByIds")
public Result<Object> deleteByIds(@RequestBody List<Long> ids){
        for (Long id : ids) {
            ${entity} ${table.entityPath} = ${table.entityPath}Service.getById(id);
            ${table.entityPath}.setDeleted(1);
        try {
            ${table.entityPath}Service.updateById(${table.entityPath});
        return new Result<>();
        } catch (Exception e) {
        e.printStackTrace();
        return new Result<>("201", "未知错误");
        }
        }
        return null;
        }
        }

      4.2  service.java.vm

package ${package.Service};

import ${package.Entity}.${entity};
import ${superServiceClassPackage};
import com.muchuantong.utils.Result;

import java.util.Map;

/**
 * <p>
 * $!{table.comment} 服务类
 * </p>
 *
 * @Author: ${author}
 * @Date: ${date}
 * @Annotation:
 */
public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {
        Result getPage(DTO dto);
        }

4.3  serviceImpl.java.vm

package ${package.ServiceImpl};
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.google.common.primitives.Longs;
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import ${superServiceImplClassPackage};
import com.muchuantong.utils.Result;
import org.springframework.stereotype.Service;

import java.util.Map;
import java.util.Optional;
/**
 * <p>
 * $!{table.comment} 服务实现类
 * </p>
 *
 * @Author: ${author}
 * @Date: ${date}
 * @Annotation:
 */
@Service
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {
@Override
public Result getPage(DTO dto){
        QueryWrapper<${entity}> wrapper=new QueryWrapper<>();
        Page<${entity}> page=page(new Page<>(dto.getCurrent(),dto.getSize()),wrapper);
        return new Result<> (page);
        }
        }

 4.4  entity.java.vm

package ${package.Entity};

#foreach($pkg in ${table.importPackages})
import ${pkg};
#end
#if(${swagger})
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#end
#if(${entityLombokModel})
import lombok.Getter;
import lombok.Setter;
    #if(${chainModel})
    import lombok.experimental.Accessors;
    #end
#end

/**
 * <p>
 * $!{table.comment}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${entityLombokModel})
@Getter
@Setter
    #if(${chainModel})
    @Accessors(chain = true)
    #end
#end
#if(${table.convert})
@TableName("${schemaName}${table.name}")
#end
#if(${swagger})
@ApiModel(value = "${entity}对象", description = "$!{table.comment}")
#end
#if(${superEntityClass})
public class ${entity} extends ${superEntityClass}#if(${activeRecord})<${entity}>#end {
#elseif(${activeRecord})
public class ${entity} extends Model<${entity}> {
#elseif(${entitySerialVersionUID})
public class ${entity} implements Serializable {
#else
public class ${entity}{
#end
#if(${entitySerialVersionUID})

private static final long serialVersionUID = 1L;
#end
## ----------  BEGIN 字段循环遍历  ----------
#foreach($field in ${table.fields})

    #if(${field.keyFlag})
        #set($keyPropertyName=${field.propertyName})
    #end
    #if("$!field.comment" != "")
        #if(${swagger})
        @ApiModelProperty("${field.comment}")
        #else
        /**
         * ${field.comment}
         */
        #end
    #end
    #if(${field.keyFlag})
        ## 主键
        #if(${field.keyIdentityFlag})
        @TableId(value = "${field.annotationColumnName}", type = IdType.AUTO)
        #elseif(!$null.isNull(${idType}) && "$!idType" != "")
        @TableId(value = "${field.annotationColumnName}", type = IdType.${idType})
        #elseif(${field.convert})
        @TableId("${field.annotationColumnName}")
        #end
        ## 普通字段
    #elseif(${field.fill})
        ## -----   存在字段填充设置   -----
        #if(${field.convert})
        @TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
        #else
        @TableField(fill = FieldFill.${field.fill})
        #end
    #elseif(${field.convert})
    @TableField("${field.annotationColumnName}")
    #end
    ## 乐观锁注解
    #if(${field.versionField})
    @Version
    #end
    ## 逻辑删除注解
    #if(${field.logicDeleteField})
    @TableLogic
    #end
private ${field.propertyType} ${field.propertyName};
#end
## ----------  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(${chainModel})
        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(${chainModel})
                return this;
        #end
            }
    #end
    ## --foreach end---
#end
## --end of #if(!${entityLombokModel})--

#if(${entityColumnConstant})
    #foreach($field in ${table.fields})
    public static final String ${field.name.toUpperCase()} = "${field.name}";

    #end
#end
#if(${activeRecord})
@Override
public 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
        }

4.5  mapper.java.vm

package ${package.Mapper};

import ${package.Entity}.${entity};
import ${superMapperClassPackage};
#if(${mapperAnnotation})
import org.apache.ibatis.annotations.Mapper;
#end

/**
 * <p>
 * $!{table.comment} Mapper 接口
 * </p>
 *
 * @Author: ${author}
 * @Date: ${date}
 * @Annotation:
 */
#if(${mapperAnnotation})
@Mapper
#end
#if(${kotlin})
interface ${table.mapperName} : ${superMapperClass}<${entity}>
#else
public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {

}
#end

4.6 mapper.xml.vm

<?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="${package.Mapper}.${table.mapperName}">
    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
        #foreach($field in ${table.fields})
            #if(${field.keyFlag})##生成主键排在第一位
                <id column="${field.name}" property="${field.propertyName}" />
            #end
        #end
        #foreach($field in ${table.commonFields})##生成公共字段
            <result column="${field.name}" property="${field.propertyName}" />
        #end
        #foreach($field in ${table.fields})
            #if(!${field.keyFlag})##生成普通字段
                <result column="${field.name}" property="${field.propertyName}" />
            #end
        #end
    </resultMap>

    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
            #foreach($field in ${table.commonFields})
                ${field.columnName},
            #end
            ${table.fieldNames}
    </sql>
</mapper>

5、生成代码预览，毫无问题 controller

package com.muchuantong.controller;

import com.muchuantong.entity.DTO;
import org.springframework.web.bind.annotation.*;
import com.muchuantong.service.SysDictItemService;
import com.muchuantong.entity.SysDictItem;
import com.muchuantong.utils.Result;
import com.muchuantong.utils.SnowFlake;
import org.springframework.beans.factory.annotation.Autowired;

import java.sql.Timestamp;
import java.util.Date;
import java.util.List;
import java.util.Map;


/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @Author: Tiancong Zou
 * @Date: 2023-03-28
 * @Annotation:
 */

@RestController
@RequestMapping("/sysDictItem")
public class SysDictItemController {


    @Autowired
    private SysDictItemService sysDictItemService;

    // 分页
    @GetMapping("getPage")
    public  Result<Object> page(@ModelAttribute DTO dto){
        return sysDictItemService.getPage(dto);
    }

    // 新增
    @PostMapping("save")
    public Result<Object> save(@RequestBody SysDictItem sysDictItem){
        sysDictItem.setId(Long.toString(SnowFlake.nextId()));
        sysDictItem.setCreateDate(new Timestamp(new Date().getTime()));
        sysDictItem.setUpdateDate(new Timestamp(new Date().getTime()));
        try{
            sysDictItemService.save(sysDictItem);
            return new Result<>();
        }catch(Exception e){
            e.printStackTrace();
            return new Result<>("201" ,"未知错误");
        }
    }
    // 修改
    @PostMapping("update")
    public  Result<Object> update(@RequestBody SysDictItem sysDictItem){
        try{
            sysDictItem.setUpdateDate(new Timestamp(new Date().getTime()));
            sysDictItemService.updateById(sysDictItem);
            return new Result<>();
        }catch(Exception e){
            e.printStackTrace();
            return new Result<>("201" ,"未知错误");
        }

    }

    // 根据id获取
    @GetMapping("getById/{id}")
    public  Result<Object> getById(@PathVariable("id") Long id){
        SysDictItem sysDictItem = sysDictItemService.getById(id);
        return new Result<>(sysDictItem);
    }

    // 逻辑删除
    @PostMapping("deleteByIds")
    public Result<Object> deleteByIds(@RequestBody List<Long> ids){
        for (Long id : ids) {
            SysDictItem sysDictItem = sysDictItemService.getById(id);
            sysDictItem.setDeleted(1);
            try {
                sysDictItemService.updateById(sysDictItem);
                return new Result<>();
            } catch (Exception e) {
                e.printStackTrace();
                return new Result<>("201", "未知错误");
            }
        }
        return null;
    }
}

邹田聪
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
mybatis-plus-generator-maven-plugin-1.0.0.jar
11-15
为了在项目中快捷方便的代码生成，将mybatis-plus-generator封装为了一个maven的插件`mybatis-plus-generator-maven-plugin。使用文档参考：https://blog.csdn.net/xiweiller/article/details/103072165
【MybatisPlus】MybatisPlus的配置和使用
qq_56025938的博客
05-07 352
Mapper。
Mybatis-plus自动生成CRUD接口，可以实现通过实体类任意属性查询，CRUD神器
最新发布
jjj___jjj的博客
05-27 933
后端的程序员往往苦于写CRUD的编写，但是在出现Mybatis-Plus之后，大大简化了编写sql完成CRUD操作的繁琐步骤。当然自动生成代码也是快速编写代码的重要的一步，对此由于之前有写过相关的博客，这边就不多赘述了，可以参考https://blog.csdn.net/jjj___jjj/article/details/117172161言归正传，面对重复的业务，还是需要编写许多重复的代码去完成CRUD操作，那有没有什么方法可以减少大量重复的代码编写呢？请接往下看。
基于maven插件-代码生成器(MybatisPlus)
qq_53462109的博客
07-07 2613
代码生成器是一种自动化工具，用于根据预定义的模板和配置信息生成项目中的代码文件。它可以在开发过程中减少重复性的编码工作，提高开发效率。代码生成器通常会需要以下几个核心组件：其工作流程主要分为以下几个步骤; 常见的代码生成器工具有很多，例如Maven插件 MyBatis-Plus 的代码生成器、Spring Boot的代码生成器、Eclipse的代码生成插件等。这些工具通常提供了各种配置选项和模板库，可以根据具体项目的需求进行定制和扩展。 通过使用代码生成器，我们可以快速生成常
Java——SpringBoot搭建：使用MybatisPlus实现CRUD（三）
hxxxxm_w的博客
01-10 452
本文只是简单介绍MybatisPlus中的CRUD，后期会对文中一些细节做补充。如果跟着本文实操，你还需要在Student实体类上添加@Data注解，StudentMapper中添加@Mapper，并且继承BaseMapper。暂时只考虑到这么多（手动狗头）学会了CRUD你也就知道mybatisplus😊！以上内容就是我作为小白学习开发过程中最开始比较疑惑的地方，本文仅简单介绍，用于记录学习，并且希望帮助到像我一样的小白。
MybatisPlus------MyBatisX插件:快速生成代码以及快速生成CRUD（十二）
cz_chen_zhuo的博客
03-14 1万+
MyBatisX插件是IDEA插件，如果想要使用它，那么首先需要在IDEA中进行安装。
MyBatis-Plus 的官方示例(mybatis-plus-samples-master.zip)
05-05
mybatis-plus-sample-crud: 完整 CRUD 示例 mybatis-plus-sample-wrapper: 条件构造器示例 mybatis-plus-sample-pagination: 分页功能示例 mybatis-plus-sample-active-record: ActiveRecord示例 mybatis-plus-...
mybatis-plus-generator.rar
05-11
MyBatis-Plus 是 MyBatis 的一个扩展插件，主要功能是简化基于 MyBatis 的开发工作，尤其是对于常见的 CRUD（创建、读取、更新、删除）操作以及分页查询。MyBatis-Plus 提供了代码生成器，可以自动生成对应的实体类...
mybatis-plus-generator-ui
03-28
Mybatis-Plus-Generator-UI 是一个基于 Mybatis-Plus 的图形化代码生成工具，它为开发者提供了便捷的创建数据库表的 CRUD（Create、Read、Update、Delete）操作的前端界面。这个工具大大简化了开发过程，使得开发者...
Mybatis-Plus和Mybatis的区别详解
09-07
Mybatis和Mybatis-Plus是两个在Java开发中广泛使用的持久层框架，它们都致力于简化数据库操作。Mybatis-Plus是对Mybatis的扩展和增强，提供了更多的便利功能，旨在进一步提高开发效率。 **Mybatis** 是一个轻量级的...
Mybatis迁移到Mybatis-Plus的实现方法
09-07
在项目中引入Mybatis-Plus的依赖，通常会使用Spring Boot的起步依赖`mybatis-plus-boot-starter`，以及`mybatis-plus-generator`来生成代码。此外，还需要`velocity-engine-core`作为代码生成的模板引擎。注意避免...
Java中的Import和Pacakge作用生动详解(感觉python中的import作用差不多)
gukesdo的专栏
03-30 2606
转自：http://apps.hi.baidu.com/share/detail/6510541 有些人写了一阵子 Java，可是对於 Java的 package 跟import还是不太了解很多人以為原始码 .java档案中的 import会让编译器把所 import的程式通通写到编译好的 .class档案中，或是认為 import跟C/C++的#include相似，实际上，这是错误的观
MybatisPlus代码生成器模板中的常用参数
风流倜傥唐伯虎的博客
08-04 925
获取父类的类名 "superMapperClass": "BaseMapper", "superServiceClass": "IService", "superServiceImplClass": "ServiceImpl" 获取父类的全限定名 "superMapperClassPackage": "com.baomidou.mybatisplus.core.mapper.BaseMapper", "superServiceClassPackage": "com.baomidou.mybatis
mybatis-plus正确使用姿势：依赖配置、Mapper扫描、多数据源、自动填充、逻辑删除。。。
热门推荐
hualinger的博客
10-30 1万+
本文基于 springboot、maven、jdk1.8、mysql 开发，所以开始前我们需要准备好这套环境。
Java后端开发(Maven、Mybatis、Mybatis Plus
u014685437的博客
04-11 1403
jar 包的下载: 使用 Maven 之后，iar 包会从规范的远程仓库下载到本地。jar 包之间的冲突: 通过对依赖的配置进行调整，让某些 jar 包不会被导入。如果引入的依赖，在本地仓库不存在，将会连接远程仓库/中央仓库，然后下载依赖。方便快捷的项目管理以来的资源(jar包更新等)，避免版本冲突问题。依赖:指当前项目运行所需要的jar包，一个项目中可以引入多个依赖。依赖的jar包，默认情况下，可以在任何地方使用。jar 包之间的依赖: 通过依赖的传递性自动完成。
Mybatis-Plus详解:建立一个完整的maven项目，实现CRUD、分页、条件查询，前后端分离式开发，可作为学习模版
weixin_44821114的博客
09-06 479
上一页</a><a href="javascript:void(0)" @click="getStudentByPage(nextPage)">下一页</a><a href="javascript:void(0)" @click="getStudentByPage(pages)">尾页
SpringBoot + maven + mybatis plus 项目示例
weixin_43989242的博客
08-08 2454
学习基于SpringBoot + maven实现应用工程的创建和功能开发。包括对数据的增、删、改、查四类功能接口开发，技术实现需包含Controller、Service、Dao三层结构。持久层集成MybatisPlus框架实现数据库操作，SQL至少实现两种方式执行：1、XML文件配置方式；2、Wrapper方式。...
01.MyBatisPlus配置
qq_56403015的博客
12-22 203
mybatisPlus基础使用与配置
MyBatisPlus入门详细教程
一步一个脚印，踏实努力，向着目标前进
06-05 844
MyBatisPlus是MyBatis的增强工具，提供了很多便捷的功能，例如自动生成代码、分页查询、乐观锁、逻辑删除等。
mybatis-plus-boot-starter和mybatis-plus-generator
03-01
使用mybatis-plus-generator可以大大减少手动编写重复的CRUD代码的工作量，提高开发效率。 通过mybatis-plus-generator，我们只需要配置好数据库连接信息和需要生成代码的表名，然后运行代码生成器，即可自动生成...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

邹田聪

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值