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

代码生成器_代码生成器是什么

作者：Li_阴宅 | 2024-08-09 17:18:19

赞

踩

代码生成器是什么

最近做项目写了一个代码生成器，现在就分享出来给大家，顺便说一下代码生成器是什么东西！

1.什么是代码生成器

代码生成器顾名思义就是一个生成代码的软件。为了节省成本，在日常的企业开发中，代码生成器使用比较普遍。

2.代码生成器的原理

代码生成器的原理就是： 根据模板+ 数据生成不同文件 。比如以下的两段代码。

1.ItripHotelOrderMapper 文件

2.ItripHotelOrderMapper 文件

在上述 ItripHotelOrderMapper 和 ItripHotelOrderMapper 文件中，我们注意到，两个文件的代码很相似。除了高亮部分不一致以外，其它的代码均一致。因此，我们可以设想，我们能不能编写模板生成这样的 Mapper 类。高亮部分使用占位符来进行代替，具体内容根据具体数据进行置换

3. 代码生成器三要素

了解了代码生成器的概念和原理，接下来我开始着手编写属于自己的代码生成器。我将代码生成器的分为三部分：
   ➢ 模板：生成文件的模板文件。
   ➢ 数据：生成文件所需要的关键数据。
   ➢ 合成机制：使用数据置换模板中的占位符，生成新的文件的机制。

 

话不多说，给大家看下代码

表的vo类：

  1. /**
  2.  * 表Vo
  3.  */
  4. public class TableVo {
  5.     private String className;//帕斯卡风格的类名
  6.     private String camelName;//骆驼风格的类名
  7.     private String tableName;//下划线风格的表名
  8.     private List<ColumnVo> columns = new ArrayList<ColumnVo>();//列集合
  9. }

列的vo类：

  1. /**
  2.  * 列Vo类
  3.  */
  4. public class ColumnVo {
  5.     private String dbName;//数据库列名
  6.     private String javaName;//java属性名
  7.  
  8.     private String dbType;//数据库列类型
  9.     private String javaType;//java属性类型
  10.  
  11.     private String comm;//注释
  12.     private String upperCaseColumnName;//转成帕斯卡之后的名称
  13. }
 

