手册   游戏   WEB   字典   单词   在线工具  

Mybatis 自动生成代码工具嵌入 Maven 项目中,实现一键生成数据库表对应的 java,xml 文件

Maven 项目中用了 mybatis 框架, 因此自然的用到了代码生成工具 mybatis-generator-core-1.3.2.jar.

我们一开始的做法是配置好 generatorConfig.xml 文件后, 打开 cmd 命令窗口进入到生成文件所在的子项目目录中, 执行命令: mvn mybatis-generator:generate.

这种生成方式的操作太麻烦了, 除了要打开命令窗口进入生成目录运行命令, 还要提前删除已经生成的的 xml 文件, 如果你的 dao 层 mapper 文件中类继承了父接口, 还要因为被覆盖而需要重新写入继承代码, 总之就是挺麻烦的, 于是花了点时间进行优化.

下面一步步介绍实现过程.

1, 首先是看看我们的项目结构, 我们生成的代码是在 common 子项目中的

image.png

2,pom.xml 文件中引入下面的依赖 (数据库驱动包, 我们是 mysql 数据库, 其他数据库引用对应的依赖就可以了)

  1. <dependency>
  2.       <groupId>mysql</groupId>
  3.       <artifactId>mysql-connector-java</artifactId>
  4.       <version>5.1.38</version>
  5.       <scope>compile</scope>
  6. </dependency>
  7. <dependency>
  8.       <groupId>org.mybatis.generator</groupId>
  9.       <artifactId>mybatis-generator-core</artifactId>
  10.       <version>1.3.2</version>
  11.  </dependency>
  12. <dependency>
  13.       <groupId>log4j</groupId>
  14.       <artifactId>log4j</artifactId>
  15.       <version>1.2.17</version>
  16. </dependency>
  17. <dependency>
  18.       <groupId>org.aspectj</groupId>
  19.       <artifactId>aspectjweaver</artifactId>
  20.       <version>1.8.10</version>
  21. </dependency>

3, 看下图, 我们需要创建两个配置文件, log4j.properties 放在 src/main/java 目录下, generatorConfig.xml 放在 src/main/resources 目录下, 后面附上两个文件代码

image.png

log4j.properties 代码

  1. log4j.rootLogger=DEBUG, Console
  2. #Console
  3. log4j.appender.Console=org.apache.log4j.ConsoleAppender
  4. log4j.appender.Console.layout=org.apache.log4j.PatternLayout
  5. log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
  6. log4j.logger.java.sql.ResultSet=INFO
  7. log4j.logger.org.apache=INFO
  8. log4j.logger.java.sql.Connection=DEBUG
  9. log4j.logger.java.sql.Statement=DEBUG
  10. log4j.logger.java.sql.PreparedStatement=DEBUG

myGeneratorConfig.xml 代码, 要特别注意其中的注释说明

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator
  3. Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  4. <!-- 生成数据库表对应文件说明: 1, 配置生成的表 2, 执行类 GeneratorSqlmapUtil -->
  5. <generatorConfiguration>
  6.     <!-- 配置一个代码生成操作, 如果生成的目录或是数据库不一样, 只需要参考增加一个 context 节点即可 -->
  7.     <context id="context1">
  8.         <!-- 这里的 type 里写的是你的实现类的类全路径, 注: 如果不配置 type 属性, 则会使用默认的 CommentGenerator
  9.         实现类 -->
  10.         <commentGenerator>
  11.             <!-- 去除自动生成的注释 -->
  12.             <!-- <property name="suppressAllComments" value="true" />
  13.             -->
  14.             <!-- 是否生成注释代时间戳 -->
  15.             <property name="suppressDate" value="true" />
  16.         </commentGenerator>
  17.         <!-- 配置数据库, driverClass 请根据所使用的数据库配置 -->
  18.         <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://xxx.xxx.xxx:3306 / 数据库名称? useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true"
  19.         userId="数据库用户名" password="数据库登陆密码">
  20.         </jdbcConnection>
  21.         <javaTypeResolver>
  22.             <property name="forceBigDecimals" value="false" />
  23.         </javaTypeResolver>
  24.         <!-- 配置实体类, example 类生成的路径 -->
  25.         <javaModelGenerator targetPackage="com.xxx.xxx.model.common" targetProject="src/main/java"
  26.         />
  27.         <!-- 配置 mapper.xml 文件生成的路径 (注: 此处的 targetPackage 只要在 base/mybatis / 后面设置上面类文件包路径中最后一个名称就可以了)
  28.         -->
  29.         <sqlMapGenerator targetPackage="base/mybatis/common" targetProject="src/main/resources"
  30.         />
  31.         <!-- 配置 mapper 接口生成的路径, 此处必须配置在 javaModelGenerator 和 sqlMapGenerator 后面,
  32.         不然会报错 并且为生成的接口添加一个父接口, 此处配置的父接口多一个下划线, 以备生成后提示错误以引导手动去完成正确的接口继承 (继承 BaseMapper
  33.         并且将泛型类设置为对应的实体类, example 类, 并且删除生成的方法) -->
  34.         <javaClientGenerator targetPackage="com.xxx.xxx.dao.common" type="XMLMAPPER"
  35.         targetProject="src/main/java">
  36.             <!-- <property name="rootInterface" value="com.xxx.xxx.dao.base.BaseMapper_"
  37.             />
  38.             -->
  39.         </javaClientGenerator>
  40.         <!-- 配置生成的表格, 同时生成多张表可以配置多个 < table> 标签 -->
  41.         <table schema="database" tableName="common_table1" />
  42.     </context>
  43. </generatorConfiguration>

