本站建设：代码生成功能集成

文章来源：原创   作者：临窗旋墨   发布时间：2021-06-22   阅读：3874   标签：springboot 分类：我的编码 专题：本站建设
[TOC]

003-代码生成功能集成

2019-11-14

1- 代码生成思路

​ 网上关于代码自动生成的开源项目很多,基本可以拿来之后修改模板文件直接使用.本项目的代码自动生成主要是17年左右借鉴人人开源上面的代码而来.

​ 基本思路都是一样的:

  1. 连接数据库获取数据库表的全部信息(本项目只实现mysql版本)
    • 如需支持多种数据库,则定义dao接口,不同的数据库做不同的实现,根据配置文件指定Primary
  2. 解析表的基本信息,列的基本信息映射成对象
  3. 编写各层模板,根据解析的数据对模板进行填充
  4. 导出填充后的模板

2-本项目中代码生成功能的大概实现

2.1 配置文件与映射

generator-config.properties

  1.  #代码生成器，配置信息
  2. #包名
  3. packageName=pers.vic
  4. #模块名
  5. moduleName=system
  6. #作者
  7. author=Vic.xu
  8. #Email
  9. email=xuduochoua@163.com
  10. #表前缀(类名不会包含表前缀)
  11. tablePrefix=
  12. #需要填充的模板
  13. templates[0]=generator/templates/Entity.java.vm
  14. #略
  15. #数据类型转换，配置信息:数据库类型->java类型
  16. tinyint=Integer
  17. #略

2.2 解析表后的实体

  1. TableEntity 对应一张表的基本数据:表名/备注/主键/对应的类名/创建时间/关联的ColumnEntity列表等
  2. ColumnEntity对应列的属性:列名/列属性/备注/属性名/属性类型/是否主键/对应的ColumnExtend等
  3. ColumnExtend列的扩展:本项目额外增加的根据备注对列做的额外的处理说明

