mybatis-plus生成mapper扩展文件的方法

阅读提示

  具有mybatis基础,熟练使用mybatis-plus。

概述

  我们都知道,mybatis-plus是一个mybatis的增强工具,为简化开发、提高效率而生,我们经常使用mybatis-plus生成controller、service、mapper等文件,对于简单的curd,可以直接使用mybatis-plus封装好的方法。

  然而,我们经常有这样那样的需求,需要额外编写sql实现,如果直接在mapper.xml文件中编写,一旦数据库表结构改动需要重新生成文件就悲催了,不得不花大量精力修改代码。所以,这里介绍一种方式,自动生成mapper扩展文件,我们自定义编写的程序存放在扩展文件中,这样在数据库表结构改动时,不用担心程序会被覆盖,也不用修改代码。

mybatis-plus版本

<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.2.0</version>
</dependency>
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-generator</artifactId>
  <version>3.2.0</version>
</dependency>
<dependency>
  <groupId>org.apache.velocity</groupId>
  <artifactId>velocity-engine-core</artifactId>
  <version>2.1</version>
</dependency>

mybatis-plus生成mapper扩展文件

  熟悉mybatis-plus的朋友都知道,mybatis-plus提供了一款代码生成器,可以自动生成代码,我们就从这款代码生成器入手。

  代码生成器配置完毕后,运行时会执行 AutoGenerator.execute() 方法,我们先看看这个东东

熟悉的GlobalConfig、DataSourceConfig等等就不介绍了,我们关注的是InjectionConfig、TemplateConfig和ConfigBuilder。这里先讲述一下我们的思路:把ext文件通过配置直接生成,并保留mybatis-plus为service扩展的批量操作,我们需要三个文件,第一个文件生成ext.java,第二个文件生成ext.xml,第三个覆盖serviceImpl文件(保留mybatis-plus为service扩展的批量操作)

**************************干货来咯**************************

// 生成目录
public static final String OUTPUT_DIR = "项目路径/src/main/java";
// mapperExt目录
public static final String MAPPER_EXT = "ext目录";

// 模板配置,这里可以自定义模板路径,如果路径如下所示,则该部分可以省略
TemplateConfig tc = new TemplateConfig();
tc.setServiceImpl("templates/serviceImpl.java");
ag.setTemplate(tc);

// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
  @Override
  public void initMap() {
    Map<String, Object> map = new HashMap<>(10);
    /// 这里可以在 VM 文件中用 ${cfg.MapperExt} 引用该值
    map.put("MapperExt", MAPPER_EXT.replace('/', '.'));
    this.setMap(map);
  }
};

// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
focList.add(new FileOutConfig("templates/mapperExt.xml.vm") {
  @Override
  public String outputFile(TableInfo tableInfo) {
    return String.format("%s/%s/%sMapperExt%s", OUTPUT_DIR, MAPPER_EXT, tableInfo.getEntityName(), StringPool.DOT_XML);
  }
});
focList.add(new FileOutConfig("templates/mapperExt.java.vm") {
  @Override
  public String outputFile(TableInfo tableInfo) {
    return String.format("%s/%s/%sMapperExt%s", OUTPUT_DIR, MAPPER_EXT, tableInfo.getEntityName(), StringPool.DOT_JAVA);
  }
});
cfg.setFileCreate(new IFileCreate() {
  @Override
  public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
    // 如果是 mapperExt、service、controller 文件,并且已存在则不创建
    if (filePath.contains(MAPPER_EXT) || fileType == FileType.CONTROLLER || fileType == FileType.SERVICE || fileType == FileType.SERVICE_IMPL) {
    	if (new File(filePath).exists()) {
      	return false;
      }
    }
    // 判断文件夹是否需要创建
    checkDir(filePath);
    return true;
  }
});
cfg.setFileOutConfigList(focList);
ag.setCfg(cfg);

mapperExt.java.vm配置

package ${cfg.MapperExt};

import ${package.Mapper}.${table.mapperName};