4, 在 src/main/java 目录下任意包创建两个 java 类, 下面分别贴上代码并简单介绍.

(1)GeneratorSqlmap.java 类, 该类主要是读取配置文件, 对目标表已经生成的 xml 文件进行删除, 对 mapper 文件进行备份, 恢复, 调用生成工具执行生成操作, 具体过程请阅读下面的源码.

  1. package com.xxx.xxx.util.generator;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.util.ArrayList;
  5. import java.util.HashMap;
  6. import java.util.List;
  7. import java.util.Map;
  8. import java.util.Map.Entry;
  9. import org.aspectj.util.FileUtil;
  10. import org.mybatis.generator.api.MyBatisGenerator;
  11. import org.mybatis.generator.config.Configuration;
  12. import org.mybatis.generator.config.Context;
  13. import org.mybatis.generator.config.JavaClientGeneratorConfiguration;
  14. import org.mybatis.generator.config.JavaModelGeneratorConfiguration;
  15. import org.mybatis.generator.config.SqlMapGeneratorConfiguration;
  16. import org.mybatis.generator.config.TableConfiguration;
  17. import org.mybatis.generator.config.xml.ConfigurationParser;
  18. import org.mybatis.generator.internal.DefaultShellCallback;
  19. import org.springframework.util.ResourceUtils;
  20. import com.xxx.xxx.util.StringUtil;
  21. /**
  22.  * 根据数据库表生成 model,example,mapper.xml 文件
  23.  * @author 北北
  24.  * @date 2017 年 12 月 8 日下午 3:30:54
  25.  */
  26. public class GeneratorSqlmap {
  27.     /**
  28.      * 根据配置的数据库表生成源码
  29.      * @author 北北
  30.      * @date 2018 年 1 月 17 日上午 11:04:26
  31.      * @throws Exception
  32.      */
  33.     public void generator() throws Exception {
  34.         List < String > warnings = new ArrayList < String > ();
  35.         boolean overwrite = true;
  36.         // 读取配置文件
  37.         File configFile = ResourceUtils.getFile("classpath:myGeneratorConfig.xml");
  38.         ConfigurationParser cp = new ConfigurationParser(warnings);
  39.         Configuration config = cp.parseConfiguration(configFile);
  40.         // 删除需要生成的 xml 文件
  41.         this.deleteOldXmlFile(config);
  42.         // 对 Mapper 文件备份处理
  43.         Map < String,
  44.         String > mapperFileValue = this.backupMapperFile(config);
  45.         // 生成代码执行
  46.         DefaultShellCallback callback = new DefaultShellCallback(overwrite);
  47.         MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
  48.         myBatisGenerator.generate(null);
  49.         // 恢复已经存在的 Mapper 文件
  50.         this.recoverMapperFile(mapperFileValue);
  51.     }
  52.     /**
  53.      * 恢复已经存在的 Mapper 文件
  54.      * @author 北北
  55.      * @date 2018 年 1 月 17 日下午 4:13:22
  56.      * @param mapperFileValue
  57.      */
  58.     private void recoverMapperFile(Map < String, String > mapperFileValue) {
  59.         for (Entry < String, String > fileValue: mapperFileValue.entrySet()) {
  60.             String filePath = fileValue.getKey();
  61.             String content = fileValue.getValue();
  62.             File file = new File(filePath);
  63.             FileUtil.writeAsString(file, content);
  64.         }
  65.     }
  66.     /**
  67.      * 对已经生成过的 Mapper 文件进行缓存备份
  68.      * @author 北北
  69.      * @date 2018 年 1 月 17 日下午 4:59:02
  70.      * @param config
  71.      * @return
  72.      */
  73.     private Map < String,
  74.     String > backupMapperFile(Configuration config) {
  75.         List < Context > contextList = config.getContexts();
  76.         Map < String,
  77.         String > fileValueMap = new HashMap < >();
  78.         for (Context context: contextList) {
  79.             JavaClientGeneratorConfiguration mapperConfig = context.getJavaClientGeneratorConfiguration();
  80.             String mapperProject = mapperConfig.getTargetProject();
  81.             String mapperPackage = mapperConfig.getTargetPackage();
  82.             List < TableConfiguration > tableList = context.getTableConfigurations();
  83.             for (TableConfiguration table: tableList) {
  84.                 // 提取文件名
  85.                 String fileName = table.getDomainObjectName();
  86.                 if (fileName == null) {
  87.                     fileName = StringUtil.camelName(table.getTableName());
  88.                 }
  89.                 fileName += "Mapper.java";
  90.                 // 将包中的. 全部替换为 /
  91.                 mapperPackage = mapperPackage.replaceAll("\\.", "/");
  92.                 String mapperPath = mapperProject + "/" + mapperPackage + "/" + StringUtil.upperCaseFirst(fileName);
  93.                 File mapperFile = new File(mapperPath);
  94.                 // 如果已经存在的 Mapper 文件, 备份
  95.                 if (mapperFile.exists()) {
  96.                     String content;
  97.                     try {
  98.                         content = FileUtil.readAsString(mapperFile);
  99.                         fileValueMap.put(mapperPath, content);
  100.                         System.out.println("备份文件:" + mapperFile);
  101.                     } catch(IOException e) {
  102.                         e.printStackTrace();
  103.                     }
  104.                 }
  105.             }
  106.         }
  107.         return fileValueMap;
  108.     }
  109.     /**
  110.      * 删除旧的 xml 文件, 避免内容重复
  111.      * @author 北北
  112.      * @date 2018 年 1 月 17 日下午 3:51:35
  113.      * @param config
  114.      */
  115.     private void deleteOldXmlFile(Configuration config) {
  116.         List < Context > contextList = config.getContexts();
  117.         for (Context context: contextList) {
  118.             SqlMapGeneratorConfiguration sqlConfig = context.getSqlMapGeneratorConfiguration();
  119.             String sqlProject = sqlConfig.getTargetProject();
  120.             String sqlPackage = sqlConfig.getTargetPackage();
  121.             List < TableConfiguration > tableList = context.getTableConfigurations();
  122.             for (TableConfiguration table: tableList) {
  123.                 // 提取文件名
  124.                 String fileName = table.getDomainObjectName();
  125.                 if (fileName == null) {
  126.                     fileName = StringUtil.camelName(table.getTableName());
  127.                 }
  128.                 fileName += "Mapper.xml";
  129.                 // 根据 xml 文件相对路径创建 file 对象
  130.                 String xmlPath = sqlProject + "/" + sqlPackage + "/" + StringUtil.upperCaseFirst(fileName);
  131.                 File xmlFile = new File(xmlPath);
  132.                 // 如果已经存在的 Xml 文件, 删除
  133.                 if (xmlFile.exists()) {
  134.                     xmlFile.delete();
  135.                     System.out.println("删除文件:" + xmlPath);
  136.                 }
  137.             }
  138.         }
  139.     }
  140. }

