devbox
Monodyee
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Gradle项目使用MyBatis-generator自动生成MyBatis映射代码_gradle mybatis generator

作者：Monodyee | 2024-03-25 06:22:07

赞

踩

gradle mybatis generator

Gradle项目使用MyBatis-generator自动生成MyBatis映射代码

目录

引用：

1，方式一：使用类 MyBatisGenerator

准备的xml: generatorConfig.xml

类：MybatisGeneratorUtil

2，使用build任务生成：

Xml：generatorConfigMb.xml

Build.gradle:

生成结果：

3.使用ant的方式：

1，GeneratorAntTask

类：MybatisAntGeneratorUtil

2，使用build任务ant方式（失败）

Builde.gradle:

数据库文件：jdbc.properties

xml 文件：generator-config.xml

刷新项目并执行：

报错：

总结：

引用：

   Maven库  （PS: 找jar包，用它基本就够了，当然前提是知道哪个jar包，比如ant包）

dependency.gradle:

  1. //统一依赖定义
  2.  
  3. ext.libraries = [
  4.  
  5.  
  6. mybatisGenerators: [
  7.  
  8.         'org.mybatis.generator:mybatis-generator-core:1.4.0',
  9.  
  10.         'mysql:mysql-connector-java:5.1.48',
  11.  
  12.         'org.mybatis:mybatis:3.5.1',
  13.  
  14.         'org.apache.ant:ant:1.10.5'
  15.  
  16. ]
  17. ]
 

buidle.gradle 添加dependecy.gradle的引用

apply from: 'dependency.gradle'

1，方式一：使用类 MyBatisGenerator

准备的xml: generatorConfig.xml
 

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2.  
  3. <!DOCTYPE generatorConfiguration PUBLIC
  4.  
  5.         "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  6.  
  7.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
  8.  
  9. <generatorConfiguration>
  10.  
  11.     <context id="context" targetRuntime="MyBatis3">
  12.  
  13.         <!--覆盖生成XML文件 -->
  14.  
  15.         <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
  16.  
  17.         <commentGenerator>
  18.  
  19.             <property name="suppressAllComments" value="true"/>
  20.  
  21.             <property name="suppressDate" value="true"/>
  22.  
  23.         </commentGenerator>
  24.  
  25.         <!-- 数据库的相关配置 -->
  26.  
  27.         <jdbcConnection driverClass="com.mysql.jdbc.Driver"
  28.  
  29.                         connectionURL="jdbc:mysql://localhost:3306/yan?useSSL=false" userId="yan" password="yan.123"/>
  30.  
  31.         <javaTypeResolver>
  32.  
  33.             <property name="forceBigDecimals" value="false"/>
  34.  
  35.         </javaTypeResolver>
  36.  
  37.         <!-- 实体类生成的位置 -->
  38.  
  39.         <javaModelGenerator targetPackage="com.report.entity.po" targetProject="src/main/java">
  40.  
  41.             <property name="enableSubPackages" value="false"/>
  42.  
  43.             <property name="trimStrings" value="true"/>
  44.  
  45.         </javaModelGenerator>
  46.  
  47.         <!-- *Mapper.xml 文件的位置 -->
  48.  
  49.         <sqlMapGenerator targetPackage="report" targetProject=".\src\main\resources\mybatis">
  50.  
  51.             <property name="enableSubPackages" value="false"/>
  52.  
  53.         </sqlMapGenerator>
  54.  
  55.         <!-- Mapper 接口文件的位置 -->
  56.  
  57.         <javaClientGenerator targetPackage="com.report.repository" targetProject="src/main/java" type="XMLMAPPER">
  58.  
  59.             <property name="enableSubPackages" value="false"/>
  60.  
  61.         </javaClientGenerator>
  62.  
  63.         <!-- 相关表的配置 -->
  64.  
  65.         <table tableName="sys_report_class" domainObjectName="SysReportClass" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  66.  
  67.         <table tableName="sys_report_param" domainObjectName="SysReportParam" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  68.  
  69.             </context>
  70.  
  71. </generatorConfiguration>

  <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
注意： 使用类生成的时候，要添加这个，不然会追加生成

