LiushuiXiaoxia / mybatis-plus-gradle-generator

mybatis-plus code generator for gradle plugin

Mybatis Plus Gradle Generator

---

介绍

Web开发中使用mybatis比较多，MyBatis Plus是一个比较好的扩展，并且还可以自动生成代码，比较方便。 但是MyBatis Plus 对maven比较友好，对Gradle就比较差了，现在Spring Boot也对Gradle支持比较好，在使用Gradle生成代码的时候就比较麻烦。

Gradle Plugin

使用姿势

本插件需要结合Spring Boot项目一起使用，如下所示，首先添加插件依赖，当前版本为3.4.2.1

新版本

plugins {
    id "cn.mycommons.mpg" version "${version}"
}

或

老版本

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "cn.mycommons:buildSrc:${version}"
    }
}

apply plugin: "cn.mycommons.mpg"

然后配置相关属性即可，本配置可以参考MyBatis Plus 代码生成官方文档 ，基本配置和官方配置一样。

示例：表名为tb_app_info，前缀为tb_，生成的entity为AppInfo,mapper为AppInfoMapper.xml。

plugins {
    id "cn.mycommons.mpg" version "${version}"
}

// apply plugin: "cn.mycommons.mpg" // 老版本

mpg {
    enable = true

    globalConfig {
        outputDir = projectDir.path + "/src/main/java"
        author = "Admin"
        open = false
        baseResultMap = true
    }

    dataSourceConfig {
        driverName = "com.mysql.jdbc.Driver"
        url = "jdbc:mysql://localhost:3306/mpg_test?useUnicode=true&characterEncoding=utf8&useSSL=false"
        username = "root"
        password = "admin"
    }

    // sqlserver 示例
    dataSourceConfig {
        driverName = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
        url = "jdbc:sqlserver://11122;DatabaseName=222"
        username = "111"
        password = "22"
    }

    packageConfig {
        parent = "cn.mycommons.springdemo.mpg"
        entity = "mybatis.entity"
        mapper = "mybatis.mapper"
    }

    xmlMapperConfig {
        path = projectDir.path + "/src/main/resources/mapper/"
        name = "AppInfoMapper.xml"
    }

    strategyConfig {
        include = ["tb_app_info"]
        tablePrefix = ["tb_"]
        entityLombokModel = true
        restControllerStyle = true
        superEntityClass = "cn.mycommons.basic.dto.BaseEntity"
        logicDeleteFieldName = "is_delete"
        superEntityColumns = ["create_by", "create_time", "update_by", "update_time", "remark", "is_delete"]
        entityTableFieldAnnotationEnable(true)
        controllerMappingHyphenStyle = true
        superControllerClass = "cn.mycommons.basic.controller.BaseController"
    }
}

下面为自定义配置，表示生成xmlMapper的文件路径。

xmlMapperConfig {
    path = projectDir.path + "/src/main/resources/mapper/"
    name = "AppInfoMapper.xml"
}

然后执行Gradle Task mpg 即可。

相关链接

MyBatis Plus

MyBatis Plus 文档

MyBatis Plus Gradle Plugin Github

Gradle Plugin