2.3service层大体代码

  1. @Service
  2. public class GeneratorService{
  3.     @Resource
  4.     private ConfigurationOfGenerator configurationOfGenerator;
  5.     @Resource
  6.     private GeneratorMapper generatorMapper;
  8.     public List<TableEntity> list(Lookup lookup) {
  9.         List<TableEntity> datas = generatorMapper.queryList(lookup);
  10.         return datas;
  11.     }
  13.     private List<ColumnEntity> queryColumns(String tableName) {
  14.         return generatorMapper.queryColumns(tableName);
  15.     }
  17.     private TableEntity queryTable(String tableName) {
  18.         return generatorMapper.queryTable(tableName);
  19.     }
  21.     /**
  22.      * 根据表名生成代码
  23.      * 
  24.      * @param moduleName
  25.      * @param packageName
  26.      */
  27.     public byte[] generatorCode(String[] tableNames, String packageName, String moduleName) {
  28.         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  29.         ZipOutputStream zip = new ZipOutputStream(outputStream);
  31.         for (String tableName : tableNames) {
  32.             // 查询表信息
  33.             TableEntity table = queryTable(tableName);
  34.             // 查询列信息
  35.             List<ColumnEntity> columns = queryColumns(tableName);
  36.             // 生成代码
  37.             generatorCode(table, packageName, moduleName, columns, zip);
  38.         }
  39.         IOUtils.closeQuietly(zip);
  40.         return outputStream.toByteArray();
  41.     }
  43.     private void generatorCode(TableEntity table, String packageName, String moduleName, List<ColumnEntity> columns,
  44.             ZipOutputStream zip) {
  46.         Map<String, Object> map = getTemplateData(table, packageName, moduleName, columns);
  47.         VelocityContext context = new VelocityContext(map);
  49.         // 获取模板列表
  50.         List<String> templates = getTemplates();
  51.         for (String template : templates) {
  52.             // 渲染模板
  53.             StringWriter sw = new StringWriter();
  54.             Template tpl = Velocity.getTemplate(template, "UTF-8");
  55.             tpl.merge(context, sw);
  56.             try {
  57.                 // 添加到zip
  58.                 String fileName = getFileName(template, table.getClassName(), configurationOfGenerator.getPackageName(),
  59.                         configurationOfGenerator.getModuleName());
  60.                 zip.putNextEntry(new ZipEntry(fileName));
  61.                 IOUtils.write(sw.toString(), zip, "UTF-8");
  62.                 IOUtils.closeQuietly(sw);
  63.                 zip.closeEntry();
  64.             } catch (Exception e) {
  65.                 throw new RuntimeException("渲染模板失败，表名：" + table.getTableName(), e);
  66.             }
  68.         }
  69.     }
  71.     //获得渲染模板的数据
  72.     private Map<String, Object> getTemplateData(TableEntity table, String packageName,  String moduleName, List<ColumnEntity> columns) {
  73.         // 配置信息
  74.         Configuration config = getConfig();
  75.         boolean hasBigDecimal = false;
  76.         String className = tableToJava(table.getTableName(), configurationOfGenerator.getTablePrefix());
  78.         table.setClassName(className);
  79.         // 第一个字母小写
  80.         table.setClassname(StringUtils.uncapitalize(className));
  82.         // 列信息
  83.         for (ColumnEntity column : columns) {
  84.             // 列名转换成Java属性名
  85.             String attrName = columnToJava(column.getColumnName());
  86.             column.setAttrName(attrName);
  87.             column.setAttrname(StringUtils.uncapitalize(attrName));
  89.             // 列的数据类型，转换成Java类型
  90.             String attrType = config.getString(column.getDataType(), "unknowType");
  91.             column.setAttrType(attrType);
  92.             if (!hasBigDecimal && attrType.equals("BigDecimal")) {
  93.                 hasBigDecimal = true;
  94.             }
  95.             if ("Date".equals(attrType)) {
  96.                 table.setHasDate(true);
  97.             }
  99.             // 是否主键
  100.             if ("PRI".equalsIgnoreCase(column.getColumnKey()) && table.getPk() == null) {
  101.                 table.setPk(column);
  102.             }
  103.             // 根据列是否是图片和日期 判断表中是否含有图片和日期
  104.             ColumnExtend extend = ColumnExtend.initExtends(column);
  105.             table.findExtend(extend);
  107.         }
  108.         // 没主键，则第一个字段为主键
  109.         table.setColumns(columns);
  110.         if (table.getPk() == null) {
  111.             table.setPk(columns.get(0));
  112.         }
  114.         // 设置velocity资源加载器
  115.         Properties prop = new Properties();
  116.         prop.put("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
  117.         Velocity.init(prop);
  119.         // 封装模板数据
  120.         Map<String, Object> map = new HashMap<String, Object>();
  121.         map.put("table", table);
  122.         map.put("tableName", table.getTableName());
  123.         map.put("comments", table.getComments());
  124.         map.put("pk", table.getPk());
  125.         map.put("className", table.getClassName());
  126.         map.put("classname", table.getClassname());
  127.         map.put("pathName", table.getClassname().toLowerCase());
  128.         map.put("columns", table.getColumns());
  129.         map.put("hasBigDecimal", hasBigDecimal);
  130.         if (StringUtils.isEmpty(packageName)) {
  131.             map.put("package", config.getString("packageName"));
  132.         } else {
  133.             map.put("package", packageName);
  134.         }
  135.         if (StringUtils.isEmpty(packageName)) {
  136.             map.put("moduleName", config.getString("moduleName"));
  137.         } else {
  138.             map.put("moduleName", moduleName);
  139.         }
  140.         map.put("author", config.getString("author"));
  141.         map.put("email", config.getString("email"));
  142.         map.put("datetime", DateFormatUtils.format(new Date(), "yyyy-mm-dd HH:mm"));
  143.         return map;
  144.     }
  146.     /**
  147.      * 获取文件名
  148.      */
  149.     public static String getFileName(String template, String className, String packageName, String moduleName) {
  150.         String packagePath = "generator" + File.separator + className;
  151.         /*
  152.          * packagePath = "main" + File.separator + "java" + File.separator; if
  153.          * (StringUtils.isNotBlank(packageName)) { packagePath +=
  154.          * packageName.replace(".", File.separator) + File.separator + moduleName +
  155.          * File.separator; }
  156.          */
  158.         // 实体
  159.         if (template.contains("Entity.java.vm")) {
  160.             return packagePath + File.separator + className + ".java";
  161.         }
  162.         // 查询条件
  163.         if (template.contains("Lookup.java.vm")) {
  164.             return packagePath + File.separator + className + "Lookup.java";
  165.         }
  167.         // mapper.java
  168.         if (template.contains("Mapper.java.vm")) {
  169.             return packagePath + File.separator + className + "Mapper.java";
  170.         }
  172.         // service
  173.         if (template.contains("Service.java.vm")) {
  174.             return packagePath + File.separator + className + "Service.java";
  175.         }
  177.         // controller
  178.         if (template.contains("Controller.java.vm")) {
  179.             return packagePath + File.separator + className + "Controller.java";
  180.         }
  181.         // mapper.xnl
  182.         if (template.contains("Mapper.xml.vm")) {
  183.             return packagePath + File.separator + className + "Mapper.xml";
  184.         }
  186.         // list.jsp
  187.         if (template.contains("list.jsp.vm")) {
  188.             return packagePath + File.separator + "list.jsp";
  189.         }
  190.         // form.jsp
  191.         if (template.contains("form.jsp.vm")) {
  192.             return packagePath + File.separator + "form.jsp";
  193.         }
  195.         return null;
  196.     }
  199.     /**
  200.      * 获取要填充的模板
  201.      * @return
  202.      */
  203.     public List<String> getTemplates() {
  204.         return configurationOfGenerator.getTemplates();
  205.     }
  208.     /**
  209.      * 表名转换成Java类名
  210.      */
  211.     private String tableToJava(String tableName, String tablePrefix) {
  212.         if (StringUtils.isNotBlank(tablePrefix)) {
  213.             tableName = tableName.replaceFirst(tablePrefix, "");
  214.         }
  215.         return columnToJava(tableName);
  216.     }
  218.     /**
  219.      * 列名转换成Java属性名
  220.      */
  221.     public static String columnToJava(String columnName) {
  222. //        return WordUtils.capitalizeFully(columnName, new char[] { '_' }).replace("_", "");//aaBBcc-->aabbcc  不是我想要的
  223.         return underlineToCamel(columnName);
  224.     }
  226.     /**
  227.      * 下划线转驼峰 但是不小写
  228.      * 
  229.      * @param str
  230.      * @return
  231.      */
  232.     static String UNDERLINE = "_";
  234.     public static String underlineToCamel(String str) {
  235.         if (StringUtils.isEmpty(str)) {
  236.             return str;
  237.         }
  238.         StringBuffer sb = new StringBuffer();
  239.         for (String s : str.split(UNDERLINE)) {
  240.             sb.append(StringUtils.capitalize(s));
  241.         }
  242.         return sb.toString();
  243.     }
  245.     /**
  246.      * 获取配置信息
  247.      */
  248.     public static Configuration getConfig() {
  249.         try {
  250.             return new PropertiesConfiguration("config/generator-config.properties");
  251.         } catch (ConfigurationException e) {
  252.             throw new RuntimeException("获取配置文件失败，", e);
  253.         }
  254.     }
  256.     public Map<String, String> findTableDetail(String tableName, String packageName, String moduleName) {
  257.         // 查询表信息
  258.         TableEntity table = queryTable(tableName);
  259.         // 查询列信息
  260.         List<ColumnEntity> columns = queryColumns(tableName);
  262.         Map<String, Object> map = getTemplateData(table, packageName, moduleName, columns);
  263.         VelocityContext context = new VelocityContext(map);
  265.         // 获取模板列表
  266.         List<String> templates = getTemplates();
  267.         Map<String, String> data = new LinkedHashMap<String, String>();
  268.         for (String template : templates) {
  269.             // 渲染模板
  270.             StringWriter sw = new StringWriter();
  271.             Template tpl = Velocity.getTemplate(template, "UTF-8");
  272.             tpl.merge(context, sw);
  273.             try {
  274.                 // 添加到zip
  275.                 String fileName = getFileName(template, table.getClassName(), configurationOfGenerator.getPackageName(),
  276.                         configurationOfGenerator.getModuleName());
  277.                 data.put(fileName.replace("generator" + File.separator, "").replace(File.separator, "_"), sw.toString());
  278.             } catch (Exception e) {
  279.                 throw new RuntimeException("渲染模板失败，表名：" + table.getTableName(), e);
  280.             }
  282.         }
  283.         return data;
  284.     }
  286. }

发表评论

目录