refactor: 拆分接口文档分组配置及 controller 到各自模块

2025-10-25 18:57:11 +08:00 · 2025-06-14 22:12:05 +08:00
parent f1a87b4c23
commit 93bd70dc5c
32 changed files with 257 additions and 80 deletions
--- a/continew-plugin/continew-plugin-generator/pom.xml
+++ b/continew-plugin/continew-plugin-generator/pom.xml
@@ -14,4 +14,12 @@

    <name>${project.artifactId}</name>
    <description>代码生成器插件</description>
+
+    <dependencies>
+        <!-- 系统管理模块 -->
+        <dependency>
+            <groupId>top.continew</groupId>
+            <artifactId>continew-system</artifactId>
+        </dependency>
+    </dependencies>
 </project>
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java
@@ -0,0 +1,27 @@
+package top.continew.admin.generator.config;
+
+import org.springdoc.core.models.GroupedOpenApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 代码生成配置
+ *
+ * @author Charles7c
+ * @since 2025/6/14 21:22
+ */
+@Configuration
+public class CodeConfiguration {
+
+    /**
+     * API 文档分组配置
+     */
+    @Bean
+    public GroupedOpenApi codeApi() {
+        return GroupedOpenApi.builder()
+                             .group("code")
+                             .displayName("代码生成")
+                             .pathsToMatch("/code/**")
+                             .build();
+    }
+}
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/controller/GeneratorController.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/controller/GeneratorController.java
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2022-present Charles7c 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 top.continew.admin.generator.controller;
+
+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 jakarta.servlet.http.HttpServletResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+import top.continew.admin.generator.model.entity.FieldConfigDO;
+import top.continew.admin.generator.model.entity.GenConfigDO;
+import top.continew.admin.generator.model.query.GenConfigQuery;
+import top.continew.admin.generator.model.req.GenConfigReq;
+import top.continew.admin.generator.model.resp.GeneratePreviewResp;
+import top.continew.admin.generator.service.GeneratorService;
+import top.continew.admin.system.service.DictService;
+import top.continew.starter.extension.crud.model.query.PageQuery;
+import top.continew.starter.extension.crud.model.resp.LabelValueResp;
+import top.continew.starter.extension.crud.model.resp.PageResp;
+
+import java.sql.SQLException;
+import java.util.List;
+
+/**
+ * 代码生成 API
+ *
+ * @author Charles7c
+ * @since 2023/8/3 22:58
+ */
+@Tag(name = "代码生成 API")
+@Validated
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/code/generator")
+public class GeneratorController {
+
+    private final GeneratorService baseService;
+    private final DictService dictService;
+
+    @Operation(summary = "分页查询生成配置", description = "分页查询生成配置列表")
+    @SaCheckPermission("code:generator:list")
+    @GetMapping("/config")
+    public PageResp<GenConfigDO> pageGenConfig(GenConfigQuery query, @Validated PageQuery pageQuery) {
+        return baseService.pageGenConfig(query, pageQuery);
+    }
+
+    @Operation(summary = "查询生成配置信息", description = "查询生成配置信息")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:list")
+    @GetMapping("/config/{tableName}")
+    public GenConfigDO getGenConfig(@PathVariable String tableName) throws SQLException {
+        return baseService.getGenConfig(tableName);
+    }
+
+    @Operation(summary = "查询字段配置列表", description = "查询字段配置列表")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @Parameter(name = "requireSync", description = "是否需要同步", example = "false", in = ParameterIn.QUERY)
+    @SaCheckPermission("code:generator:config")
+    @GetMapping("/field/{tableName}")
+    public List<FieldConfigDO> listFieldConfig(@PathVariable String tableName,
+                                               @RequestParam(required = false, defaultValue = "false") Boolean requireSync) {
+        return baseService.listFieldConfig(tableName, requireSync);
+    }
+
+    @Operation(summary = "保存配置信息", description = "保存配置信息")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:config")
+    @PostMapping("/config/{tableName}")
+    public void saveConfig(@Validated @RequestBody GenConfigReq req, @PathVariable String tableName) {
+        baseService.saveConfig(req, tableName);
+    }
+
+    @Operation(summary = "生成预览", description = "预览生成代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:preview")
+    @GetMapping("/preview/{tableNames}")
+    public List<GeneratePreviewResp> preview(@PathVariable List<String> tableNames) {
+        return baseService.preview(tableNames);
+    }
+
+    @Operation(summary = "生成下载代码", description = "生成下载代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:generate")
+    @PostMapping("/{tableNames}/download")
+    public void downloadCode(@PathVariable List<String> tableNames, HttpServletResponse response) {
+        baseService.downloadCode(tableNames, response);
+    }
+
+    @Operation(summary = "生成代码", description = "生成代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:generate")
+    @PostMapping("/{tableNames}")
+    public void generateCode(@PathVariable List<String> tableNames) {
+        baseService.generateCode(tableNames);
+    }
+
+    @Operation(summary = "查询字典", description = "查询字典列表")
+    @SaCheckPermission("code:generator:config")
+    @GetMapping("/dict")
+    public List<LabelValueResp> listDict() {
+        List<LabelValueResp> dictList = dictService.listDict(null, null);
+        dictList.addAll(dictService.listEnumDict());
+        return dictList;
+    }
+}