♻️ 重构代码代码生成器

This commit is contained in:
付绪壮 2022-07-21 03:41:28 +08:00
parent 54166bc62b
commit 75ec53b715
4 changed files with 35 additions and 421 deletions

View File

@ -23,8 +23,8 @@ import com.pig4cloud.pig.codegen.entity.ColumnEntity;
import com.pig4cloud.pig.codegen.entity.GenFormConf;
import com.pig4cloud.pig.codegen.mapper.GenFormConfMapper;
import com.pig4cloud.pig.codegen.mapper.GeneratorMapper;
import com.pig4cloud.pig.codegen.service.GenCodeService;
import com.pig4cloud.pig.codegen.service.GenFormConfService;
import com.pig4cloud.pig.codegen.support.CodeGenKits;
import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
import org.apache.commons.lang.StringUtils;
@ -52,6 +52,8 @@ public class GenFormConfServiceImpl extends ServiceImpl<GenFormConfMapper, GenFo
private final GeneratorMapper generatorMapper;
private final GenCodeService avue;
/**
* 1. 根据数据源表名称查询已配置表单信息 2. 不存在调用模板生成
* @param dsName 数据源ID
@ -80,13 +82,13 @@ public class GenFormConfServiceImpl extends ServiceImpl<GenFormConfMapper, GenFo
for (Map<String, String> column : columns) {
ColumnEntity columnEntity = new ColumnEntity();
columnEntity.setComments(column.get("columnComment"));
columnEntity.setLowerAttrName(StringUtils.uncapitalize(CodeGenKits.columnToJava(column.get("columnName"))));
columnEntity.setLowerAttrName(StringUtils.uncapitalize(avue.columnToJava(column.get("columnName"))));
columnList.add(columnEntity);
}
context.put("columns", columnList);
StringWriter writer = new StringWriter();
template.merge(context, writer);
return StrUtil.trim(StrUtil.removePrefix(writer.toString(), CodeGenKits.CRUD_PREFIX));
return StrUtil.trim(StrUtil.removePrefix(writer.toString(), "export const tableOption ="));
}
}

View File

@ -28,8 +28,9 @@ import com.pig4cloud.pig.codegen.entity.GenConfig;
import com.pig4cloud.pig.codegen.entity.GenFormConf;
import com.pig4cloud.pig.codegen.mapper.GenFormConfMapper;
import com.pig4cloud.pig.codegen.mapper.GeneratorMapper;
import com.pig4cloud.pig.codegen.service.GenCodeService;
import com.pig4cloud.pig.codegen.service.GeneratorService;
import com.pig4cloud.pig.codegen.support.CodeGenKits;
import com.pig4cloud.pig.codegen.support.StyleTypeEnum;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
@ -52,6 +53,8 @@ public class GeneratorServiceImpl implements GeneratorService {
private final GenFormConfMapper genFormConfMapper;
private final Map<String, GenCodeService> genCodeServiceMap;
/**
* 分页查询表
* @param tableName 查询条件
@ -77,17 +80,22 @@ public class GeneratorServiceImpl implements GeneratorService {
.eq(GenFormConf::getTableName, genConfig.getTableName()).orderByDesc(GenFormConf::getCreateTime));
String tableNames = genConfig.getTableName();
String dsName = genConfig.getDsName();
// 获取实现
GenCodeService genCodeService = genCodeServiceMap.get(StyleTypeEnum.getDecs(genConfig.getStyle()));
for (String tableName : StrUtil.split(tableNames, StrUtil.DASHED)) {
// 查询表信息
Map<String, String> table = generatorMapper.queryTable(tableName, genConfig.getDsName());
Map<String, String> table = generatorMapper.queryTable(tableName, dsName);
// 查询列信息
List<Map<String, String>> columns = generatorMapper.queryColumns(tableName, genConfig.getDsName());
List<Map<String, String>> columns = generatorMapper.queryColumns(tableName, dsName);
// 生成代码
if (CollUtil.isNotEmpty(formConfList)) {
return CodeGenKits.generatorCode(genConfig, table, columns, null, formConfList.get(0));
return genCodeService.gen(genConfig, table, columns, null, formConfList.get(0));
}
else {
return CodeGenKits.generatorCode(genConfig, table, columns, null, null);
return genCodeService.gen(genConfig, table, columns, null, null);
}
}
@ -109,17 +117,21 @@ public class GeneratorServiceImpl implements GeneratorService {
ZipOutputStream zip = new ZipOutputStream(outputStream);
String tableNames = genConfig.getTableName();
String dsName = genConfig.getDsName();
GenCodeService genCodeService = genCodeServiceMap.get(StyleTypeEnum.getDecs(genConfig.getStyle()));
for (String tableName : StrUtil.split(tableNames, StrUtil.DASHED)) {
// 查询表信息
Map<String, String> table = generatorMapper.queryTable(tableName, genConfig.getDsName());
Map<String, String> table = generatorMapper.queryTable(tableName, dsName);
// 查询列信息
List<Map<String, String>> columns = generatorMapper.queryColumns(tableName, genConfig.getDsName());
List<Map<String, String>> columns = generatorMapper.queryColumns(tableName, dsName);
// 生成代码
if (CollUtil.isNotEmpty(formConfList)) {
CodeGenKits.generatorCode(genConfig, table, columns, zip, formConfList.get(0));
genCodeService.gen(genConfig, table, columns, zip, formConfList.get(0));
}
else {
CodeGenKits.generatorCode(genConfig, table, columns, zip, null);
genCodeService.gen(genConfig, table, columns, zip, null);
}
}
IoUtil.close(zip);

View File

@ -1,407 +0,0 @@
/*
* Copyright (c) 2020 pig4cloud Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.pig4cloud.pig.codegen.support;
import cn.hutool.core.date.DateUtil;
import cn.hutool.core.io.IoUtil;
import cn.hutool.core.util.CharsetUtil;
import cn.hutool.core.util.StrUtil;
import com.pig4cloud.pig.codegen.entity.ColumnEntity;
import com.pig4cloud.pig.codegen.entity.GenConfig;
import com.pig4cloud.pig.codegen.entity.GenFormConf;
import com.pig4cloud.pig.codegen.entity.TableEntity;
import com.pig4cloud.pig.common.core.constant.CommonConstants;
import com.pig4cloud.pig.common.core.exception.CheckedException;
import lombok.SneakyThrows;
import lombok.experimental.UtilityClass;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.WordUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.tools.generic.DateTool;
import org.apache.velocity.tools.generic.MathTool;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.nio.charset.StandardCharsets;
import java.util.*;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
/**
* 代码生成器 工具类 copy
* elunez/eladmin/blob/master/eladmin-generator/src/main/java/me/zhengjie/utils/GenUtil.java
*
* @author Zheng Jie
* @author lengleng
* @date 2020-03-13
*/
@Slf4j
@UtilityClass
public class CodeGenKits {
public final String CRUD_PREFIX = "export const tableOption =";
private final String ENTITY_JAVA_VM = "Entity.java.vm";
private final String MAPPER_JAVA_VM = "Mapper.java.vm";
private final String SERVICE_JAVA_VM = "Service.java.vm";
private final String SERVICE_IMPL_JAVA_VM = "ServiceImpl.java.vm";
private final String CONTROLLER_JAVA_VM = "Controller.java.vm";
private final String MAPPER_XML_VM = "Mapper.xml.vm";
private final String MENU_SQL_VM = "menu.sql.vm";
private final String AVUE_INDEX_VUE_VM = "avue/index.vue.vm";
private final String ELE_INDEX_VUE_VM = "element/index.vue.vm";
private final String ELE_ADD_UPDATE_VUE_VM = "element/form.vue.vm";
private final String AVUE_API_JS_VM = "avue/api.js.vm";
private final String AVUE_CRUD_JS_VM = "avue/crud.js.vm";
/**
* 配置
* @param config
* @return
*/
private List<String> getTemplates(GenConfig config) {
List<String> templates = new ArrayList<>();
templates.add("template/Entity.java.vm");
templates.add("template/Mapper.java.vm");
templates.add("template/Mapper.xml.vm");
templates.add("template/Service.java.vm");
templates.add("template/ServiceImpl.java.vm");
templates.add("template/Controller.java.vm");
templates.add("template/menu.sql.vm");
templates.add("template/avue/api.js.vm");
if (StyleTypeEnum.AVUE.getStyle().equals(config.getStyle())) {
templates.add("template/avue/index.vue.vm");
templates.add("template/avue/crud.js.vm");
}
else {
templates.add("template/element/index.vue.vm");
templates.add("template/element/form.vue.vm");
}
return templates;
}
/**
* 生成代码
* @return
*/
@SneakyThrows
public Map<String, String> generatorCode(GenConfig genConfig, Map<String, String> table,
List<Map<String, String>> columns, ZipOutputStream zip, GenFormConf formConf) {
// 配置信息
Configuration config = getConfig();
boolean hasBigDecimal = false;
// 表信息
TableEntity tableEntity = new TableEntity();
tableEntity.setTableName(table.get("tableName"));
if (StrUtil.isNotBlank(genConfig.getComments())) {
tableEntity.setComments(genConfig.getComments());
}
else {
tableEntity.setComments(table.get("tableComment"));
}
String tablePrefix;
if (StrUtil.isNotBlank(genConfig.getTablePrefix())) {
tablePrefix = genConfig.getTablePrefix();
}
else {
tablePrefix = config.getString("tablePrefix");
}
// 表名转换成Java类名
String className = tableToJava(tableEntity.getTableName(), tablePrefix);
tableEntity.setCaseClassName(className);
tableEntity.setLowerClassName(StringUtils.uncapitalize(className));
// 获取需要在swagger文档中隐藏的属性字段
List<Object> hiddenColumns = config.getList("hiddenColumn");
// 列信息
List<ColumnEntity> columnList = new ArrayList<>();
for (Map<String, String> column : columns) {
ColumnEntity columnEntity = new ColumnEntity();
columnEntity.setColumnName(column.get("columnName"));
columnEntity.setDataType(column.get("dataType"));
columnEntity.setExtra(column.get("extra"));
columnEntity.setNullable("NO".equals(column.get("isNullable")));
columnEntity.setColumnType(column.get("columnType"));
// 隐藏不需要的在接口文档中展示的字段
if (hiddenColumns.contains(column.get("columnName"))) {
columnEntity.setHidden(Boolean.TRUE);
}
else {
columnEntity.setHidden(Boolean.FALSE);
}
// 列名转换成Java属性名
String attrName = columnToJava(columnEntity.getColumnName());
columnEntity.setCaseAttrName(attrName);
columnEntity.setLowerAttrName(StringUtils.uncapitalize(attrName));
// 判断注释是否为空
if (StrUtil.isNotBlank(column.get("columnComment"))) {
// 注意去除换行符号
columnEntity.setComments(StrUtil.removeAllLineBreaks(column.get("columnComment")));
}
else {
columnEntity.setComments(columnEntity.getLowerAttrName());
}
// 列的数据类型转换成Java类型
String dataType = StrUtil.subBefore(columnEntity.getDataType(), "(", false);
String attrType = config.getString(dataType, "unknowType");
columnEntity.setAttrType(attrType);
if (!hasBigDecimal && "BigDecimal".equals(attrType)) {
hasBigDecimal = true;
}
// 是否主键
if ("PRI".equalsIgnoreCase(column.get("columnKey")) && tableEntity.getPk() == null) {
tableEntity.setPk(columnEntity);
}
columnList.add(columnEntity);
}
tableEntity.setColumns(columnList);
// 没主键则第一个字段为主键
if (tableEntity.getPk() == null) {
tableEntity.setPk(tableEntity.getColumns().get(0));
}
// 封装模板数据
Map<String, Object> map = new HashMap<>(16);
map.put("tableName", tableEntity.getTableName());
map.put("pk", tableEntity.getPk());
map.put("className", tableEntity.getCaseClassName());
map.put("classname", tableEntity.getLowerClassName());
map.put("pathName", tableEntity.getLowerClassName().toLowerCase());
map.put("columns", tableEntity.getColumns());
map.put("hasBigDecimal", hasBigDecimal);
map.put("datetime", DateUtil.now());
if (StrUtil.isNotBlank(genConfig.getComments())) {
map.put("comments", genConfig.getComments());
}
else {
map.put("comments", tableEntity.getComments());
}
if (StrUtil.isNotBlank(genConfig.getAuthor())) {
map.put("author", genConfig.getAuthor());
}
else {
map.put("author", config.getString("author"));
}
if (StrUtil.isNotBlank(genConfig.getModuleName())) {
map.put("moduleName", genConfig.getModuleName());
}
else {
map.put("moduleName", config.getString("moduleName"));
}
if (StrUtil.isNotBlank(genConfig.getPackageName())) {
map.put("package", genConfig.getPackageName());
map.put("mainPath", genConfig.getPackageName());
}
else {
map.put("package", config.getString("package"));
map.put("mainPath", config.getString("mainPath"));
}
// 渲染数据
return renderData(genConfig, zip, formConf, tableEntity, map);
}
/**
* 渲染数据
* @param genConfig 配置信息
* @param zip 为空直接返回Map
* @param formConf 表单信息
* @param tableEntity 表基本信息
* @param map 模板参数
* @return map key-filename value-contents
* @throws IOException
*/
private Map<String, String> renderData(GenConfig genConfig, ZipOutputStream zip, GenFormConf formConf,
TableEntity tableEntity, Map<String, Object> map) throws IOException {
// 设置velocity资源加载器
Properties prop = new Properties();
prop.put("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
Velocity.init(prop);
VelocityContext context = new VelocityContext(map);
// 函数库
context.put("math", new MathTool());
context.put("dateTool", new DateTool());
// 获取模板列表
List<String> templates = getTemplates(genConfig);
Map<String, String> resultMap = new HashMap<>(8);
for (String template : templates) {
// 如果是crud
if (template.contains(AVUE_CRUD_JS_VM) && formConf != null) {
String fileName = getFileName(template, tableEntity.getCaseClassName(), map.get("package").toString(),
map.get("moduleName").toString());
String contents = CRUD_PREFIX + formConf.getFormInfo();
if (zip != null) {
zip.putNextEntry(new ZipEntry(Objects.requireNonNull(fileName)));
IoUtil.write(zip, StandardCharsets.UTF_8, false, contents);
zip.closeEntry();
}
resultMap.put(template, contents);
continue;
}
// 渲染模板
StringWriter sw = new StringWriter();
Template tpl = Velocity.getTemplate(template, CharsetUtil.UTF_8);
tpl.merge(context, sw);
// 添加到zip
String fileName = getFileName(template, tableEntity.getCaseClassName(), map.get("package").toString(),
map.get("moduleName").toString());
if (zip != null) {
zip.putNextEntry(new ZipEntry(Objects.requireNonNull(fileName)));
IoUtil.write(zip, StandardCharsets.UTF_8, false, sw.toString());
IoUtil.close(sw);
zip.closeEntry();
}
resultMap.put(template, sw.toString());
}
return resultMap;
}
/**
* 列名转换成Java属性名
*/
public String columnToJava(String columnName) {
return WordUtils.capitalizeFully(columnName, new char[] { '_' }).replace("_", "");
}
/**
* 表名转换成Java类名
*/
private String tableToJava(String tableName, String tablePrefix) {
if (StringUtils.isNotBlank(tablePrefix)) {
tableName = tableName.replaceFirst(tablePrefix, "");
}
return columnToJava(tableName);
}
/**
* 获取配置信息
*/
public Configuration getConfig() {
try {
return new PropertiesConfiguration("generator.properties");
}
catch (ConfigurationException e) {
throw new CheckedException("获取配置文件失败,", e);
}
}
/**
* 获取文件名
*/
private String getFileName(String template, String className, String packageName, String moduleName) {
String packagePath = CommonConstants.BACK_END_PROJECT + File.separator + "src" + File.separator + "main"
+ File.separator + "java" + File.separator;
if (StringUtils.isNotBlank(packageName)) {
packagePath += packageName.replace(".", File.separator) + File.separator + moduleName + File.separator;
}
if (template.contains(ENTITY_JAVA_VM)) {
return packagePath + "entity" + File.separator + className + ".java";
}
if (template.contains(MAPPER_JAVA_VM)) {
return packagePath + "mapper" + File.separator + className + "Mapper.java";
}
if (template.contains(SERVICE_JAVA_VM)) {
return packagePath + "service" + File.separator + className + "Service.java";
}
if (template.contains(SERVICE_IMPL_JAVA_VM)) {
return packagePath + "service" + File.separator + "impl" + File.separator + className + "ServiceImpl.java";
}
if (template.contains(CONTROLLER_JAVA_VM)) {
return packagePath + "controller" + File.separator + className + "Controller.java";
}
if (template.contains(MAPPER_XML_VM)) {
return CommonConstants.BACK_END_PROJECT + File.separator + "src" + File.separator + "main" + File.separator
+ "resources" + File.separator + "mapper" + File.separator + className + "Mapper.xml";
}
if (template.contains(MENU_SQL_VM)) {
return className.toLowerCase() + "_menu.sql";
}
if (template.contains(AVUE_INDEX_VUE_VM) || template.contains(ELE_INDEX_VUE_VM)) {
return CommonConstants.FRONT_END_PROJECT + File.separator + "src" + File.separator + "views"
+ File.separator + moduleName + File.separator + className.toLowerCase() + File.separator
+ "index.vue";
}
if (template.contains(AVUE_API_JS_VM)) {
return CommonConstants.FRONT_END_PROJECT + File.separator + "src" + File.separator + "api" + File.separator
+ className.toLowerCase() + ".js";
}
if (template.contains(AVUE_CRUD_JS_VM)) {
return CommonConstants.FRONT_END_PROJECT + File.separator + "src" + File.separator + "const"
+ File.separator + "crud" + File.separator + className.toLowerCase() + ".js";
}
if (template.contains(ELE_ADD_UPDATE_VUE_VM)) {
return CommonConstants.FRONT_END_PROJECT + File.separator + "src" + File.separator + "views"
+ File.separator + moduleName + File.separator + className.toLowerCase() + File.separator
+ className.toLowerCase() + "-form.vue";
}
return null;
}
}

View File

@ -3,6 +3,8 @@ package com.pig4cloud.pig.codegen.support;
import lombok.AllArgsConstructor;
import lombok.Getter;
import java.util.Arrays;
/**
* @author lengleng
* @date 2021/7/31
@ -16,12 +18,12 @@ public enum StyleTypeEnum {
/**
* 前端类型-avue 风格
*/
AVUE("0", "avue 风格"),
AVUE("0", "avue"),
/**
* 前端类型-element 风格
*/
ELEMENT("1", "element 风格");
ELEMENT("1", "element");
/**
* 类型
@ -33,4 +35,9 @@ public enum StyleTypeEnum {
*/
private String description;
public static String getDecs(String style) {
return Arrays.stream(StyleTypeEnum.values()).filter(styleTypeEnum -> styleTypeEnum.getStyle().equals(style))
.findFirst().orElse(ELEMENT).getDescription();
}
}