/**
 * <p>
 * $!{table.comment} MapperExt 接口
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${kotlin})
interface ${table.mapperName}Ext : ${table.mapperName}
#else
public interface ${table.mapperName}Ext extends ${table.mapperName} {

}
#end

mapperExt.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="${cfg.MapperExt}.${table.mapperName}Ext">

</mapper>

serviceImpl.java.vm配置

package ${package.ServiceImpl};

import ${package.Entity}.${entity};
import ${cfg.MapperExt}.${table.mapperName}Ext;
import ${package.Service}.${table.serviceName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Service;

/**
 * <p>
 * $!{table.comment} 服务实现类
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
@Service
#if(${kotlin})
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}Ext, ${entity}>(), ${table.serviceName} {

}
#else
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}Ext, ${entity}> implements ${table.serviceName} {

}
#end

新思路(2020-04-17补充)

  我们概述中所述问题真的存在吗?mybatis-plus如果需要扩展文件那么他为什么不提供呢?当然是问题不存在,根本不需要扩展文件,如果你存在这样的问题,你总是覆盖文件说明你的用法有问题。

  这里直接说应该怎么使用,我们把本文所述的扩展的.vm文件通通删掉,InjectionConfiginitMap方法清空,focList相关全部删除,修改cfg.setFileCreate(...)如下所示

cfg.setFileCreate(new IFileCreate() {
  @Override
  public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
    // 如果已存在并且不是实体类则不创建
    if (new File(filePath).exists() && fileType != FileType.ENTITY) {
      return false;
    }
    // 判断文件夹是否需要创建
    checkDir(filePath);
    return true;
  }
});

  我们分析下:文件不存在一般是我们刚刚新建数据库表或者新增了一个表,此时肯定是要创建文件的。文件存在的时候分两种情况,一是文件是实体类,为了应对将来可能的新增修改删除字段,必须重写,那么使用时不能对该实体做任何增删改操作;二是文件非实体类,也就是service、map、xml等,因为代码生成和第一次生成没有什么区别,也就没有重写的必要,而且很多时候也已经编写了代码。

  如此,我们使用的时候只需要修改我们要生成的表就行了,即使把数据库表全部作为要生成的表也无所谓啦!

到此这篇关于mybatis-plus生成mapper扩展文件的方法的文章就介绍到这了,更多相关mybatis-plus生成mapper扩展文件内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Mybatis-Plus BaseMapper的用法详解

    1.如何使用BaseMapper进行数据库的操作. 2.使用BaseMapper进行插入实体时如何让UUID的主键自动生成. Student实体类,其中id属性主键为UUID package com.huixiaoer.ant.api.model.bean; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; public class Stud

  • MyBatis-Plus通过插件将数据库表生成Entiry,Mapper.xml,Mapper.class的方式

    创建maven项目,修改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://mave

  • 详解mybatis-plus的 mapper.xml 路径配置的坑

    mybatis-plus今天遇到一个问题,就是mybatis 没有读取到mapper.xml 文件. 特此记录一下,问题如下: org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.husy.mapper.SystemUserMapper.findUserByName at com.baomidou.mybatisplus.core.override.MybatisMapperMe

  • mybatis-plus生成mapper扩展文件的方法

    阅读提示   具有mybatis基础,熟练使用mybatis-plus. 概述   我们都知道,mybatis-plus是一个mybatis的增强工具,为简化开发.提高效率而生,我们经常使用mybatis-plus生成controller.service.mapper等文件,对于简单的curd,可以直接使用mybatis-plus封装好的方法.   然而,我们经常有这样那样的需求,需要额外编写sql实现,如果直接在mapper.xml文件中编写,一旦数据库表结构改动需要重新生成文件就悲催了,不得

  • 使用Mybatis Generator结合Ant脚本快速自动生成Model、Mapper等文件的方法

    MyBatis简介: MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架.MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装.MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录. 相关阅读:MyBatis入门学习教程(一)-MyBatis快速入门 使用过Mybatis的同学都知道,针对每一个项目中使用到的数据库表都需要建

  • Mybatis逆向生成使用扩展类的实例代码详解

    1.背景介绍 用的mybatis自动生成的插件,然而每次更改数据库的时候重新生成需要替换原有的mapper.xml文件,都要把之前业务相关的sql重新写一遍,感觉十分麻烦,就想着把自动生成的作为一个基础文件,然后业务相关的写在扩展文件里面,这样更改数据库后只需要把所有基础文件替换掉就可以了 2.代码 2.1 BaseMapper.java 把自动生成的方法都抽到一个base类,然后可以写一些公共的方法 /** * @author 吕梁山 * @date 2019/4/23 */ public i

  • MyBatis 中使用 Mapper 简化代码的方法

    前面文章所写的增删改查是存在问题的.每执行一次 SQL,都要开启一次会话,并且需要提交并关闭,主要问题就是冗余代码过多,模板化代码过多. 例如,我想开发一个 UserDao,可能是下面这样: 简化前的 UserDao public class UserDao { private SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getInstance(); public User getUserById(Integer id

  • 使用 webpack 插件自动生成 vue 路由文件的方法

    一款自动生成 vue 路由文件的 webpack 插件 vue-route-webpack-plugin在项目中试点成功了,现在在项目中已经不需要再维护路由配置文件了,由插件自动生成,节省了大家维护路由的时间. 从长远来看,使用插件自动生成路由是具有一定好处的.当项目中的路由配置非常多的时候,为了区分业务,你可能需要分成许多个文件来存放这些路由文件,这样就不得不去维护这些路由文件. 比如这样的路由文件结构: |-src/ |-router/ index.js childrenRouter.js

  • Laravel 将数据表的数据导出,并生成seeds种子文件的方法

    用过laravel的都知道,我们表里面的数据通常是保存到seeder文件中,但是有些时候需要将表里已有的数据导出到seed文件中,那么怎么导出呢,其实这里有个扩展包叫iseed,我们可以利用它来把数据表里的数据导出到seed中. 安装isseed 安装isseed,我这里是laravel 5.4,安装的iseed是2.1版本的,你们看情况,随意 composer require "orangehill/iseed": "2.1" 将iseed加入到composer.

  • python处理文本文件实现生成指定格式文件的方法

    本文所述实例为Python处理文本文件并生成指定格式文件的方法,具体实现功能代码如下所示: import os import sys import string #以指定模式打开指定文件,获取文件句柄 def getFileIns(filePath,model): print("打开文件") print(filePath) print(model) return open(filePath,model) #获取需要处理的文件 def getProcFile(path): return

  • java生成xml格式文件的方法

    本文实例讲述了java生成xml格式文件的方法.分享给大家供大家参考,具体如下: 这里演示利用Java生成xml格式文件 Demo中所用到的jar包Jdom.jar . 为了方便理解,我写了个Demo import java.io.FileOutputStream; import java.io.IOException; import org.jdom.Document; import org.jdom.Element; import org.jdom.JDOMException; import

  • Python实现将MySQL数据库表中的数据导出生成csv格式文件的方法

    本文实例讲述了Python实现将MySQL数据库表中的数据导出生成csv格式文件的方法.分享给大家供大家参考,具体如下: #!/usr/bin/env python # -*- coding:utf-8 -*- """ Purpose: 生成日汇总对账文件 Created: 2015/4/27 Modified:2015/5/1 @author: guoyJoe """ #导入模块 import MySQLdb import time impor

  • 使用pandas生成/读取csv文件的方法实例

    前言 csv是我接触的比较早的一种文件,比较好的是这种文件既能够以电子表格的形式查看又能够以文本的形式查看. 先引入pandas库 import pandas as pd 方法一: 1.我构造了一个cont_list,结构为列表嵌套字典,字典是每一个样本,类似于我们爬虫爬下来的数据的结构 2.利用pd.DataFrame方法先将数据转换成一个二维结构数据,如下方打印的内容所示,cloumns指定列表,列表必须是列表 3.to_csv方法可以直接保存csv文件,index=False表示csv文件

随机推荐