(2)GeneratorSqlmapUtil.java 该类是入口主函数所在, 里面调用了上面类中生成代码的方法.

  1. package com.xxx.xxx.util.generator;
  2. /**
  3.  * 生成 sql 映射代码主程序
  4.  * @author 北北
  5.  * @date 2018 年 1 月 17 日下午 5:34:03
  6.  */
  7. public class GeneratorSqlmapUtil {
  8.     /**
  9.      * 生成代码入口
  10.      * @author 北北
  11.      * @date 2018 年 1 月 17 日下午 5:35:49
  12.      * @param args
  13.      * @throws Exception
  14.      */
  15.     public static void main(String[] args) throws Exception {
  16.         try {
  17.             GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
  18.             generatorSqlmap.generator();
  19.         } catch(Exception e) {
  20.             e.printStackTrace();
  21.         }
  22.     }
  23. }

至此, 只需要在 generatorConfig.xml 文件中配置好了需要生成的表及生成目录, 就可以 run GeneratorSqlmapUtil.java 类来生成表对应的实体类, example 类, mapper 类, xml 文件了.

来源: http://www.jianshu.com/p/d625d0c777bf


与本文相关文章

  1. java 实现简单解析 XML 文件功能示例
  2. 实现随机生成汉字的Java代码
  3. Java 动态显示文件上传进度实现代码
  4. java 解析XML文件
  5. java 配置 context.xml 文件
  6. Java 嵌入Google AdSense 广告代码
  7. java 实现的 xml 格式化实现代码
  8. Java生成XML文件
暂无,快来抢沙发吧！
更多





黑ICP备17005318号-1