springboot-gradle + mybatis-generator-plugin

最新推荐文章于 2024-06-09 20:22:14 发布

Inke

最新推荐文章于 2024-06-09 20:22:14 发布

阅读量4.4k

点赞数 1

分类专栏： spring-boot

本文链接：https://blog.csdn.net/Inke88/article/details/74766432

版权

spring-boot 专栏收录该内容

10 篇文章 2 订阅

订阅专栏

springboot-gradle + mybatis-generator-plugin

[toc]

因为inke一直使用 gradle 进行开发，所以学习 spring boot 的时候，比较推崇用 gradle 进行构建。

写博客的初衷是不想大家和我一样浪费时间在这里。

花了半天时间找方案，都是坑爹的方案：

大部分都是 maven plugin 方案
用的 mybatis 而不是 mybatis-spring-boot-starter:1.3.0，显然不是 spring boot的方案。
使用 gradle 然后在调用 ant 脚本，虽然 gradle 无缝兼容 maven 、ant，但是还是感觉不舒服。

又花了半天时间用来验证方案和写博客，一天时间都花在这上了。
-w300

mybatis-generator-plugin 插件地址：
https://github.com/kimichen13/mybatis-generator-plugin
方案来源：
gradle 官网提供的解决方案：
https://plugins.gradle.org/plugin/com.arenagod.gradle.MybatisGenerator

准备工作：数据库脚本

-- auto-generated definition
create table user
(
` id` int auto_increment comment '用户id'
    primary key,
name varchar(10) null comment '姓名'
)
comment ' 用户表'
;

第一步：配置 `build.gradle`

buildscript {
    ext {
        springBootVersion = '1.5.4.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
    mavenCentral()
}


dependencies {
    compile('org.springframework.boot:spring-boot-starter')
    testCompile('org.springframework.boot:spring-boot-starter-test')
    compile 'mysql:mysql-connector-java'
    //配置mybatis 数据源
    compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.0")
    testCompile('org.mybatis.spring.boot:mybatis-spring-boot-starter-test:1.3.0')

    compile('org.springframework.boot:spring-boot-starter-web')
}


//mybatis generator plugin ------ start
buildscript {
repositories {
    maven {
        url "https://plugins.gradle.org/m2/"
    }
}
dependencies {
    classpath "gradle.plugin.com.arenagod.gradle:mybatis-generator-plugin:1.4"
}
}

apply plugin: "com.arenagod.gradle.MybatisGenerator"

configurations {
    mybatisGenerator
}

mybatisGenerator {
    verbose = true
    configFile = 'src/main/resources/tools/generatorConfig.xml'
}
//mybatis generator plugin ------ end

第二步：配置 `generatorConfig.xml`

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
       PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
       "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<!-- 配置生成器 -->
<generatorConfiguration>

   <!--id:必选，上下文id，用于在生成错误时提示-->
   <context id="mysql" targetRuntime="MyBatis3">

       <!-- 生成的Java文件的编码 -->
       <property name="javaFileEncoding" value="UTF-8"/>

       <!-- 对注释进行控制 -->
       <commentGenerator>
           <!-- suppressDate是去掉生成日期那行注释 -->
           <property name="suppressDate" value="true"/>
           <!-- suppressAllComments是去掉所有的注解 -->
           <property name="suppressAllComments" value="true"/>
       </commentGenerator>

       <!--jdbc的数据库连接 -->
       <jdbcConnection
               driverClass="com.mysql.jdbc.Driver"
               connectionURL="jdbc:mysql://127.0.0.1:3306/test"
               userId="root"
               password="root">
       </jdbcConnection>

       <!-- java类型处理器
       用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
       注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
       -->
       <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
           <!--
               true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型
               false：默认,
                   scale>0;length>18：使用BigDecimal;
                   scale=0;length[10,18]：使用Long；
                   scale=0;length[5,9]：使用Integer；
                   scale=0;length<5：使用Short；
            -->
           <property name="forceBigDecimals" value="false"/>
       </javaTypeResolver>


       <!-- java模型创建器，是必须要的元素
           负责：1，key类（见context的defaultModelType）；2，java类；3，查询类
           targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
           targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
        -->
       <javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java">
           <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
           <property name="enableSubPackages" value="true"/>
           <!-- 是否对model添加 构造函数 -->
           <property name="constructorBased" value="true"/>
           <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
           <property name="trimStrings" value="true"/>
           <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
           <property name="immutable" value="false"/>
       </javaModelGenerator>

       <!-- 生成SQL map的XML文件生成器，
           注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
               或者只使用Mapper接口+Annotation，
               所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
           targetPackage/targetProject:同javaModelGenerator
        -->
       <sqlMapGenerator targetPackage="mapper.com.example.demo" targetProject="src/main/resources">
           <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
           <property name="enableSubPackages" value="true"/>
       </sqlMapGenerator>


       <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
           targetPackage/targetProject:同javaModelGenerator
           type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
               1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
               2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
               3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
           注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
       -->
       <javaClientGenerator targetPackage="com.example.demo.mapper" type="XMLMAPPER" targetProject="src/main/java">
           <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
           <property name="enableSubPackages" value="true"/>
       </javaClientGenerator>

       <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
           tableName（必要）：要生成对象的表名；
           domainObjectName 给表对应的 model 起名字
           注意：大小写敏感问题。
        -->
       <table tableName="user" domainObjectName="User">

           <!--用来修改表中某个列的属性,一个table元素中可以有多个columnOverride元素哈.
               property属性来指定列要生成的属性名称.
            -->
           <!--<columnOverride column="username" property="userName" />-->
       </table>

       <!--<table tableName="person" domainObjectName="Person"/>-->
       <!--<table tableName="department" domainObjectName="Depart"/>-->

   </context>

</generatorConfiguration>