feat: 调整 archetype

2026-09-09 02:58:52 +00:00 · 2020-11-04 21:32:05 +08:00
parent 1dee2ae5f4
commit 2e45bfc1b2
23 changed files with 406 additions and 7 deletions
--- a/shoulder-generator/README.md
+++ b/shoulder-generator/README.md
@@ -1,3 +1,8 @@
 # [shoulder-generator](https://github.com/ChinaLym/Shoulder-Platform/tree/main/shoulder-generator)

 代码生成器，根据数据库表，自动生成 controller、service、entity，带有基本的增删改查、前端界面的web工程
+
+
+---
+
+只使用发布于 maven 中央仓库中的依赖，使得本应用调试简单，无需额外成本。
--- a/shoulder-generator/pom.xml
+++ b/shoulder-generator/pom.xml
@@ -12,6 +12,7 @@
    <artifactId>shoulder-generator</artifactId>
    <name>代码生成器</name>
    <description>代码生成器</description>
+
    <dependencies>

        <dependency>
--- a/shoulder-generator/src/main/java/cn/itlym/shoulder/generator/model/TableEntity.java
+++ b/shoulder-generator/src/main/java/cn/itlym/shoulder/generator/model/TableEntity.java
@@ -30,6 +30,11 @@ public class TableEntity {
     */
    private boolean checkAuth;

+    /**
+     * Controller 中生成异步批量操作接口。
+     */
+    private boolean asyncBatch;
+
    /**
     * 表类型：
     * TREE(parent_id), CREATOR, MODIFIER, CREATOR_TIME, UPDATE_TIME, BATCH
--- a/shoulder-generator/src/main/resources/template/Api.java.vm
+++ b/shoulder-generator/src/main/resources/template/Api.java.vm
@@ -0,0 +1,181 @@
+package ${package}.${pkgName}.controller;
+
+import java.util.Map;
+
+import io.swagger.annotations.Api;
+import org.apache.commons.collections4.CollectionUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.*;
+#if(${checkAuth})
+import org.springframework.security.access.prepost.PreAuthorize;
+#end
+import org.shoulder.core.dto.response.PageResult;
+import org.shoulder.core.dto.response.RestResult;
+
+import ${package}.${pkgName}.convert.${className}Converter;
+import ${package}.${pkgName}.dto.${className}DTO;
+import ${package}.${pkgName}.model.${className};
+import ${package}.${pkgName}.service.${className}Service;
+
+/**
+ * ${comments} 控制器
+ *
+ * @author ${author}
+ * @date ${datetime}
+ */
+@RestController
+@RequestMapping("${pathName}")
+@Api(tags = "${comments}")
+public interface ${className}Controller {
+
+    /**
+     * 条件查询，分页
+     * @param condition 查询条件
+     * @return 分页结果
+     */
+    @RequestMapping("list")
+#if(${checkAuth})
+    @PreAuthorize("hasAnyAuthority('${tableName}:${pathName}:list')")
+#end
+    public PageResult list(@RequestParam Map<String, Object> condition);
+
+
+    /**
+     * 保存单个，推荐使用幂等的 PUT 方法，体现接口幂等性。为了方便习惯，也开放了 POST
+     *
+     * @param ${lowClassName}DTO 新增数据
+     * @return 保存成功
+     */
+    @RequestMapping(value = "save", method = {RequestMethod.PUT, RequestMethod.POST})
+#if(${checkAuth})
+    @PreAuthorize("hasAnyAuthority('resource:sysroleuser:save')")
+#end
+    public RestResult save(@RequestBody ${className}DTO ${lowClassName}DTO);
+
+    /**
+     * 单个修改
+     *
+     * @param ${lowClassName}DTO 修改属性
+     * @return 修改成功
+     */
+    @PostMapping("update")
+#if(${checkAuth})
+    @PreAuthorize("hasAnyAuthority('resource:sysroleuser:update')")
+#end
+    public RestResult update(@RequestBody ${className}DTO ${lowClassName}DTO);
+
+    /**
+     * 根据 id 删除单个
+     *
+     * @param ${pk.attributeName} id
+     * @return 删除成功
+     */
+    @RequestMapping(value = "delete/{id}", method = {RequestMethod.DELETE, RequestMethod.POST})
+#if(${checkAuth})
+    @PreAuthorize("hasAnyAuthority('resource:sysroleuser:delete')")
+#end
+    public RestResult delete(@PathVariable Long ${pk.attributeName});
+
+    /**
+     * 根据 id 批量删除
+     *
+     * @param idList ids
+     * @return 删除成功
+     */
+    @RequestMapping(value = "delete", method = {RequestMethod.DELETE, RequestMethod.POST})
+#if(${checkAuth})
+    @PreAuthorize("hasAnyAuthority('resource:sysroleuser:delete')")
+#end
+    public RestResult delete(List<Long> idList);
+
+
+#if(${asyncBatch})
+    // ======================== 异步批量操作 ============================
+
+    /**
+     * 批量新增 ${comments} - 校验
+     *
+     * @param addDtoList 要批量添加的数据
+     * @return 校验任务标识
+     **/
+    @ApiOperation(value = "批量新增 ${comments} - 校验", notes = "批量新增 ${comments} - 校验")
+    @PostMapping("validateAdd")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "body", required = true, name = "addDtoList", dataType = "list",
+                    value = "${comments}列表", example = "[{\"id\":\"12345\",\"name\":\"foo\"}]"),
+    })
+    RestResult<String> validateAdd(@RequestBody List<${className}DTO> addDtoList);
+
+    /**
+     * 批量修改 ${comments} - 校验
+     *
+     * @param updatedDtoList 要批量修改的数据
+     * @return 校验任务标识
+     **/
+    @ApiOperation(value = "批量修改 ${comments} - 校验", notes = "批量修改 ${comments} - 校验")
+    @PostMapping("validateUpdate")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "body", required = true, name = "updatedDtoList", dataType = "list",
+                    value = "${comments}列表", example = "[{\"id\":\"12345\",\"name\":\"foo\"}]"),
+
+    })
+    RestResult<String> validateUpdate(@RequestBody List<${className}DTO> updatedDtoList);
+
+
+    /**
+     * 查询批量校验进度 todo 框架提供
+     *
+     * @param progressParam 异步任务标识
+     * @return 校验进度
+     **/
+    @ApiOperation(value = "查询批量校验进度", notes = "根据批量校验接口返回的异步任务标识查询校验进度")
+    @PostMapping("validateProgress")
+    @ApiImplicitParam(paramType = "query", required = true, name = "clientId", dataType = "String",
+            value = "批量校验标识", example = "50c77859-a670-47a8-a666-fff12816d832")
+    RestResult<ImportProcessDTO> batchValidateProgress(@RequestBody ProgressParam progressParam);
+
+    /**
+     * 批量添加
+     *
+     * 根据 taskId 从缓存中取出对应的校验通过数据执行添加
+     *
+     * @param batchAddOperationParam 批量添加操作参数
+     * @return 异步任务标识
+     **/
+    @ApiOperation(value = "批量添加 ${comments}", notes = "根据 异步任务标识 从缓存中取出对应的校验通过数据执行批量添加")
+    @PostMapping("addBatch")
+    RestResult<Object> addBatch(@RequestBody BatchAddOperationParam batchAddOperationParam) throws Exception;
+
+    /**
+     * 批量更新
+     *
+     * 根据 taskId 从缓存中取出对应的校验通过数据执行更新
+     *
+     * @param batchAddOperationParam 批量更新操作参数
+     * @return 异步任务标识
+     **/
+    @ApiOperation(value = "批量更新 ${comments}", notes = "根据 异步任务标识 从缓存中取出对应的校验通过数据执行批量更新")
+    @PostMapping("updateBatch")
+    @ApiImplicitParam(paramType = "body", required = true, name = "deviceBatchManageDto", dataType =
+            "DeviceBatchManageDto", value = "批量修改DTO",
+            example = "{\"taskId\":\"716acbae-f407-43ed-bbac-c36dd7df7094\"}")
+    RestResult<Object> updateBatch(@RequestBody BatchAddOperationParam batchAddOperationParam) throws Exception;
+
+
+    /**
+     * 查询批量操作进度 todo 框架提供
+     *
+     * @param progressParam 异步任务标识
+     * @return 执行结果
+     **/
+    @ApiOperation(value = "查询批量操作进度", notes = "根据批量操作接口返回的异步任务标识查询操作进度")
+    @PostMapping("operationProgress")
+    @ApiImplicitParam(paramType = "query", required = true, name = "clientId", dataType = "String",
+            value = "批量操作标识", example = "649b545c-0edd-425b-b6b6-e1bc9ba6583f")
+    RestResult<ImportProcessResult> batchOperationProgress(@RequestBody ProgressParam progressParam)
+            throws Exception;
+#end
+
+
+
+}
--- a/shoulder-generator/src/main/resources/template/Controller.java.vm
+++ b/shoulder-generator/src/main/resources/template/Controller.java.vm
@@ -18,7 +18,7 @@ import ${package}.${pkgName}.model.${className};
 import ${package}.${pkgName}.service.${className}Service;

 /**
- * ${comments}
+ * ${comments} 控制器
 *
 * @author ${author}
 * @date ${datetime}
@@ -112,4 +112,61 @@ public class ${className}Controller {
        return RestResult.success();
    }

+
+
+
+    /**
+     * 批量新增 ${comments} - 校验
+     *
+     * @param deviceList
+     * @return ControllerResultDTO<java.lang.String>
+     **/
+    @ApiOperation(value = "校验批量新增设备", notes = "校验批量新增设备")
+    @PostMapping("service/rs/v1/deviceService/validateImpDeviceData")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "body", required = true, name = "deviceList", dataType = "list", value =
+                    "设备集合", example = "[{\"driver\":\"23123123\",\"name\":\"报警设备\"}]"),
+    })
+    ControllerResultDTO<String> validateImpDeviceData(@RequestBody List<Map<String, String>> deviceList);
+
+    /**
+     * 校验批量修改设备
+     *
+     * @param deviceList
+     * @return ControllerResultDTO<java.lang.String>
+     **/
+    @ApiOperation(value = "校验批量修改设备", notes = "校验批量修改设备")
+    @PostMapping("service/rs/v1/deviceService/validateUpdateDeviceData")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "body", required = true, name = "deviceList", dataType = "list", value =
+                    "设备集合", example = "[{\"driver\":\"23123123\",\"name\":\"报警设备\"}]"),
+
+    })
+    ControllerResultDTO<String> validateUpdateDeviceData(@RequestBody List<Map<String, String>> deviceList);
+
+    /**
+     * 设备批量添加
+     *
+     * @param deviceBatchManageDto
+     * @return ControllerResultDTO<java.lang.Object>
+     **/
+    @ApiOperation(value = "设备批量添加", notes = "批量添加同一资源类型的设备，异步获取该批设备的设备和通道信息。")
+    @PostMapping("service/rs/v1/deviceService/addBatch")
+    ControllerResultDTO<Object> addBatch(@RequestBody DeviceBatchManageDto deviceBatchManageDto);
+
+    /**
+     * 设备批量更新
+     *
+     * @param deviceBatchManageDto
+     * @return ControllerResultDTO<java.lang.Object>
+     **/
+    @ApiOperation(value = "设备批量更新", notes = "批量更新设备信息")
+    @PostMapping("service/rs/v1/deviceService/updateBatch")
+    @ApiImplicitParams({
+            @ApiImplicitParam(paramType = "body", required = true, name = "deviceBatchManageDto", dataType =
+                    "DeviceBatchManageDto", value = "批量修改设备DTO", example = ""),
+    })
+    ControllerResultDTO<Object> updateBatch(@RequestBody DeviceBatchManageDto deviceBatchManageDto) throws Exception;
+
+
 }