refactor: 抽取代码生成器插件模块（后续会改造为独立插件）

continew-org · Mar 5, 2024 · 87829d3 · 87829d3
1 parent 8026f66
commit 87829d3
Show file tree

Hide file tree

Showing 30 changed files with 78 additions and 86 deletions.
diff --git a/continew-admin-tool/pom.xml → continew-admin-generator/pom.xml b/continew-admin-tool/pom.xml → continew-admin-generator/pom.xml
@@ -9,8 +9,8 @@
  <version>${revision}</version>
  </parent>
 
- <artifactId>continew-admin-tool</artifactId>
- <description>系统工具模块（存放系统工具相关业务功能，例如：代码生成等）</description>
+ <artifactId>continew-admin-generator</artifactId>
+ <description>代码生成器插件</description>
 
  <dependencies>
  <!-- 公共模块（存放公共工具类，公共配置等） -->

diff --git a/...onfig/properties/GeneratorProperties.java → ...onfig/properties/GeneratorProperties.java b/...onfig/properties/GeneratorProperties.java → ...onfig/properties/GeneratorProperties.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.config.properties;
+package top.charles7c.continew.admin.generator.config.properties;
 
 import java.util.Map;
 

diff --git a/...ntinew/admin/tool/enums/FormTypeEnum.java → ...w/admin/generator/enums/FormTypeEnum.java b/...ntinew/admin/tool/enums/FormTypeEnum.java → ...w/admin/generator/enums/FormTypeEnum.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.enums;
+package top.charles7c.continew.admin.generator.enums;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

diff --git a/...tinew/admin/tool/enums/QueryTypeEnum.java → .../admin/generator/enums/QueryTypeEnum.java b/...tinew/admin/tool/enums/QueryTypeEnum.java → .../admin/generator/enums/QueryTypeEnum.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.enums;
+package top.charles7c.continew.admin.generator.enums;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

diff --git a/.../admin/tool/mapper/FieldConfigMapper.java → ...n/generator/mapper/FieldConfigMapper.java b/.../admin/tool/mapper/FieldConfigMapper.java → ...n/generator/mapper/FieldConfigMapper.java
@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.mapper;
+package top.charles7c.continew.admin.generator.mapper;
 
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;
-import top.charles7c.continew.admin.tool.model.entity.FieldConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.FieldConfigDO;
 import top.charles7c.continew.starter.data.mybatis.plus.base.BaseMapper;
 
 import java.util.List;

diff --git a/...ew/admin/tool/mapper/GenConfigMapper.java → ...min/generator/mapper/GenConfigMapper.java b/...ew/admin/tool/mapper/GenConfigMapper.java → ...min/generator/mapper/GenConfigMapper.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.mapper;
+package top.charles7c.continew.admin.generator.mapper;
 