转换Java格式名称的工具类：

  1. /**
  2.  * 转换java格式名称的工具类
  3.  */
  4. public class JavaNameUtil {
  5.     /**
  6.      * 下划线风格的命名转换为java骆驼命名法或帕斯卡命名法的名称
  7.      * @param underscoreName
  8.      * @param isPascal true:帕斯卡，false：骆驼
  9.      * @return
  10.      */
  11.     public static String translate(String underscoreName, boolean isPascal) {
  12.         StringBuilder result = new StringBuilder();
  13.         if(underscoreName != null && underscoreName.length() > 0) {
  14.             boolean flag = false;
  15.             //首字母特殊处理，转换成帕斯卡命名法或骆驼命名法的名称
  16.             char firstChar = underscoreName.charAt(0);
  17.             if(isPascal) {
  18.                 result.append(Character.toUpperCase(firstChar));
  19.             } else {
  20.                 result.append(firstChar);
  21.             }
  22.             //第二个之后的所有字符
  23.             for(int i = 1; i < underscoreName.length(); i++) {
  24.                 char ch = underscoreName.charAt(i);
  25.                 //如果这个字符为下划线，下个字符需要大写处理
  26.                 if('_' == ch) {
  27.                     flag = true;
  28.                 } else {
  29.                     if(flag) {
  30.                         result.append(Character.toUpperCase(ch));
  31.                         flag = false;
  32.                     } else {
  33.                         result.append(ch);
  34.                     }
  35.                 }
  36.             }
  37.         }
  38.         return result.toString();
  39.     }
  40.  
  41.     /**
  42.      * 将下划线风格的命名直接转换为骆驼命名法的名称
  43.      * @param str
  44.      * @return
  45.      */
  46.     public static String toCamel(String str) {
  47.         return translate(str, false);
  48.     }
  49.  
  50.     /**
  51.      * 将下划线风格的命名直接转换为帕斯卡命名法的名称
  52.      * @param str
  53.      * @return
  54.      */
  55.     public static String toPascal(String str) {
  56.         return translate(str, true);
  57.     }
  58.  
  59.     /**
  60.      * 将数据库类型转换成java类型
  61.      * @param dbType
  62.      * @return
  63.      */
  64.     public static String dbTypeToJavaType(String dbType) {
  65.         String javaType = null;
  66.         switch (dbType) {
  67.             case "VARCHAR": javaType = "String";break;
  68.             case "BIGINT": javaType = "Long";break;
  69.             case "INT": javaType = "Integer";break;
  70.             case "DATETIME":javaType = "Date";break;
  71.             default: javaType = "String";break;
  72.         }
  73.         return javaType;
  74.     }

负责连接数据库、获取表、列的元信息：

  1. /**
  2.  * 负责连接数据库、获取表、列的元信息
  3.  */
  4. public class MetadataUtil {
  5.     private static Connection conn;//连接
  6.     private static DatabaseMetaData meta;//数据库员信息
  7.     //静态代码加载数据库驱动
  8.     static {
  9.         try {
  10.             Class.forName("com.mysql.jdbc.Driver");
  11.         } catch (ClassNotFoundException e) {
  12.             e.printStackTrace();
  13.             System.out.println("数据库连接失败");
  14.         }
  15.     }
  16.  
  17.     //打开连接，获取数据库元信息
  18.     public static void openConnection() {
  19.         try {
  20.             if(conn == null || conn.isClosed()) {
  21.                 conn = DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306/数据库名?useUnicode=true",
  22.                         "账号",
  23.                         "密码");
  24.                 meta = conn.getMetaData();//获取数据库的元数据对象
  25.             }
  26.         } catch (SQLException e) {
  27.             e.printStackTrace();
  28.         }
  29.     }
  30.  
  31.     //关闭连接
  32.     public static void closeConnection() {
  33.         try {
  34.             if(conn != null || !conn.isClosed()) {
  35.                 conn.isClosed();
  36.             }
  37.         } catch (SQLException e) {
  38.             e.printStackTrace();
  39.         }
  40.     }
  41.  
  42.     //获取所有表名称
  43.     public static String[] getTableNames() {
  44.         openConnection();
  45.         ResultSet rs = null;
  46.         List<String> nameList = new ArrayList<String>();
  47.  
  48.         try {
  49.             rs = meta.getTables(null, null, null, new String[] {"TABLE"});
  50.             while (rs.next()) {
  51.                 String tName = rs.getString("TABLE_NAME");
  52.                 nameList.add(tName);
  53.             }
  54.         } catch (SQLException e) {
  55.             e.printStackTrace();
  56.         } finally {
  57.             closeConnection();
  58.         }
  59.  
  60.         return (String [])nameList.toArray(new String [] {});
  61.     }
  62.  
  63.     //获取某个表的列信息
  64.     public static List<String []> getTableColumnsInfo(String tableName) throws SQLException {
  65.         openConnection();
  66.  
  67.         ResultSet rs = meta.getColumns(null, "%", tableName, "%");
  68.         List<String[]> columnInfoList = new ArrayList<String[]>();
  69.         while (rs.next()) {
  70.             String[] colInfo = new String[3];
  71.             colInfo[0] = rs.getString("COLUMN_NAME");
  72.             colInfo[1] = rs.getString("REMARKS");
  73.             colInfo[2] = rs.getString("TYPE_NAME");
  74.             columnInfoList.add(colInfo);
  75.         }
  76.  
  77.         closeConnection();
  78.  
  79.         return columnInfoList;
  80.     }

代码生成器类：

  1. **
  2.  * 代码生成器
  3.  */
  4. public class CodeGenerator {
  5.     protected Configuration cfg;//Freemarker配置对象
  6.     protected Map valueMap;//要填充到模板的数据
  7.     protected Template template;//ftl模板对象
  8.     protected String savePath;//保存代码的路径
  9.     protected List<TableVo> tableList;//表信息对象集合
  10.     protected String fileNameSuffix;//生成的文件名后缀
  11.  
  12.     public CodeGenerator(String ftl) throws Exception {
  13.         cfg = new Configuration();//Freemarker配置对象
  14.         cfg.setClassForTemplateLoading(this.getClass(), "/templates");//设置加载ftl模板的路径
  15.         template = cfg.getTemplate(ftl);//加载模板文件
  16.  
  17.         valueMap = new HashMap();
  18.         parseMetadata();
  19.     }
  20.  
  21.     //获取所有的表信息、列信息，并且转换为对象
  22.     public void parseMetadata() throws Exception {
  23.         tableList = new ArrayList<TableVo>();
  24.  
  25.         //获取所有表名
  26.         String [] tableNameArr = MetadataUtil.getTableNames();
  27.         for (String tName : tableNameArr) {
  28.             TableVo table= new TableVo();//表对象
  29.             //下划线转帕斯卡命名
  30.             table.setClassName(JavaNameUtil.toPascal(tName));
  31.             table.setTableName(tName);
  32.             table.setCamelName(JavaNameUtil.toCamel(tName));
  33.             //调用工具类，获取列信息
  34.             List<String []> colInfoList = MetadataUtil.getTableColumnsInfo(tName);
  35.             for(String[] colInfo : colInfoList) {
  36.                 String colName = colInfo[0];//列名
  37.                 String comment = colInfo[1];//列注释
  38.                 String colType = colInfo[2];//列类型
  39.                 ColumnVo column = new ColumnVo();
  40.                 column.setDbName(colName);
  41.                 column.setDbType(colType);
  42.                 column.setComm(comment);
  43.                 column.setJavaName(JavaNameUtil.toCamel(colName));
  44.                 column.setJavaType(JavaNameUtil.dbTypeToJavaType(colType));
  45.                 //列名转帕斯卡命名法，用户生成get和set方法命名
  46.                 column.setUpperCaseColumnName(JavaNameUtil.toPascal(colName));
  47.                 //将列信息加入表对象的列信息列表中
  48.                 table.getColumns().add(column);
  49.             }
  50.             //加入表集合
  51.             tableList.add(table);
  52.         }
  53.         MetadataUtil.closeConnection();//关闭数据库连接
  54.         System.out.println("构建元数据成功！\n\n");
  55.     }
  56.  
  57.     //抽象生成代码的方法，各子类实现
  58.     public void generateCode() throws Exception {
  59.         System.out.println("--------------开始生成" + template.getName() + "代码生成器开始生成代码");
  60.         OutputStreamWriter writer = null;
  61.         for(TableVo table : tableList) {
  62.             valueMap.put("table", table);
  63.             try {
  64.                 //生成的每个代码文件，拼接文件名，创建文件写入器
  65.                 writer = new FileWriter(savePath + "/" + table.getClassName() + fileNameSuffix);
  66.                 //Freemarker合成数据和模板，输出到代码文件
  67.                 this.template.process(valueMap, writer);
  68.                 //清空写入器缓冲
  69.                 writer.flush();
  70.             } catch (TemplateException e) {
  71.                 e.printStackTrace();
  72.             } catch (IOException e) {
  73.                 e.printStackTrace();
  74.             } finally {
  75.                 try {
  76.                     writer.close();
  77.                 } catch (IOException e) {
  78.                     e.printStackTrace();
  79.                 }
  80.             }
  81.         }
  82.         System.out.println("根据" + template.getName() + "模板生成代码成功");
  83.     }

代码生成器入口类main方法：

  1. public class App {
  2.     public static void main(String [] args) throws Exception {
  3.         String myProjectPkg = "cn.itrip";
  4.         //实体类生成器
  5.         CodeGenerator pojoGenerator = new CodeGenerator("pojo.ftl");//设置所用的模板
  6.         pojoGenerator.setSavePath("url");//设置生成代码保存的位置
  7.         pojoGenerator.setFileNameSuffix(".java");//设置文件后缀名
  8.         pojoGenerator.setPackage(myProjectPkg);//项目包名
  9.         //mapper接口生成器
  10.         CodeGenerator mapperGenerator = new CodeGenerator("mapper.ftl");//设置所用的模板
  11.         mapperGenerator.setSavePath("url");//设置生成代码保存的位置
  12.         mapperGenerator.setFileNameSuffix("Mapper.java");//设置文件后缀名
  13.         mapperGenerator.setPackage(myProjectPkg);//项目包名
  14.         //mapper映射文件生成器
  15.         CodeGenerator sqlGenerator = new CodeGenerator("sql.ftl");//设置所用的模板
  16.         sqlGenerator.setSavePath("url");//设置生成代码保存的位置
  17.         sqlGenerator.setFileNameSuffix("Mapper.xml");//设置文件后缀名
  18.         sqlGenerator.setPackage(myProjectPkg);//项目包名
  19.         try {
  20.             //调用代码生成器
  21.             pojoGenerator.generateCode();
  22.             mapperGenerator.generateCode();
  23.             sqlGenerator.generateCode();
  24.         } catch (Exception e) {
  25.             e.printStackTrace();
  26.         }
  27.     }

最后在写3个模板文件（pojo、mapper、sql.ftl）然后运行一下App类就可以自动生成代码了

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Li_阴宅/article/detail/954352
推荐阅读
相关标签

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

  

闽ICP备14008679号