rev: 代码生成器转为mybatis-plus的生成

lms/nladmin-system/src/main/java/org/nl/common/utils/ColUtil.java

@@ -0,0 +1,35 @@
+package org.nl.common.utils;
+
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
+import org.apache.commons.configuration.PropertiesConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ColUtil {
+    private static final Logger log = LoggerFactory.getLogger(ColUtil.class);
+
+    /**
+     * 转换mysql数据类型为java数据类型
+     *
+     * @param type 数据库字段类型
+     * @return String
+     */
+    static String cloToJava(String type) {
+        Configuration config = getConfig();
+        assert config != null;
+        return config.getString(type, "unknowType");
+    }
+
+    /**
+     * 获取配置信息
+     */
+    public static PropertiesConfiguration getConfig() {
+        try {
+            return new PropertiesConfiguration("generator.properties");
+        } catch (ConfigurationException e) {
+            log.error(e.getMessage(), e);
+        }
+        return null;
+    }
+}

lms/nladmin-system/src/main/java/org/nl/common/utils/GenUtil.java

@@ -0,0 +1,439 @@
+package org.nl.common.utils;
+
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.template.*;
+import lombok.extern.slf4j.Slf4j;
+import org.nl.modules.common.utils.FileUtil;
+import org.nl.modules.common.utils.StringUtils;
+import org.nl.system.service.generator.dao.CodeColumnConfig;
+import org.nl.system.service.generator.dao.CodeGenConfig;
+import org.springframework.util.ObjectUtils;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.Writer;
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.nl.modules.common.utils.FileUtil.SYS_TEM_DIR;
+
+
+/**
+ * @author: lyd
+ * @description: 代码生成
+ * @Date: 2022/12/2
+ */
+@Slf4j
+@SuppressWarnings({"unchecked", "all"})
+public class GenUtil {
+    private static final String TIMESTAMP = "Timestamp";
+
+    private static final String Date = "Date";
+
+    private static final String BIGDECIMAL = "BigDecimal";
+
+    public static final String PK = "PRI";
+
+    public static final String EXTRA = "auto_increment";
+
+    /**
+     * 获取后端代码模板名称
+     *
+     * @return List
+     */
+    private static List<String> getAdminTemplateNames() {
+        List<String> templateNames = new ArrayList<>();
+        templateNames.add("Entity");
+        templateNames.add("MySQLMapper");
+        templateNames.add("Dto");
+        templateNames.add("Mapper");
+        templateNames.add("Controller");
+        templateNames.add("QueryCriteria");
+        templateNames.add("Service");
+        templateNames.add("ServiceImpl");
+        // templateNames.add("Repository");
+        return templateNames;
+    }
+
+    /**
+     * 获取前端代码模板名称
+     *
+     * @return List
+     */
+    private static List<String> getFrontTemplateNames() {
+        List<String> templateNames = new ArrayList<>();
+        templateNames.add("index");
+        templateNames.add("api");
+        return templateNames;
+    }
+
+    public static List<Map<String, Object>> preview(List<CodeColumnConfig> columns, CodeGenConfig genConfig) {
+        Map<String, Object> genMap = getGenMap(columns, genConfig); // 获取参数
+        List<Map<String, Object>> genList = new ArrayList<>();
+        // 获取后端模版
+        List<String> templates = getAdminTemplateNames();
+        TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("template", TemplateConfig.ResourceMode.CLASSPATH));
+        for (String templateName : templates) { // 创建模板
+            Map<String, Object> map = new HashMap<>(1);
+            Template template = engine.getTemplate("generator/admin/" + templateName + ".ftl");
+            map.put("content", template.render(genMap));
+            map.put("name", templateName);
+            genList.add(map);
+        }
+        // 获取前端模版
+        templates = getFrontTemplateNames();
+        for (String templateName : templates) {
+            Map<String, Object> map = new HashMap<>(1);
+            Template template = engine.getTemplate("generator/front/" + templateName + ".ftl");
+            map.put(templateName, template.render(genMap));
+            map.put("content", template.render(genMap));
+            map.put("name", templateName);
+            genList.add(map);
+        }
+        return genList;
+    }
+
+    /**
+     * 定义后端文件路径以及名称
+     */
+    private static String getAdminFilePath(String templateName, CodeGenConfig genConfig, String className, String rootPath) {
+        String projectPath = rootPath + File.separator;
+        String packagePath = projectPath + "src" + File.separator + "main" + File.separator + "java" + File.separator;
+        if (!ObjectUtils.isEmpty(genConfig.getPack())) {
+            packagePath += genConfig.getPack().replace(".", File.separator) + File.separator;
+        }
+
+        if ("Entity".equals(templateName)) {
+            return packagePath + "service" + File.separator + "dao" + File.separator + className + ".java";
+        }
+
+        if ("Controller".equals(templateName)) {
+            return packagePath + "controller" + File.separator + className + "Controller.java";
+        }
+
+        if ("Service".equals(templateName)) {
+            return packagePath + "service" + File.separator + "I" + className + "Service.java";
+        }
+
+        if ("ServiceImpl".equals(templateName)) {
+            return packagePath + "service" + File.separator + "impl" + File.separator + className + "ServiceImpl.java";
+        }
+
+        if ("Dto".equals(templateName)) {
+            return packagePath + "service" + File.separator + "dto" + File.separator + className + "Dto.java";
+        }
+
+        if ("QueryCriteria".equals(templateName)) {
+            return packagePath + "service" + File.separator + "dto" + File.separator + className + "Query.java";
+        }
+
+        if ("Mapper".equals(templateName)) {
+            return packagePath + "service" + File.separator + "dao" + File.separator + "mapper" + File.separator + className + "Mapper.java";
+        }
+
+        if ("MySQLMapper".equals(templateName)) {
+            return packagePath + "service" + File.separator + "dao" + File.separator + "mapper" + File.separator + className + "Mapper.xml";
+        }
+
+        return null;
+    }
+
+    /**
+     * 定义前端文件路径以及名称
+     */
+    private static String getFrontFilePath(String templateName, String apiPath, String path, String apiName) {
+
+        if ("api".equals(templateName)) {
+            return path + File.separator + apiName + ".js";
+        }
+
+        if ("index".equals(templateName)) {
+            return path + File.separator + "index.vue";
+        }
+
+        return null;
+    }
+
+    // 获取模版数据
+    private static Map<String, Object> getGenMap(List<CodeColumnConfig> columnInfos, CodeGenConfig genConfig) {
+        // 存储模版字段数据
+        Map<String, Object> genMap = new HashMap<>(16);
+        // 接口别名
+        genMap.put("apiAlias", genConfig.getApiAlias());
+        // 包名称
+        genMap.put("package", genConfig.getPack());
+        // 模块名称
+        genMap.put("moduleName", genConfig.getModuleName());
+        // 作者
+        genMap.put("author", genConfig.getAuthor());
+        // 创建日期
+        genMap.put("date", LocalDate.now().toString());
+        // 表名
+        genMap.put("tableName", genConfig.getTableName());
+        // 大写开头的类名
+        String className = StringUtils.toCapitalizeCamelCase(genConfig.getTableName());
+        // 小写开头的类名
+        String changeClassName = StringUtils.toCamelCase(genConfig.getTableName());
+        // 判断是否去除表前缀
+        if (StrUtil.isNotEmpty(genConfig.getPrefix())) {
+            className = StringUtils.toCapitalizeCamelCase(StrUtil.removePrefix(genConfig.getTableName(), genConfig.getPrefix()));
+            changeClassName = StringUtils.toCamelCase(StrUtil.removePrefix(genConfig.getTableName(), genConfig.getPrefix()));
+        }
+        // 保存类名
+        genMap.put("className", className); // 驼峰命名
+        // 保存小写开头的类名
+        genMap.put("changeClassName", changeClassName);
+        // 存在 Timestamp 字段
+        genMap.put("hasTimestamp", false);
+        // 查询类中存在 Timestamp 字段
+        genMap.put("queryHasTimestamp", false);
+        // 存在 BigDecimal 字段
+        genMap.put("hasBigDecimal", false);
+        // 查询类中存在 BigDecimal 字段
+        genMap.put("queryHasBigDecimal", false);
+        // 是否需要创建查询
+        genMap.put("hasQuery", false);
+        // 是否有主键
+        genMap.put("hasPk", false);
+        // 自增主键
+        genMap.put("auto", false);
+        genMap.put("hasDate", false);
+        // 存在字典
+        genMap.put("hasDict", false);
+        // 存在日期注解
+        genMap.put("hasDateAnnotation", false);
+        // 保存字段信息
+        List<Map<String, Object>> columns = new ArrayList<>();
+        // 保存查询字段的信息
+        List<Map<String, Object>> queryColumns = new ArrayList<>();
+        // 存储字典信息
+        List<String> dicts = new ArrayList<>();
+        // 存储 between 信息
+        List<Map<String, Object>> betweens = new ArrayList<>();
+        // 存储不为空的字段信息
+        List<Map<String, Object>> isNotNullColumns = new ArrayList<>();
+
+        for (CodeColumnConfig column : columnInfos) { // 遍历所有字段
+            Map<String, Object> listMap = new HashMap<>(16);
+            // 字段描述
+            listMap.put("remark", column.getRemark());
+            // 字段类型
+            listMap.put("columnKey", column.getKeyType());
+            // 主键类型
+            String colType = ColUtil.cloToJava(column.getColumnType());
+            // 小写开头的字段名 - 转驼峰
+//            String changeColumnName = StringUtils.toCamelCase(column.getColumnName());
+            String changeColumnName = column.getColumnName();
+            // 大写开头的字段名
+            String capitalColumnName = StringUtils.toCapitalizeCamelCase(column.getColumnName());
+            if (PK.equals(column.getKeyType())) { // 如果是主键
+                genMap.put("hasPk", true);
+                // 存储主键类型
+                genMap.put("pkColumnType", colType);
+                // 存储小写开头的字段名
+                genMap.put("pkChangeColName", changeColumnName);
+                // 存储大写开头的字段名
+                genMap.put("pkCapitalColName", capitalColumnName);
+            }
+            // 是否存在 Timestamp 类型的字段
+            if (TIMESTAMP.equals(colType)) {
+                genMap.put("hasTimestamp", true);
+            }
+            // 是否存在 BigDecimal 类型的字段
+            if (BIGDECIMAL.equals(colType)) {
+                genMap.put("hasBigDecimal", true);
+            }
+            // 主键是否自增
+            if (EXTRA.equals(column.getExtra())) {
+                genMap.put("auto", true);
+            }
+            // 主键存在字典
+            if (StrUtil.isNotEmpty(column.getDictName())) {
+                genMap.put("hasDict", true);
+                dicts.add(column.getDictName());
+            }
+
+            // 存储字段类型
+            listMap.put("columnType", colType);
+            // 存储字原始段名称
+            listMap.put("columnName", column.getColumnName());
+            // 不为空
+            listMap.put("istNotNull", column.getNotNull());
+            // 字段列表显示
+            listMap.put("columnShow", column.getListShow());
+            // 表单显示
+            listMap.put("formShow", column.getFormShow());
+            // 表单组件类型
+            listMap.put("formType", StrUtil.isNotEmpty(column.getFormType()) ? column.getFormType() : "Input");
+            // 小写开头的字段名称
+            listMap.put("changeColumnName", changeColumnName);
+            //大写开头的字段名称
+            listMap.put("capitalColumnName", capitalColumnName);
+            // 字典名称
+            listMap.put("dictName", column.getDictName());
+            // 日期注解
+            listMap.put("dateAnnotation", column.getDateAnnotation());
+            if (StrUtil.isNotEmpty(column.getDateAnnotation())) {
+                genMap.put("hasDateAnnotation", true);
+            }
+            // 添加非空字段信息
+            if (column.getNotNull()) {
+                isNotNullColumns.add(listMap);
+            }
+            // 判断是否有查询，如有则把查询的字段set进columnQuery
+            if (!StrUtil.isEmpty(column.getQueryType())) {
+                // 查询类型
+                listMap.put("queryType", column.getQueryType());
+                // 是否存在查询
+                genMap.put("hasQuery", true);
+                if (TIMESTAMP.equals(colType)) {
+                    // 查询中存储 Timestamp 类型
+                    genMap.put("queryHasTimestamp", true);
+                }
+                if (BIGDECIMAL.equals(colType)) {
+                    // 查询中存储 BigDecimal 类型
+                    genMap.put("queryHasBigDecimal", true);
+                }
+                if ("between".equalsIgnoreCase(column.getQueryType())) {
+                    betweens.add(listMap);
+                } else {
+                    // 添加到查询列表中
+                    queryColumns.add(listMap);
+                }
+            }
+            // 添加到字段列表中
+            columns.add(listMap);
+        }
+        // 保存字段列表
+        genMap.put("columns", columns);
+        // 保存查询列表
+        genMap.put("queryColumns", queryColumns);
+        // 保存字段列表
+        genMap.put("dicts", dicts);
+        // 保存查询列表
+        genMap.put("betweens", betweens);
+        // 保存非空字段信息
+        genMap.put("isNotNullColumns", isNotNullColumns);
+        return genMap;
+    }
+
+    /**
+     * 打包下载
+     *
+     * @param columns
+     * @param genConfig
+     * @return
+     * @throws IOException
+     */
+    public static String download(List<CodeColumnConfig> columns, CodeGenConfig genConfig) throws IOException {
+        // 拼接的路径：/tmpnladmin-gen-temp/，这个路径在Linux下需要root用户才有权限创建,非root用户会权限错误而失败，更改为： /tmp/nladmin-gen-temp/
+        // String tempPath =SYS_TEM_DIR + "nladmin-gen-temp" + File.separator + genConfig.getTableName() + File.separator;
+        String tempPath = SYS_TEM_DIR + "nladmin-gen-temp" + File.separator + genConfig.getTableName() + File.separator;
+        Map<String, Object> genMap = getGenMap(columns, genConfig);
+        TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("template", TemplateConfig.ResourceMode.CLASSPATH));
+        // 生成后端代码
+        List<String> templates = getAdminTemplateNames();
+        for (String templateName : templates) {
+            Template template = engine.getTemplate("generator/admin/" + templateName + ".ftl");
+            String filePath = getAdminFilePath(templateName, genConfig, genMap.get("className").toString(), tempPath + "eladmin" + File.separator);
+            assert filePath != null;
+            File file = new File(filePath);
+            // 如果非覆盖生成
+            if (!genConfig.getCover() && FileUtil.exist(file)) {
+                continue;
+            }
+            // 生成代码
+            genFile(file, template, genMap);
+        }
+        // 生成前端代码
+        templates = getFrontTemplateNames();
+        for (String templateName : templates) {
+            Template template = engine.getTemplate("generator/front/" + templateName + ".ftl");
+            String path = tempPath + "nladmin-web" + File.separator;
+            String apiPath = path + "src" + File.separator + "api" + File.separator;
+            String srcPath = path + "src" + File.separator + "views" + File.separator + genMap.get("changeClassName").toString() + File.separator;
+            String filePath = getFrontFilePath(templateName, apiPath, srcPath, genMap.get("changeClassName").toString());
+            assert filePath != null;
+            File file = new File(filePath);
+            // 如果非覆盖生成
+            if (!genConfig.getCover() && FileUtil.exist(file)) {
+                continue;
+            }
+            // 生成代码
+            genFile(file, template, genMap);
+        }
+        return tempPath;
+    }
+
+    /**
+     * 生成文件
+     *
+     * @param file
+     * @param template
+     * @param map
+     * @throws IOException
+     */
+    private static void genFile(File file, Template template, Map<String, Object> map) throws IOException {
+        // 生成目标文件
+        Writer writer = null;
+        try {
+            FileUtil.touch(file);
+            writer = new FileWriter(file);
+            template.render(map, writer);
+        } catch (TemplateException | IOException e) {
+            throw new RuntimeException(e);
+        } finally {
+            assert writer != null;
+            writer.close();
+        }
+    }
+
+    /**
+     * 生成代码
+     *
+     * @param columnInfos
+     * @param genConfig
+     * @throws IOException
+     */
+    public static void generatorCode(List<CodeColumnConfig> columnInfos, CodeGenConfig genConfig) throws IOException {
+        Map<String, Object> genMap = getGenMap(columnInfos, genConfig);
+        TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("template", TemplateConfig.ResourceMode.CLASSPATH));
+        // 生成后端代码
+        List<String> templates = getAdminTemplateNames();
+        for (String templateName : templates) {
+            Template template = engine.getTemplate("generator/admin/" + templateName + ".ftl");
+            String filePath = getAdminFilePath(templateName, genConfig, genMap.get("className").toString(), System.getProperty("user.dir"));
+
+            assert filePath != null;
+            File file = new File(filePath);
+
+            // 如果非覆盖生成
+            if (!genConfig.getCover() && FileUtil.exist(file)) {
+                continue;
+            }
+            // 生成代码
+            genFile(file, template, genMap);
+        }
+
+        // 生成前端代码
+        templates = getFrontTemplateNames();
+        for (String templateName : templates) {
+            Template template = engine.getTemplate("generator/front/" + templateName + ".ftl");
+            String filePath = getFrontFilePath(templateName, genConfig.getApiPath(), genConfig.getPath(), genMap.get("changeClassName").toString());
+
+            assert filePath != null;
+            File file = new File(filePath);
+
+            // 如果非覆盖生成
+            if (!genConfig.getCover() && FileUtil.exist(file)) {
+                continue;
+            }
+            // 生成代码
+            genFile(file, template, genMap);
+        }
+    }
+}