-import top.charles7c.continew.admin.tool.model.entity.GenConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.GenConfigDO;
 import top.charles7c.continew.starter.data.mybatis.plus.base.BaseMapper;
 
 /**

diff --git a/...dmin/tool/model/entity/FieldConfigDO.java → ...generator/model/entity/FieldConfigDO.java b/...dmin/tool/model/entity/FieldConfigDO.java → ...generator/model/entity/FieldConfigDO.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.entity;
+package top.charles7c.continew.admin.generator.model.entity;
 
 import cn.hutool.core.convert.Convert;
 import cn.hutool.core.util.StrUtil;
@@ -29,8 +29,8 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
-import top.charles7c.continew.admin.tool.enums.FormTypeEnum;
-import top.charles7c.continew.admin.tool.enums.QueryTypeEnum;
+import top.charles7c.continew.admin.generator.enums.FormTypeEnum;
+import top.charles7c.continew.admin.generator.enums.QueryTypeEnum;
 import top.charles7c.continew.starter.core.constant.StringConstants;
 
 import java.io.Serial;

diff --git a/.../admin/tool/model/entity/GenConfigDO.java → ...n/generator/model/entity/GenConfigDO.java b/.../admin/tool/model/entity/GenConfigDO.java → ...n/generator/model/entity/GenConfigDO.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.entity;
+package top.charles7c.continew.admin.generator.model.entity;
 
 import java.io.Serial;
 import java.io.Serializable;

diff --git a/...ew/admin/tool/model/query/TableQuery.java → ...min/generator/model/query/TableQuery.java b/...ew/admin/tool/model/query/TableQuery.java → ...min/generator/model/query/TableQuery.java
@@ -14,14 +14,13 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.query;
-
-import java.io.Serial;
-import java.io.Serializable;
+package top.charles7c.continew.admin.generator.model.query;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
-import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serial;
+import java.io.Serializable;
 
 /**
  * 表信息查询条件

diff --git a/...ew/admin/tool/model/req/GenConfigReq.java → ...min/generator/model/req/GenConfigReq.java b/...ew/admin/tool/model/req/GenConfigReq.java → ...min/generator/model/req/GenConfigReq.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.req;
+package top.charles7c.continew.admin.generator.model.req;
 
 import java.io.Serial;
 import java.io.Serializable;
@@ -29,8 +29,8 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 
-import top.charles7c.continew.admin.tool.model.entity.FieldConfigDO;
-import top.charles7c.continew.admin.tool.model.entity.GenConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.FieldConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.GenConfigDO;
 
 /**
  * 代码生成配置信息

diff --git a/.../tool/model/resp/GeneratePreviewResp.java → ...rator/model/resp/GeneratePreviewResp.java b/.../tool/model/resp/GeneratePreviewResp.java → ...rator/model/resp/GeneratePreviewResp.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.resp;
+package top.charles7c.continew.admin.generator.model.resp;
 
 import java.io.Serial;
 import java.io.Serializable;

diff --git a/...inew/admin/tool/model/resp/TableResp.java → ...admin/generator/model/resp/TableResp.java b/...inew/admin/tool/model/resp/TableResp.java → ...admin/generator/model/resp/TableResp.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.model.resp;
+package top.charles7c.continew.admin.generator.model.resp;
 
 import java.io.Serial;
 import java.io.Serializable;

diff --git a/.../admin/tool/service/GeneratorService.java → ...n/generator/service/GeneratorService.java b/.../admin/tool/service/GeneratorService.java → ...n/generator/service/GeneratorService.java
@@ -14,17 +14,17 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.service;
+package top.charles7c.continew.admin.generator.service;
 
 import java.sql.SQLException;
 import java.util.List;
 
-import top.charles7c.continew.admin.tool.model.entity.FieldConfigDO;
-import top.charles7c.continew.admin.tool.model.entity.GenConfigDO;
-import top.charles7c.continew.admin.tool.model.query.TableQuery;
-import top.charles7c.continew.admin.tool.model.req.GenConfigReq;
-import top.charles7c.continew.admin.tool.model.resp.GeneratePreviewResp;
-import top.charles7c.continew.admin.tool.model.resp.TableResp;
+import top.charles7c.continew.admin.generator.model.entity.FieldConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.GenConfigDO;
+import top.charles7c.continew.admin.generator.model.query.TableQuery;
+import top.charles7c.continew.admin.generator.model.req.GenConfigReq;
+import top.charles7c.continew.admin.generator.model.resp.GeneratePreviewResp;
+import top.charles7c.continew.admin.generator.model.resp.TableResp;
 import top.charles7c.continew.starter.extension.crud.model.query.PageQuery;
 import top.charles7c.continew.starter.extension.crud.model.resp.PageResp;
 

diff --git a/...ol/service/impl/GeneratorServiceImpl.java → ...or/service/impl/GeneratorServiceImpl.java b/...ol/service/impl/GeneratorServiceImpl.java → ...or/service/impl/GeneratorServiceImpl.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.charles7c.continew.admin.tool.service.impl;
+package top.charles7c.continew.admin.generator.service.impl;
 
 import cn.hutool.core.bean.BeanUtil;
 import cn.hutool.core.collection.CollUtil;
@@ -31,18 +31,18 @@
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
-import top.charles7c.continew.admin.tool.config.properties.GeneratorProperties;
-import top.charles7c.continew.admin.tool.config.properties.GeneratorProperties.TemplateConfig;
-import top.charles7c.continew.admin.tool.enums.QueryTypeEnum;
-import top.charles7c.continew.admin.tool.mapper.FieldConfigMapper;
-import top.charles7c.continew.admin.tool.mapper.GenConfigMapper;
-import top.charles7c.continew.admin.tool.model.entity.FieldConfigDO;
-import top.charles7c.continew.admin.tool.model.entity.GenConfigDO;
-import top.charles7c.continew.admin.tool.model.query.TableQuery;
-import top.charles7c.continew.admin.tool.model.req.GenConfigReq;
-import top.charles7c.continew.admin.tool.model.resp.GeneratePreviewResp;
-import top.charles7c.continew.admin.tool.model.resp.TableResp;
-import top.charles7c.continew.admin.tool.service.GeneratorService;
+import top.charles7c.continew.admin.generator.config.properties.GeneratorProperties;
+import top.charles7c.continew.admin.generator.config.properties.GeneratorProperties.TemplateConfig;
+import top.charles7c.continew.admin.generator.enums.QueryTypeEnum;
+import top.charles7c.continew.admin.generator.mapper.FieldConfigMapper;
+import top.charles7c.continew.admin.generator.mapper.GenConfigMapper;
+import top.charles7c.continew.admin.generator.model.entity.FieldConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.GenConfigDO;
+import top.charles7c.continew.admin.generator.model.query.TableQuery;
+import top.charles7c.continew.admin.generator.model.req.GenConfigReq;
+import top.charles7c.continew.admin.generator.model.resp.GeneratePreviewResp;
+import top.charles7c.continew.admin.generator.model.resp.TableResp;
+import top.charles7c.continew.admin.generator.service.GeneratorService;
 import top.charles7c.continew.starter.core.constant.StringConstants;
 import top.charles7c.continew.starter.core.exception.BusinessException;
 import top.charles7c.continew.starter.core.util.TemplateUtils;

diff --git a/...l/src/main/resources/generator.properties → ...r/src/main/resources/generator.properties b/...l/src/main/resources/generator.properties → ...r/src/main/resources/generator.properties
@@ -1,4 +1,3 @@
-# Database type to Java type（ELADMIN）
 tinyint=Integer
 smallint=Integer
 mediumint=Integer

diff --git a/...ources/templates/generator/Controller.ftl → ...ources/templates/generator/Controller.ftl b/...ources/templates/generator/Controller.ftl → ...ources/templates/generator/Controller.ftl
diff --git a/...ources/templates/generator/DetailResp.ftl → ...ources/templates/generator/DetailResp.ftl b/...ources/templates/generator/DetailResp.ftl → ...ources/templates/generator/DetailResp.ftl
diff --git a/.../resources/templates/generator/Entity.ftl → .../resources/templates/generator/Entity.ftl b/.../resources/templates/generator/Entity.ftl → .../resources/templates/generator/Entity.ftl
diff --git a/.../resources/templates/generator/Mapper.ftl → .../resources/templates/generator/Mapper.ftl b/.../resources/templates/generator/Mapper.ftl → .../resources/templates/generator/Mapper.ftl
diff --git a/...n/resources/templates/generator/Query.ftl → ...n/resources/templates/generator/Query.ftl b/...n/resources/templates/generator/Query.ftl → ...n/resources/templates/generator/Query.ftl
diff --git a/...ain/resources/templates/generator/Req.ftl → ...ain/resources/templates/generator/Req.ftl b/...ain/resources/templates/generator/Req.ftl → ...ain/resources/templates/generator/Req.ftl
diff --git a/...in/resources/templates/generator/Resp.ftl → ...in/resources/templates/generator/Resp.ftl b/...in/resources/templates/generator/Resp.ftl → ...in/resources/templates/generator/Resp.ftl
diff --git a/...resources/templates/generator/Service.ftl → ...resources/templates/generator/Service.ftl b/...resources/templates/generator/Service.ftl → ...resources/templates/generator/Service.ftl
diff --git a/...urces/templates/generator/ServiceImpl.ftl → ...urces/templates/generator/ServiceImpl.ftl b/...urces/templates/generator/ServiceImpl.ftl → ...urces/templates/generator/ServiceImpl.ftl
diff --git a/...ain/resources/templates/generator/api.ftl → ...ain/resources/templates/generator/api.ftl b/...ain/resources/templates/generator/api.ftl → ...ain/resources/templates/generator/api.ftl
diff --git a/...n/resources/templates/generator/index.ftl → ...n/resources/templates/generator/index.ftl b/...n/resources/templates/generator/index.ftl → ...n/resources/templates/generator/index.ftl
diff --git a/continew-admin-webapi/pom.xml b/continew-admin-webapi/pom.xml
@@ -37,16 +37,16 @@
  <scope>test</scope>
  </dependency>
 
- <!-- 系统监控模块（存放系统监控模块相关功能，例如：日志管理、服务监控等） -->
+ <!-- 代码生成器插件（后续会改造为独立插件） -->
  <dependency>
  <groupId>top.charles7c.continew</groupId>
- <artifactId>continew-admin-monitor</artifactId>
+ <artifactId>continew-admin-generator</artifactId>
  </dependency>
 
- <!-- 系统工具模块（存放系统工具模块相关功能，例如：代码生成、文件管理等） -->
+ <!-- 系统监控模块（存放系统监控模块相关功能，例如：日志管理、服务监控等） -->
  <dependency>
  <groupId>top.charles7c.continew</groupId>
- <artifactId>continew-admin-tool</artifactId>
+ <artifactId>continew-admin-monitor</artifactId>
  </dependency>
  </dependencies>
 

diff --git a/...in-webapi/src/main/java/top/charles7c/continew/admin/webapi/tool/GeneratorController.java b/...in-webapi/src/main/java/top/charles7c/continew/admin/webapi/tool/GeneratorController.java
@@ -16,34 +16,30 @@
 
 package top.charles7c.continew.admin.webapi.tool;
 
-import java.sql.SQLException;
-import java.util.List;
-
-import lombok.RequiredArgsConstructor;
-
+import cn.dev33.satoken.annotation.SaCheckPermission;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.tags.Tag;
-
+import lombok.RequiredArgsConstructor;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
-
-import cn.dev33.satoken.annotation.SaCheckPermission;
-
-import top.charles7c.continew.admin.tool.model.entity.FieldConfigDO;
-import top.charles7c.continew.admin.tool.model.entity.GenConfigDO;
-import top.charles7c.continew.admin.tool.model.query.TableQuery;
-import top.charles7c.continew.admin.tool.model.req.GenConfigReq;
-import top.charles7c.continew.admin.tool.model.resp.GeneratePreviewResp;
-import top.charles7c.continew.admin.tool.model.resp.TableResp;
-import top.charles7c.continew.admin.tool.service.GeneratorService;
+import top.charles7c.continew.admin.generator.model.entity.FieldConfigDO;
+import top.charles7c.continew.admin.generator.model.entity.GenConfigDO;
+import top.charles7c.continew.admin.generator.model.query.TableQuery;
+import top.charles7c.continew.admin.generator.model.req.GenConfigReq;
+import top.charles7c.continew.admin.generator.model.resp.GeneratePreviewResp;
+import top.charles7c.continew.admin.generator.model.resp.TableResp;
+import top.charles7c.continew.admin.generator.service.GeneratorService;
 import top.charles7c.continew.starter.core.autoconfigure.project.ProjectProperties;
 import top.charles7c.continew.starter.core.util.validate.ValidationUtils;
 import top.charles7c.continew.starter.extension.crud.model.query.PageQuery;
 import top.charles7c.continew.starter.extension.crud.model.resp.PageResp;
 import top.charles7c.continew.starter.web.model.R;
 
+import java.sql.SQLException;
+import java.util.List;
+
 /**
  * 代码生成 API
  *
@@ -54,7 +50,7 @@
 @Validated
 @RestController
 @RequiredArgsConstructor
-@RequestMapping("/tool/generator")
+@RequestMapping("/generator")
 public class GeneratorController {
 
  private final ProjectProperties projectProperties;

diff --git a/continew-admin-webapi/src/main/resources/config/application.yml b/continew-admin-webapi/src/main/resources/config/application.yml
@@ -63,23 +63,21 @@ springdoc:
  default-flat-param-object: true
  # 分组配置
  group-configs:
- - group: 'all'
- paths-to-match: '/**'
- packages-to-scan: ${project.base-package}.webapi
- - group: 'auth'
- display-name: '系统认证'
+ - group: all
+ paths-to-match: /**
+ paths-to-exclude:
+ - /error
+ - group: auth
+ display-name: 系统认证
  packages-to-scan: ${project.base-package}.webapi.auth
- - group: 'common'
- display-name: '通用接口'
+ - group: common
+ display-name: 通用接口
  packages-to-scan: ${project.base-package}.webapi.common
- - group: 'system'
- display-name: '系统管理'
+ - group: system
+ display-name: 系统管理
  packages-to-scan: ${project.base-package}.webapi.system
- - group: 'tool'
- display-name: '系统工具'
- packages-to-scan: ${project.base-package}.webapi.tool
- - group: 'monitor'
- display-name: '系统监控'
+ - group: monitor
+ display-name: 系统监控
  packages-to-scan: ${project.base-package}.webapi.monitor
  ## 组件配置
  components:

diff --git a/pom.xml b/pom.xml
@@ -26,7 +26,7 @@
  <module>continew-admin-webapi</module>
  <module>continew-admin-monitor</module>
  <module>continew-admin-system</module>
- <module>continew-admin-tool</module>
+ <module>continew-admin-generator</module>
  <module>continew-admin-common</module>
  </modules>
 
@@ -45,24 +45,24 @@
  <version>${revision}</version>
  </dependency>
 
- <!-- 系统监控模块（存放系统监控模块相关功能，例如：日志管理、服务监控等） -->
+ <!-- 代码生成器插件（后续会改造为独立插件） -->
  <dependency>
  <groupId>top.charles7c.continew</groupId>
- <artifactId>continew-admin-monitor</artifactId>
+ <artifactId>continew-admin-generator</artifactId>
  <version>${revision}</version>
  </dependency>
 
- <!-- 系统管理模块（存放系统管理模块相关功能，例如：部门管理、角色管理、用户管理等） -->
+ <!-- 系统监控模块（存放系统监控模块相关功能，例如：日志管理、服务监控等） -->
  <dependency>
  <groupId>top.charles7c.continew</groupId>
- <artifactId>continew-admin-system</artifactId>
+ <artifactId>continew-admin-monitor</artifactId>
  <version>${revision}</version>
  </dependency>
 
- <!-- 系统工具模块（存放系统工具模块相关功能，例如：代码生成、文件管理等） -->
+ <!-- 系统管理模块（存放系统管理模块相关功能，例如：部门管理、角色管理、用户管理等） -->
  <dependency>
  <groupId>top.charles7c.continew</groupId>
- <artifactId>continew-admin-tool</artifactId>
+ <artifactId>continew-admin-system</artifactId>
  <version>${revision}</version>
  </dependency>