类：MybatisGeneratorUtil

  1. public class MybatisGeneratorUtil {
  2.  
  3.  
  4.  
  5.     public static void main(String[] args) {
  6.  
  7.          generateMybatisInfo();
  8.  
  9.     }
  10.  
  11.  
  12.  
  13.     private static void generateMybatisInfo() {
  14.  
  15.         try {
  16.  
  17.             System.out.println("start generator ...");
  18.  
  19.  
  20.  
  21.             List<String> warnings = new ArrayList<>();
  22.  
  23.             File configFile = new File("src/main/resources/mybatis/config/generatorConfig.xml");
  24.  
  25.             ConfigurationParser cp = new ConfigurationParser(warnings);
  26.  
  27.             Configuration config = cp.parseConfiguration(configFile);
  28.  
  29.             DefaultShellCallback callback = new DefaultShellCallback(true);
  30.  
  31.             MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
  32.  
  33.             myBatisGenerator.generate(null);
  34.  
  35.  
  36.  
  37.             System.out.println("end generator!");
  38.  
  39.         } catch (IOException | XMLParserException | InterruptedException | SQLException | InvalidConfigurationException e) {
  40.  
  41.             e.printStackTrace();
  42.  
  43.         }
  44.  
  45.  
  46.  
  47.     }
  48.  
  49. }

 如果上面lib引用没效果，build.gradle 里面加：

  1.  implementation 'org.mybatis.generator:mybatis-generator:1.4.0'
  2.  implementation 'org.mybatis.generator:mybatis-generator-core:1.4.0'

2，使用build任务生成：

Xml：generatorConfigMb.xml 

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2.  
  3. <!DOCTYPE generatorConfiguration PUBLIC
  4.  
  5.         "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  6.  
  7.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
  8.  
  9. <generatorConfiguration>
  10.  
  11.     <context id="context" targetRuntime="MyBatis3">
  12.  
  13.         <!--覆盖生成XML文件  使用gradle任务的方式会读取不到-->
  14.  
  15. <!--<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />-->
  16.         <commentGenerator>
  17.  
  18.             <property name="suppressAllComments" value="true"/>
  19.  
  20.             <property name="suppressDate" value="true"/>
  21.  
  22.         </commentGenerator>
  23.  
  24.         <!-- 数据库的相关配置 -->
  25.  
  26.         <jdbcConnection driverClass="com.mysql.jdbc.Driver"
  27.  
  28.                         connectionURL="jdbc:mysql://localhost:3306/yan?useSSL=false" userId="yan" password="yan.123"/>
  29.  
  30.         <javaTypeResolver>
  31.  
  32.             <property name="forceBigDecimals" value="false"/>
  33.  
  34.         </javaTypeResolver>
  35.  
  36.         <!-- 实体类生成的位置 -->
  37.  
  38.         <javaModelGenerator targetPackage="com.report.entity.po" targetProject="src/main/java">
  39.  
  40.             <property name="enableSubPackages" value="false"/>
  41.  
  42.             <property name="trimStrings" value="true"/>
  43.  
  44.         </javaModelGenerator>
  45.  
  46.         <!-- *Mapper.xml 文件的位置 -->
  47.  
  48.         <sqlMapGenerator targetPackage="report" targetProject=".\src\main\resources\mybatis">
  49.  
  50.             <property name="enableSubPackages" value="false"/>
  51.  
  52.         </sqlMapGenerator>
  53.  
  54.         <!-- Mapper 接口文件的位置 -->
  55.  
  56.         <javaClientGenerator targetPackage="com.report.repository" targetProject="src/main/java" type="XMLMAPPER">
  57.  
  58.             <property name="enableSubPackages" value="false"/>
  59.  
  60.         </javaClientGenerator>
  61.  
  62.         <!-- 相关表的配置 -->
  63.  
  64.         <table tableName="sys_report_class" domainObjectName="SysReportClass" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  65.  
  66.         <table tableName="sys_report_param" domainObjectName="SysReportParam" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  67.  
  68.             </context>
  69.  
  70. </generatorConfiguration>

注意： 使用任务的生成的方式，不会覆盖。

<!--<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />-->
这边就注释了。不然会报找不到的错误

Build.gradle:

  1. plugins {
  2.         id "com.arenagod.gradle.MybatisGenerator" version "1.4" //gradle提供的mybatis generator插件
  3. }
  4.  
  5.  
  6. mybatisGenerator {
  7.  
  8.     verbose = true
  9.  
  10.     configFile = 'src/main/resources/mybatis/config/generatorConfigMb.xml'
  11.  
  12. }
 

