From a6fb88d74c20cc28043d75e8a5097fce49cf9a78 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 15 十月 2021 15:19:42 +0800
Subject: [PATCH] update [重大更新]全业务 增加 接口文档注解 格式化代码

---
 ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java |  188 ++++++++++++++++------------------------------
 1 files changed, 67 insertions(+), 121 deletions(-)

diff --git a/ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java b/ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java
index 3876227..0a3ffbc 100644
--- a/ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java
+++ b/ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java
@@ -16,18 +16,24 @@
 
 /**
  * 妯℃澘澶勭悊宸ュ叿绫�
- * 
+ *
  * @author ruoyi
  */
-public class VelocityUtils
-{
-    /** 椤圭洰绌洪棿璺緞 */
+public class VelocityUtils {
+
+    /**
+     * 椤圭洰绌洪棿璺緞
+     */
     private static final String PROJECT_PATH = "main/java";
 
-    /** mybatis绌洪棿璺緞 */
+    /**
+     * mybatis绌洪棿璺緞
+     */
     private static final String MYBATIS_PATH = "main/resources/mapper";
 
-    /** 榛樿涓婄骇鑿滃崟锛岀郴缁熷伐鍏� */
+    /**
+     * 榛樿涓婄骇鑿滃崟锛岀郴缁熷伐鍏�
+     */
     private static final String DEFAULT_PARENT_MENU_ID = "3";
 
     /**
@@ -35,8 +41,7 @@
      *
      * @return 妯℃澘鍒楄〃
      */
-    public static VelocityContext prepareContext(GenTable genTable)
-    {
+    public static VelocityContext prepareContext(GenTable genTable) {
         String moduleName = genTable.getModuleName();
         String businessName = genTable.getBusinessName();
         String packageName = genTable.getPackageName();
@@ -63,29 +68,25 @@
         velocityContext.put("table", genTable);
         velocityContext.put("dicts", getDicts(genTable));
         setMenuVelocityContext(velocityContext, genTable);
-        if (GenConstants.TPL_TREE.equals(tplCategory))
-        {
+        if (GenConstants.TPL_TREE.equals(tplCategory)) {
             setTreeVelocityContext(velocityContext, genTable);
         }
-        if (GenConstants.TPL_SUB.equals(tplCategory))
-        {
+        if (GenConstants.TPL_SUB.equals(tplCategory)) {
             setSubVelocityContext(velocityContext, genTable);
         }
         return velocityContext;
     }
 
-    public static void setMenuVelocityContext(VelocityContext context, GenTable genTable)
-    {
+    public static void setMenuVelocityContext(VelocityContext context, GenTable genTable) {
         String options = genTable.getOptions();
-		Map<String, Object> paramsObj = JsonUtils.parseMap(options);
+        Map<String, Object> paramsObj = JsonUtils.parseMap(options);
         String parentMenuId = getParentMenuId(paramsObj);
         context.put("parentMenuId", parentMenuId);
     }
 
-    public static void setTreeVelocityContext(VelocityContext context, GenTable genTable)
-    {
+    public static void setTreeVelocityContext(VelocityContext context, GenTable genTable) {
         String options = genTable.getOptions();
-		Map<String, Object> paramsObj = JsonUtils.parseMap(options);
+        Map<String, Object> paramsObj = JsonUtils.parseMap(options);
         String treeCode = getTreecode(paramsObj);
         String treeParentCode = getTreeParentCode(paramsObj);
         String treeName = getTreeName(paramsObj);
@@ -94,18 +95,15 @@
         context.put("treeParentCode", treeParentCode);
         context.put("treeName", treeName);
         context.put("expandColumn", getExpandColumn(genTable));
-        if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE))
-        {
+        if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
             context.put("tree_parent_code", paramsObj.get(GenConstants.TREE_PARENT_CODE));
         }
-        if (paramsObj.containsKey(GenConstants.TREE_NAME))
-        {
+        if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
             context.put("tree_name", paramsObj.get(GenConstants.TREE_NAME));
         }
     }
 
-    public static void setSubVelocityContext(VelocityContext context, GenTable genTable)
-    {
+    public static void setSubVelocityContext(VelocityContext context, GenTable genTable) {
         GenTable subTable = genTable.getSubTable();
         String subTableName = genTable.getSubTableName();
         String subTableFkName = genTable.getSubTableFkName();
@@ -127,12 +125,11 @@
      *
      * @return 妯℃澘鍒楄〃
      */
-    public static List<String> getTemplateList(String tplCategory)
-    {
+    public static List<String> getTemplateList(String tplCategory) {
         List<String> templates = new ArrayList<String>();
         templates.add("vm/java/domain.java.vm");
         templates.add("vm/java/vo.java.vm");
-		templates.add("vm/java/bo.java.vm");
+        templates.add("vm/java/bo.java.vm");
         templates.add("vm/java/mapper.java.vm");
         templates.add("vm/java/service.java.vm");
         templates.add("vm/java/serviceImpl.java.vm");
@@ -140,16 +137,11 @@
         templates.add("vm/xml/mapper.xml.vm");
         templates.add("vm/sql/sql.vm");
         templates.add("vm/js/api.js.vm");
-        if (GenConstants.TPL_CRUD.equals(tplCategory))
-        {
+        if (GenConstants.TPL_CRUD.equals(tplCategory)) {
             templates.add("vm/vue/index.vue.vm");
-        }
-        else if (GenConstants.TPL_TREE.equals(tplCategory))
-        {
+        } else if (GenConstants.TPL_TREE.equals(tplCategory)) {
             templates.add("vm/vue/index-tree.vue.vm");
-        }
-        else if (GenConstants.TPL_SUB.equals(tplCategory))
-        {
+        } else if (GenConstants.TPL_SUB.equals(tplCategory)) {
             templates.add("vm/vue/index.vue.vm");
             templates.add("vm/java/sub-domain.java.vm");
         }
@@ -159,8 +151,7 @@
     /**
      * 鑾峰彇鏂囦欢鍚�
      */
-    public static String getFileName(String template, GenTable genTable)
-    {
+    public static String getFileName(String template, GenTable genTable) {
         // 鏂囦欢鍚嶇О
         String fileName = "";
         // 鍖呰矾寰�
@@ -176,56 +167,34 @@
         String mybatisPath = MYBATIS_PATH + "/" + moduleName;
         String vuePath = "vue";
 
-        if (template.contains("domain.java.vm"))
-        {
+        if (template.contains("domain.java.vm")) {
             fileName = StringUtils.format("{}/domain/{}.java", javaPath, className);
         }
-        if (template.contains("vo.java.vm"))
-        {
+        if (template.contains("vo.java.vm")) {
             fileName = StringUtils.format("{}/domain/vo/{}Vo.java", javaPath, className);
         }
-		if (template.contains("bo.java.vm"))
-		{
-			fileName = StringUtils.format("{}/domain/bo/{}Bo.java", javaPath, className);
-		}
-        if (template.contains("sub-domain.java.vm") && StringUtils.equals(GenConstants.TPL_SUB, genTable.getTplCategory()))
-        {
+        if (template.contains("bo.java.vm")) {
+            fileName = StringUtils.format("{}/domain/bo/{}Bo.java", javaPath, className);
+        }
+        if (template.contains("sub-domain.java.vm") && StringUtils.equals(GenConstants.TPL_SUB, genTable.getTplCategory())) {
             fileName = StringUtils.format("{}/domain/{}.java", javaPath, genTable.getSubTable().getClassName());
-        }
-        else if (template.contains("mapper.java.vm"))
-        {
+        } else if (template.contains("mapper.java.vm")) {
             fileName = StringUtils.format("{}/mapper/{}Mapper.java", javaPath, className);
-        }
-        else if (template.contains("service.java.vm"))
-        {
+        } else if (template.contains("service.java.vm")) {
             fileName = StringUtils.format("{}/service/I{}Service.java", javaPath, className);
-        }
-        else if (template.contains("serviceImpl.java.vm"))
-        {
+        } else if (template.contains("serviceImpl.java.vm")) {
             fileName = StringUtils.format("{}/service/impl/{}ServiceImpl.java", javaPath, className);
-        }
-        else if (template.contains("controller.java.vm"))
-        {
+        } else if (template.contains("controller.java.vm")) {
             fileName = StringUtils.format("{}/controller/{}Controller.java", javaPath, className);
-        }
-        else if (template.contains("mapper.xml.vm"))
-        {
+        } else if (template.contains("mapper.xml.vm")) {
             fileName = StringUtils.format("{}/{}Mapper.xml", mybatisPath, className);
-        }
-        else if (template.contains("sql.vm"))
-        {
+        } else if (template.contains("sql.vm")) {
             fileName = businessName + "Menu.sql";
-        }
-        else if (template.contains("api.js.vm"))
-        {
+        } else if (template.contains("api.js.vm")) {
             fileName = StringUtils.format("{}/api/{}/{}.js", vuePath, moduleName, businessName);
-        }
-        else if (template.contains("index.vue.vm"))
-        {
+        } else if (template.contains("index.vue.vm")) {
             fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
-        }
-        else if (template.contains("index-tree.vue.vm"))
-        {
+        } else if (template.contains("index-tree.vue.vm")) {
             fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
         }
         return fileName;
@@ -237,8 +206,7 @@
      * @param packageName 鍖呭悕绉�
      * @return 鍖呭墠缂�鍚嶇О
      */
-    public static String getPackagePrefix(String packageName)
-    {
+    public static String getPackagePrefix(String packageName) {
         int lastIndex = packageName.lastIndexOf(".");
         String basePackage = StringUtils.substring(packageName, 0, lastIndex);
         return basePackage;
@@ -246,28 +214,22 @@
 
     /**
      * 鏍规嵁鍒楃被鍨嬭幏鍙栧鍏ュ寘
-     * 
+     *
      * @param genTable 涓氬姟琛ㄥ璞�
      * @return 杩斿洖闇�瑕佸鍏ョ殑鍖呭垪琛�
      */
-    public static HashSet<String> getImportList(GenTable genTable)
-    {
+    public static HashSet<String> getImportList(GenTable genTable) {
         List<GenTableColumn> columns = genTable.getColumns();
         GenTable subGenTable = genTable.getSubTable();
         HashSet<String> importList = new HashSet<String>();
-        if (StringUtils.isNotNull(subGenTable))
-        {
+        if (StringUtils.isNotNull(subGenTable)) {
             importList.add("java.util.List");
         }
-        for (GenTableColumn column : columns)
-        {
-            if (!column.isSuperColumn() && GenConstants.TYPE_DATE.equals(column.getJavaType()))
-            {
+        for (GenTableColumn column : columns) {
+            if (!column.isSuperColumn() && GenConstants.TYPE_DATE.equals(column.getJavaType())) {
                 importList.add("java.util.Date");
                 importList.add("com.fasterxml.jackson.annotation.JsonFormat");
-            }
-            else if (!column.isSuperColumn() && GenConstants.TYPE_BIGDECIMAL.equals(column.getJavaType()))
-            {
+            } else if (!column.isSuperColumn() && GenConstants.TYPE_BIGDECIMAL.equals(column.getJavaType())) {
                 importList.add("java.math.BigDecimal");
             }
         }
@@ -280,15 +242,12 @@
      * @param genTable 涓氬姟琛ㄥ璞�
      * @return 杩斿洖瀛楀吀缁�
      */
-    public static String getDicts(GenTable genTable)
-    {
+    public static String getDicts(GenTable genTable) {
         List<GenTableColumn> columns = genTable.getColumns();
         List<String> dicts = new ArrayList<String>();
-        for (GenTableColumn column : columns)
-        {
+        for (GenTableColumn column : columns) {
             if (!column.isSuperColumn() && StringUtils.isNotEmpty(column.getDictType()) && StringUtils.equalsAny(
-                    column.getHtmlType(), new String[] { GenConstants.HTML_SELECT, GenConstants.HTML_RADIO }))
-            {
+                    column.getHtmlType(), new String[]{GenConstants.HTML_SELECT, GenConstants.HTML_RADIO})) {
                 dicts.add("'" + column.getDictType() + "'");
             }
         }
@@ -298,12 +257,11 @@
     /**
      * 鑾峰彇鏉冮檺鍓嶇紑
      *
-     * @param moduleName 妯″潡鍚嶇О
+     * @param moduleName   妯″潡鍚嶇О
      * @param businessName 涓氬姟鍚嶇О
      * @return 杩斿洖鏉冮檺鍓嶇紑
      */
-    public static String getPermissionPrefix(String moduleName, String businessName)
-    {
+    public static String getPermissionPrefix(String moduleName, String businessName) {
         return StringUtils.format("{}:{}", moduleName, businessName);
     }
 
@@ -313,11 +271,9 @@
      * @param paramsObj 鐢熸垚鍏朵粬閫夐」
      * @return 涓婄骇鑿滃崟ID瀛楁
      */
-    public static String getParentMenuId(Map<String, Object> paramsObj)
-    {
+    public static String getParentMenuId(Map<String, Object> paramsObj) {
         if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.PARENT_MENU_ID)
-				&& StringUtils.isNotEmpty(Convert.toStr(paramsObj.get(GenConstants.PARENT_MENU_ID))))
-        {
+                && StringUtils.isNotEmpty(Convert.toStr(paramsObj.get(GenConstants.PARENT_MENU_ID)))) {
             return Convert.toStr(paramsObj.get(GenConstants.PARENT_MENU_ID));
         }
         return DEFAULT_PARENT_MENU_ID;
@@ -329,10 +285,8 @@
      * @param paramsObj 鐢熸垚鍏朵粬閫夐」
      * @return 鏍戠紪鐮�
      */
-    public static String getTreecode(Map<String, Object> paramsObj)
-    {
-        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_CODE))
-        {
+    public static String getTreecode(Map<String, Object> paramsObj) {
+        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_CODE)) {
             return StringUtils.toCamelCase(Convert.toStr(paramsObj.get(GenConstants.TREE_CODE)));
         }
         return StringUtils.EMPTY;
@@ -344,10 +298,8 @@
      * @param paramsObj 鐢熸垚鍏朵粬閫夐」
      * @return 鏍戠埗缂栫爜
      */
-    public static String getTreeParentCode(Map<String, Object> paramsObj)
-    {
-        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_PARENT_CODE))
-        {
+    public static String getTreeParentCode(Map<String, Object> paramsObj) {
+        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
             return StringUtils.toCamelCase(Convert.toStr(paramsObj.get(GenConstants.TREE_PARENT_CODE)));
         }
         return StringUtils.EMPTY;
@@ -359,10 +311,8 @@
      * @param paramsObj 鐢熸垚鍏朵粬閫夐」
      * @return 鏍戝悕绉�
      */
-    public static String getTreeName(Map<String, Object> paramsObj)
-    {
-        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_NAME))
-        {
+    public static String getTreeName(Map<String, Object> paramsObj) {
+        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_NAME)) {
             return StringUtils.toCamelCase(Convert.toStr(paramsObj.get(GenConstants.TREE_NAME)));
         }
         return StringUtils.EMPTY;
@@ -374,20 +324,16 @@
      * @param genTable 涓氬姟琛ㄥ璞�
      * @return 灞曞紑鎸夐挳鍒楀簭鍙�
      */
-    public static int getExpandColumn(GenTable genTable)
-    {
+    public static int getExpandColumn(GenTable genTable) {
         String options = genTable.getOptions();
         Map<String, Object> paramsObj = JsonUtils.parseMap(options);
         String treeName = Convert.toStr(paramsObj.get(GenConstants.TREE_NAME));
         int num = 0;
-        for (GenTableColumn column : genTable.getColumns())
-        {
-            if (column.isList())
-            {
+        for (GenTableColumn column : genTable.getColumns()) {
+            if (column.isList()) {
                 num++;
                 String columnName = column.getColumnName();
-                if (columnName.equals(treeName))
-                {
+                if (columnName.equals(treeName)) {
                     break;
                 }
             }

--
Gitblit v1.9.3