VelocityUtils.java 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
  1. package com.ruoyi.generator.util;
  2. import java.util.ArrayList;
  3. import java.util.HashSet;
  4. import java.util.List;
  5. import org.apache.velocity.VelocityContext;
  6. import com.alibaba.fastjson.JSONObject;
  7. import com.ruoyi.common.constant.GenConstants;
  8. import com.ruoyi.common.utils.DateUtils;
  9. import com.ruoyi.common.utils.StringUtils;
  10. import com.ruoyi.generator.domain.GenTable;
  11. import com.ruoyi.generator.domain.GenTableColumn;
  12. /**
  13. * 模板处理工具类
  14. *
  15. * @author ruoyi
  16. */
  17. public class VelocityUtils {
  18. /**
  19. * 默认上级菜单,系统工具
  20. */
  21. private static final String DEFAULT_PARENT_MENU_ID = "3";
  22. /**
  23. * 设置模板变量信息
  24. *
  25. * @return 模板列表
  26. */
  27. public static VelocityContext prepareContext(GenTable genTable) {
  28. String moduleName = genTable.getModuleName();
  29. String businessName = genTable.getBusinessName();
  30. String packageName = genTable.getPackageName();
  31. String tplCategory = genTable.getTplCategory();
  32. String functionName = genTable.getFunctionName();
  33. VelocityContext velocityContext = new VelocityContext();
  34. velocityContext.put("tplCategory", genTable.getTplCategory());
  35. velocityContext.put("tableName", genTable.getTableName());
  36. velocityContext.put("functionName", StringUtils.isNotEmpty(functionName) ? functionName : "【请填写功能名称】");
  37. velocityContext.put("ClassName", genTable.getClassName());
  38. velocityContext.put("className", StringUtils.uncapitalize(genTable.getClassName()));
  39. velocityContext.put("moduleName", genTable.getModuleName());
  40. velocityContext.put("BusinessName", StringUtils.capitalize(genTable.getBusinessName()));
  41. velocityContext.put("businessName", genTable.getBusinessName());
  42. velocityContext.put("basePackage", getPackagePrefix(packageName));
  43. velocityContext.put("packageName", packageName);
  44. velocityContext.put("author", genTable.getFunctionAuthor());
  45. velocityContext.put("datetime", DateUtils.getDate());
  46. velocityContext.put("pkColumn", genTable.getPkColumn());
  47. velocityContext.put("importList", getImportList(genTable.getColumns()));
  48. velocityContext.put("permissionPrefix", getPermissionPrefix(moduleName, businessName));
  49. velocityContext.put("columns", genTable.getColumns());
  50. velocityContext.put("table", genTable);
  51. setMenuVelocityContext(velocityContext, genTable);
  52. if (GenConstants.TPL_TREE.equals(tplCategory)) {
  53. setTreeVelocityContext(velocityContext, genTable);
  54. }
  55. return velocityContext;
  56. }
  57. public static void setTreeVelocityContext(VelocityContext context, GenTable genTable) {
  58. String options = genTable.getOptions();
  59. JSONObject paramsObj = JSONObject.parseObject(options);
  60. String treeCode = getTreecode(paramsObj);
  61. String treeParentCode = getTreeParentCode(paramsObj);
  62. String treeName = getTreeName(paramsObj);
  63. context.put("treeCode", treeCode);
  64. context.put("treeParentCode", treeParentCode);
  65. context.put("treeName", treeName);
  66. context.put("expandColumn", getExpandColumn(genTable));
  67. if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
  68. context.put("tree_parent_code", paramsObj.getString(GenConstants.TREE_PARENT_CODE));
  69. }
  70. if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
  71. context.put("tree_name", paramsObj.getString(GenConstants.TREE_NAME));
  72. }
  73. }
  74. /**
  75. * 获取模板信息
  76. *
  77. * @return 模板列表
  78. */
  79. public static List<String> getTemplateList(String tplCategory) {
  80. List<String> templates = new ArrayList<String>();
  81. templates.add("vm/java/domain.java.vm");
  82. templates.add("vm/java/mapper.java.vm");
  83. templates.add("vm/java/service.java.vm");
  84. templates.add("vm/java/serviceImpl.java.vm");
  85. templates.add("vm/java/controller.java.vm");
  86. templates.add("vm/xml/mapper.xml.vm");
  87. templates.add("vm/sql/sql.vm");
  88. templates.add("vm/js/api.js.vm");
  89. if (GenConstants.TPL_CRUD.equals(tplCategory)) {
  90. templates.add("vm/vue/index.vue.vm");
  91. } else if (GenConstants.TPL_TREE.equals(tplCategory)) {
  92. templates.add("vm/vue/index-tree.vue.vm");
  93. }
  94. return templates;
  95. }
  96. /**
  97. * 获取文件名
  98. */
  99. public static String getFileName(String template, GenTable genTable) {
  100. // 文件名称
  101. String fileName = "";
  102. // 包路径
  103. String packageName = genTable.getPackageName();
  104. // 模块名
  105. String moduleName = genTable.getModuleName();
  106. // 大写类名
  107. String className = genTable.getClassName();
  108. // 业务名称
  109. String businessName = genTable.getBusinessName();
  110. String javaPath = PROJECT_PATH + "/" + StringUtils.replace(packageName, ".", "/");
  111. String mybatisPath = MYBATIS_PATH + "/" + moduleName;
  112. String vuePath = "vue";
  113. if (template.contains("domain.java.vm")) {
  114. fileName = StringUtils.format("{}/domain/{}.java", javaPath, className);
  115. } else if (template.contains("mapper.java.vm")) {
  116. fileName = StringUtils.format("{}/mapper/{}Mapper.java", javaPath, className);
  117. } else if (template.contains("service.java.vm")) {
  118. fileName = StringUtils.format("{}/service/I{}Service.java", javaPath, className);
  119. } else if (template.contains("serviceImpl.java.vm")) {
  120. fileName = StringUtils.format("{}/service/impl/{}ServiceImpl.java", javaPath, className);
  121. } else if (template.contains("controller.java.vm")) {
  122. fileName = StringUtils.format("{}/controller/{}Controller.java", javaPath, className);
  123. } else if (template.contains("mapper.xml.vm")) {
  124. fileName = StringUtils.format("{}/{}Mapper.xml", mybatisPath, className);
  125. } else if (template.contains("sql.vm")) {
  126. fileName = businessName + "Menu.sql";
  127. } else if (template.contains("api.js.vm")) {
  128. fileName = StringUtils.format("{}/api/{}/{}.js", vuePath, moduleName, businessName);
  129. } else if (template.contains("index.vue.vm")) {
  130. fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
  131. } else if (template.contains("index-tree.vue.vm")) {
  132. fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
  133. }
  134. return fileName;
  135. }
  136. /**
  137. * 获取包前缀
  138. *
  139. * @param packageName 包名称
  140. * @return 包前缀名称
  141. */
  142. public static String getPackagePrefix(String packageName) {
  143. int lastIndex = packageName.lastIndexOf(".");
  144. String basePackage = StringUtils.substring(packageName, 0, lastIndex);
  145. return basePackage;
  146. }
  147. /**
  148. * 根据列类型获取导入包
  149. *
  150. * @param columns 列集合
  151. * @return 返回需要导入的包列表
  152. */
  153. public static HashSet<String> getImportList(List<GenTableColumn> columns) {
  154. HashSet<String> importList = new HashSet<String>();
  155. for (GenTableColumn column : columns) {
  156. if (!column.isSuperColumn() && GenConstants.TYPE_DATE.equals(column.getJavaType())) {
  157. importList.add("java.util.Date");
  158. importList.add("com.fasterxml.jackson.annotation.JsonFormat");
  159. } else if (!column.isSuperColumn() && GenConstants.TYPE_BIGDECIMAL.equals(column.getJavaType())) {
  160. importList.add("java.math.BigDecimal");
  161. }
  162. }
  163. return importList;
  164. }
  165. /**
  166. * 获取权限前缀
  167. *
  168. * @param moduleName 模块名称
  169. * @param businessName 业务名称
  170. * @return 返回权限前缀
  171. */
  172. public static String getPermissionPrefix(String moduleName, String businessName) {
  173. return StringUtils.format("{}:{}", moduleName, businessName);
  174. }
  175. /**
  176. * 获取上级菜单ID字段
  177. *
  178. * @param paramsObj 生成其他选项
  179. * @return 上级菜单ID字段
  180. */
  181. public static String getParentMenuId(JSONObject paramsObj) {
  182. if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.PARENT_MENU_ID)) {
  183. return paramsObj.getString(GenConstants.PARENT_MENU_ID);
  184. }
  185. return DEFAULT_PARENT_MENU_ID;
  186. }
  187. /**
  188. * 获取树编码
  189. *
  190. * @param paramsObj 生成其他选项
  191. * @return 树编码
  192. */
  193. public static String getTreecode(JSONObject paramsObj) {
  194. if (paramsObj.containsKey(GenConstants.TREE_CODE)) {
  195. return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_CODE));
  196. }
  197. return StringUtils.EMPTY;
  198. }
  199. /**
  200. * 获取树父编码
  201. *
  202. * @param paramsObj 生成其他选项
  203. * @return 树父编码
  204. */
  205. public static String getTreeParentCode(JSONObject paramsObj) {
  206. if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
  207. return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_PARENT_CODE));
  208. }
  209. return StringUtils.EMPTY;
  210. }
  211. /**
  212. * 获取树名称
  213. *
  214. * @param paramsObj 生成其他选项
  215. * @return 树名称
  216. */
  217. public static String getTreeName(JSONObject paramsObj) {
  218. if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
  219. return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_NAME));
  220. }
  221. return StringUtils.EMPTY;
  222. }
  223. /**
  224. * 获取需要在哪一列上面显示展开按钮
  225. *
  226. * @param genTable 业务表对象
  227. * @return 展开按钮列序号
  228. */
  229. public static int getExpandColumn(GenTable genTable) {
  230. String options = genTable.getOptions();
  231. JSONObject paramsObj = JSONObject.parseObject(options);
  232. String treeName = paramsObj.getString(GenConstants.TREE_NAME);
  233. int num = 0;
  234. for (GenTableColumn column : genTable.getColumns()) {
  235. if (column.isList()) {
  236. num++;
  237. String columnName = column.getColumnName();
  238. if (columnName.equals(treeName)) {
  239. break;
  240. }
  241. }
  242. }
  243. return num;
  244. }
  245. }