点击更新，然后点击：mbGenerator

生成结果：

3.使用ant的方式：

1，GeneratorAntTask

Xml: generatorConfig.xml 同方法一的xml

类：MybatisAntGeneratorUtil

  1. public class MybatisAntGeneratorUtil {
  2.  
  3.  
  4.  
  5.     public static void main(String[] args) {
  6.  
  7.         generateMybatisXml();
  8.  
  9.     }
  10.  
  11.  
  12.  
  13.     public static void generateMybatisXml() {
  14.  
  15.         try {
  16.  
  17.             System.out.println("start mybatis generator ...");
  18.  
  19.             GeneratorAntTask task = new GeneratorAntTask();
  20.  
  21.  
  22.  
  23.             String xmlPath = "D:/project/report/src/main/resources/mybatis/config/generatorConfig.xml";
  24.  
  25.             task.setConfigfile(xmlPath);    //（配置文件具体path）
  26.  
  27.             task.execute();
  28.  
  29.             System.out.println("end mybatis generator!");
  30.  
  31.         } catch (Exception e) {
  32.  
  33.             e.printStackTrace();
  34.  
  35.  
  36.  
  37.         }
  38.  
  39.     }
  40.  
  41.  
  42.  
  43. }

使用类GeneratorAntTask必须要引用 ant的包： 'org.apache.ant:ant:1.10.5'

2，使用build任务ant方式（失败）

Builde.gradle:

  1. plugins {
  2.  
  3.         id "com.arenagod.gradle.MybatisGenerator" version "1.4" //gradle提供的mybatis generator插件
  4.  
  5. }
  6.  
  7.  
  8. def getDbProperties = {
  9.  
  10.     def properties = new Properties()
  11.  
  12.     file("src/main/resources/mybatis/config/jdbc.properties").withInputStream { inputStream ->
  13.  
  14.         properties.load(inputStream)
  15.  
  16.     }
  17.  
  18.     properties
  19.  
  20. }
  21.  
  22.  
  23.  
  24. task mybatisGenerate << {
  25.  
  26.     def properties = getDbProperties()
  27.  
  28.     ant.properties['targetProject'] = projectDir.path
  29.  
  30.     ant.properties['driverClass'] = properties.getProperty("jdbc.driverClassName")
  31.  
  32.     ant.properties['connectionURL'] = properties.getProperty("jdbc.url")
  33.  
  34.     ant.properties['userId'] = properties.getProperty("jdbc.username")
  35.  
  36.     ant.properties['password'] = properties.getProperty("jdbc.password")
  37.  
  38.     ant.properties['src_main_java'] = sourceSets.main.java.srcDirs[0].path
  39.  
  40.     ant.properties['src_main_resources'] = sourceSets.main.resources.srcDirs[0].path
  41.  
  42.     ant.properties['modelPackage'] = properties.getProperty("modelPackage")
  43.  
  44.     ant.properties['mapperPackage'] = properties.getProperty("mapperPackage")
  45.  
  46.     ant.properties['sqlMapperPackage'] = properties.getProperty("sqlMapperPackage")
  47.  
  48.  
  49.  
  50.     ant.taskdef(
  51.  
  52.             name: 'mybatisGenerator',
  53.  
  54.             classname: 'org.mybatis.generator.ant.GeneratorAntTask',
  55.  
  56.             classpath: configurations.mybatisGenerator.asPath
  57.  
  58.     )
  59.  
  60.     ant.mybatisGenerator(overwrite: true,
  61.  
  62.             configfile: 'src/main/resources/mybatis/config/generator-config.xml', verbose: true) {
  63.  
  64.         propertyset {
  65.  
  66.             propertyref(name: 'targetProject')
  67.  
  68.             propertyref(name: 'userId')
  69.  
  70.             propertyref(name: 'driverClass')
  71.  
  72.             propertyref(name: 'connectionURL')
  73.  
  74.             propertyref(name: 'password')
  75.  
  76.             propertyref(name: 'src_main_java')
  77.  
  78.             propertyref(name: 'src_main_resources')
  79.  
  80.             propertyref(name: 'modelPackage')
  81.  
  82.             propertyref(name: 'mapperPackage')
  83.  
  84.             propertyref(name: 'sqlMapperPackage')
  85.  
  86.         }
  87.  
  88.     }
  89.  
  90. }

