MybatisPlu自动生成CRUD接口（二）

最新推荐文章于 2024-04-23 15:35:59 发布

有趣的灵魂_不世俗的心

最新推荐文章于 2024-04-23 15:35:59 发布

阅读量1k

点赞数 2

分类专栏： Java基础

本文链接：https://blog.csdn.net/weixin_42324471/article/details/103033341

版权

Java基础专栏收录该内容

64 篇文章 2 订阅

订阅专栏

作为一个有一定经验开发人员，一定不希望自己每天都在做简单CRUD操作，这样其实只是在浪费自己的时间，那么有没有什么工具让我们自动生成对数据库的CRUD操作啦？答案是肯定的，下面我们就介绍下如何通过MyBatisPlu中自定义模板（根据自己公司的基本需求）实现符合公司基本要求的CRUD接口（可以直接和前端联调的接口）。

话不多说直接讲实现：

首先我们要新建一个Maven搭建的SpringBoot项目

下面是我项目中用到的依赖（新建Maven项目复制如下依赖集合），

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<properties>
		<maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
	</properties>
  <dependencies>
  	    <dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
      <!-- 数据库相关依赖 -->
       <dependency>
		    <groupId>com.alibaba</groupId>
		    <artifactId>druid</artifactId>
		    <version>1.1.16</version>
		</dependency>
		<dependency>
		    <groupId>mysql</groupId>
		    <artifactId>mysql-connector-java</artifactId>
		   <version>8.0.11</version>
		</dependency>
		<!-- 数据库相关依赖 -->
		
		<!--添加 代码生成器 相关依赖-->
		<dependency>
		    <groupId>com.baomidou</groupId>
		    <artifactId>mybatis-plus-generator</artifactId>
		    <version>3.2.0</version>
		</dependency>
		<dependency>
		    <groupId>org.mybatis.spring.boot</groupId>
		    <artifactId>mybatis-spring-boot-starter</artifactId>
		    <version>1.1.1</version>
		</dependency>

		<dependency>
		   <groupId>org.projectlombok</groupId>
		   <artifactId>lombok</artifactId>
		</dependency>
		<dependency>
		    <groupId>org.freemarker</groupId>
		    <artifactId>freemarker</artifactId>
		    <version>2.3.29</version>
		</dependency>
		<!--添加 代码生成器 依赖-->
		
		<!-- fastjson依赖 -->
		<dependency>
		    <groupId>com.alibaba</groupId>
		    <artifactId>fastjson</artifactId>
		    <version>1.2.52</version>
		</dependency>
		<!-- 分页工具 -->
		<dependency>
		    <groupId>com.github.pagehelper</groupId>
		    <artifactId>pagehelper</artifactId>
		    <version>5.1.9</version>
		</dependency>
		<dependency>
			<groupId>com.github.pagehelper</groupId>
			<artifactId>pagehelper-spring-boot-autoconfigure</artifactId>
			<version>1.2.5</version>
		</dependency>
		<!-- 分页工具 -->
  </dependencies>

下面我们就要将如何利用MyBatisPlu生成代码实体类，大致的代码流程，

1、配置项目模块名称，要进行代码生成的表

2、进行全局配置（配置代码生成地址，类和接口的名字）

3、进行数据源的配置（基本的数据库URL，用户名和密码）

4、包配置

5、进行模板配置（自己定义的CRUD的方法），需要了解（Freemarker基本使用），后面会做简单的使用讲解，这一步是非常重要的一步。

6、配置基本的策略信息

public static void main(String[] args) {
				//  模块名
				  String moduleName = "guess";
				//  表名，多个英文逗号分割
				  String tableName = "guess_account,guess_bet_settle";
				  // 代码生成器
				  AutoGenerator mpg = new AutoGenerator();
				  // 全局配置
				  GlobalConfig gc = new GlobalConfig();
				  String projectPath = System.getProperty("user.dir");
				  gc.setOutputDir(projectPath + "/src/main/java");
				  gc.setAuthor("jack");
				  //设置对象的名称
				  gc.setEntityName("%s");//实体类命名
				  gc.setMapperName("%sMapper");//dao层接口命名
				  gc.setXmlName("%sMapper");//XML文件命名
				  gc.setServiceName("%sService");//Service层接口命名
				  gc.setServiceImplName("%sServiceImpl");//Service实现层命名
				  gc.setControllerName("%sController");
				  gc.setBaseColumnList(true);//设置XML自动生成表基本字段
				  gc.setBaseResultMap(true);//基本ResultMap
				  gc.setIdType(IdType.AUTO);//设置主键策略为(自增长)
				  // 生成后打开目录
				  gc.setOpen(false);
				 // gc.setSwagger2(true);// 实体属性 Swagger2 注解
				  mpg.setGlobalConfig(gc); 
				  // 数据源配置
				  DataSourceConfig dsc = new DataSourceConfig();
				  dsc.setUrl("jdbc:mysql://localhost:3306/citex_guess?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8");
				  dsc.setDriverName("com.mysql.cj.jdbc.Driver");
				  dsc.setUsername("jack");
				  dsc.setPassword("jack987");
				  mpg.setDataSource(dsc);
				  // 包配置
				  PackageConfig pc = new PackageConfig();
				  pc.setModuleName(moduleName);
				  pc.setParent("com.hongyu.mybatis");
				  mpg.setPackageInfo(pc);
				
				  // 自定义配置
				  InjectionConfig cfg = new InjectionConfig() {
				      @Override
				      public void initMap() {
				          // to do nothing
				      }
				  };
				  // 模板引擎是 freemarker
				  String templatePath = "templates/mapper.xml.ftl";
				  // 自定义输出配置
				  List<FileOutConfig> focList = new ArrayList<>();
				  
				  // 自定义配置XML生成的文件夹位置会被优先输出
				 focList.add(new FileOutConfig(templatePath) {
				      @Override
				      public String outputFile(TableInfo tableInfo) {
				          // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
				          return projectPath + "/src/main/resources/com/hongyu/mybatis/" + pc.getModuleName()
				                  + "/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
				      }
				  });
				 // 自定义生成VO对象
				  focList.add(new FileOutConfig("/templates/entityVo.java.ftl") {
				      @Override
				      public String outputFile(TableInfo tableInfo) {
				          // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
				          return projectPath + "/src/main/java/com/hongyu/mybatis/" + pc.getModuleName()
				                  + "/entity/vo/" + tableInfo.getEntityName() + "Vo" + StringPool.DOT_JAVA;
				      }
				  });
				  cfg.setFileOutConfigList(focList);
				  mpg.setCfg(cfg);
				  
				
				  // 配置模板
				  TemplateConfig templateConfig = new TemplateConfig();
				  //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
				  templateConfig.setEntity("templates/entity.java");
				  templateConfig.setMapper("templates/mapper.java");
				  templateConfig.setService("templates/service.java");
				  templateConfig.setServiceImpl("templates/serviceImpl.java");
				  templateConfig.setController("templates/controller.java");
				  //一定要设置为null,否则会在Mapper对应包下面生XML文件（重复XML）
				  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.entityTableFieldAnnotationEnable(true);
				  strategy.setControllerMappingHyphenStyle(true);
				  strategy.setInclude(tableName.split(","));
				// 策略配置
				  
				  mpg.setStrategy(strategy);
				  //设置模板引擎
				  mpg.setTemplateEngine(new FreemarkerTemplateEngine());
				  mpg.execute();
				
			}