数据库文件：jdbc.properties

  1. jdbc.url=jdbc:mysql://localhost:3306/yan?useSSL=false
  2.  
  3. jdbc.username=yan
  4.  
  5. jdbc.password=yan.123
  6.  
  7. jdbc.driverClassName=com.mysql.jdbc.Driver
  8.  
  9.  
  10.  
  11. #生成实体类所在的包
  12.  
  13. modelPackage=com.ffcs.iod.ms.workflow.report.entity
  14.  
  15.  
  16.  
  17. #生成的mapper接口类所在包
  18.  
  19. mapperPackage=com.ffcs.iod.ms.workflow.report.repository
  20.  
  21. #生成的mapper xml文件所在包，默认存储在resources目录下
  22.  
  23. sqlMapperPackage=src/main/resources/mybatis/report
 

xml 文件：generator-config.xml

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2.  
  3. <!DOCTYPE generatorConfiguration PUBLIC
  4.  
  5.         "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  6.  
  7.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
  8.  
  9. <generatorConfiguration>
  10.  
  11.     <context id="context" targetRuntime="MyBatis3">
  12.  
  13.         <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"/>
  14.  
  15.         <commentGenerator>
  16.  
  17.             <property name="suppressAllComments" value="true"></property>
  18.  
  19.             <property name="suppressDate" value="true"></property>
  20.  
  21.             <property name="javaFileEncoding" value="utf-8"/>
  22.  
  23.         </commentGenerator>
  24.  
  25.         <!-- 数据库的相关配置 -->
  26.  
  27.         <jdbcConnection driverClass="${driverClass}"
  28.  
  29.                         connectionURL="${connectionURL}"
  30.  
  31.                         userId="${userId}"
  32.  
  33.                         password="${password}">
  34.  
  35.         </jdbcConnection>
  36.  
  37.  
  38.  
  39.         <javaTypeResolver>
  40.  
  41.             <property name="forceBigDecimals" value="false"/>
  42.  
  43.         </javaTypeResolver>
  44.  
  45.         <!-- 实体类生成的位置 -->
  46.  
  47.         <javaModelGenerator targetPackage="${modelPackage}" targetProject="${src_main_java}">
  48.  
  49.             <property name="enableSubPackages" value="true"></property>
  50.  
  51.             <property name="trimStrings" value="true"></property>
  52.  
  53.         </javaModelGenerator>
  54.  
  55.  
  56.  
  57.         <!-- *Mapper.xml 文件的位置 -->
  58.  
  59.         <sqlMapGenerator targetPackage="${sqlMapperPackage}" targetProject="${src_main_resources}">
  60.  
  61.             <property name="enableSubPackages" value="true"></property>
  62.  
  63.         </sqlMapGenerator>
  64.  
  65.  
  66.  
  67.  
  68.  
  69.         <!-- Mapper 接口文件的位置 -->
  70.  
  71.         <!--
  72.  
  73.         type=ANNOTATEDMAPPER表示不生成xml文件
  74.  
  75.         这里我用XMLMAPPER
  76.  
  77.         -->
  78.  
  79.         <javaClientGenerator targetPackage="${mapperPackage}" targetProject="${src_main_java}" type="XMLMAPPER">
  80.  
  81.             <property name="enableSubPackages" value="true"/>
  82.  
  83.         </javaClientGenerator>
  84.  
  85.  
  86.  
  87.         <!-- 相关表的配置 -->
  88.  
  89.         <table tableName="sys_report_class" domainObjectName="SysReportClass" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  90.  
  91.         <table tableName="sys_report_param" domainObjectName="SysReportParam" enableCountByExample="false"  enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/>
  92.     </context>
  93.  
  94. </generatorConfiguration>
 

刷新项目并执行：

报错：

* What went wrong:

Execution failed for task ':mybatisGenerate'.

> taskdef class org.mybatis.generator.ant.GeneratorAntTask cannot be found

   using the classloader AntClassLoader[]

网上查了下，没找到解决方式就放弃了。这种方式还麻烦。

总结：

 使用方法2最简单，方法1会简单些，方法3还有引用ant的jar包。 方式4网上很多案例都是那样，但是报错了，后面有机会碰到再更新。

  使用mybatis-generator生成，减少一些工作。

生成实体带注释：《生成的实体带注释​​​​​​​》

声明：本文内容由网友自发贡献，转载请注明出处：【wpsshop博客】
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号