下面我们来讲解下Freemarker，我想如果要大家从0开始写模板，可能有点难度，但是如果有基本模板参考,那就是事半功倍了。

首先我告诉大家去哪里获取基本模板

我们可以在项目的Maven依赖中找到mybatis-plus-generator包，然后找到对应的包的存储地址，将jarbao复制出来解压缩，就能够获取到Entity、Xml、Mapper等所有的模板。注意我们这里只需要后缀为.ftl的模板（Freemarker模板）。要使用模板，我们需要建立如下文件夹（templates），注意名字建议使用（templates），并将所有.ftl的模板复制到（templates）文件夹下。

下面我们来简单解读.ftl文件，我们以controller.java.ftl为例

package ${package.Controller};


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

<#if restControllerStyle>
import org.springframework.web.bind.annotation.RestController;
<#else>
import org.springframework.stereotype.Controller;
</#if>
<#if superControllerClassPackage??>
import ${superControllerClassPackage};
</#if>

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

}
</#if>

${}是Freemarker获取值得一种方法。

${package.Controller} 获取Controller层所在包的包名，同理我们可以获取${package.Service}，${package.ServiceImpl}

${table.comment!}获取数据库中对表的注释（DDL）中有体现，${table.entityPath}获取实体类的符合驼峰命名规则的名字（例如

表名guess_account 实体类 GuessAccount ${table.entityPath} ： guessAccount

${entity} ：GuessAccount 实体类的名字，${table.mapperName} mapper的名字 ${table.serviceName} service的名字

<#if restControllerStyle>
@RestController
<#else>
@Controller
</#if>

这个是Freemarker中的if...else..的用法。和mybatis的XML文件中的用法相似。

下面介绍模板中如何注入

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

对了，这个需要我们手动在模板中将包进行引入

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

import org.springframework.beans.factory.annotation.Autowired;

同理，所有的类引用都需要在模板中引入包。

然后代码的基本和我们正常写代码差别不大。.

下面给出entity.java.ftl作为参考

package ${package.Entity};

<#list table.importPackages as pkg>
import ${pkg};
</#list>
<#if swagger2>
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
</#if>
<#if entityLombokModel>
import lombok.Data;
</#if>
import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;

/**
 * <p>
 * ${table.comment!}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
@Data  
<#if table.convert>
@TableName("${table.name}")
</#if>
public class ${entity} implements Serializable {

<#if entitySerialVersionUID>
    private static final long serialVersionUID = 1L;
</#if>
 <#list table.fields as field>
	<#if "${field.propertyType}"?index_of("Date")!=-1>
	  @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8") 
	  private Date ${field.propertyName};
	<#else>
      private ${field.propertyType} ${field.propertyName};
	</#if> 
</#list>
 
}

如果想获取完整的项目，需要通过链接https://download.csdn.net/download/weixin_42324471/11973061获取

下面展示实现效果

PostMan实现效果

查询所有

按条件分页查询

还有基本的增删，根据主键批量删除，批量添加，根据条件删除，根据条件更新等操作就不逐一展示。

有趣的灵魂_不世俗的心

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
MybatisPlu自动生成CRUD接口（二）

作为一个有一定经验开发人员，一定不希望自己每天都在做简单CRUD操作，这样其实只是在浪费自己的时间，那么有没有什么工具让我们自动生成对数据库的CRUD操作啦？答案是肯定的，下面我们就介绍下如何通过MyBatisPlu中自定义模板（根据自己公司的基本需求）实现符合公司基本要求的CRUD接口（可以直接和前端联调的接口）。话不多说直接讲实现：首先我们要新建一个Maven搭建的SpringBoot...
复制链接

扫一扫