net.sohelp.boot.dev.web.code

类 CodeConfigController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.dev.web.code.CodeConfigController

@RestController(value="dev-code-configuration")
 @RequestMapping(value="/dev/code/config")
public class CodeConfigController
extends BaseController

基本开发配置控制器 提供代码开发相关的基础配置管理功能，包括资源导出、导入、保存及初始化等操作。

从以下版本开始:

2024/5/22 17:54

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器和说明
CodeConfigController()

方法概要

限定符和类型	方法和说明
ApiResult<?>	exportResource() 导出系统资源配置文件并打包成ZIP格式进行下载 此方法会将指定路径下的所有资源配置文件导出到临时目录，并压缩为ZIP文件后提供下载， 下载完成后自动清理生成的临时文件和压缩包。
ApiResult<com.alibaba.fastjson.JSONObject>	getConfig() 获取已保存的开发配置信息 从指定路径加载配置文件并解析为JSON对象返回给前端使用。
ApiResult<EntityVO>	importResource(Map<String,Object> paramMap) 导入外部资源配置信息 接收客户端上传的资源数据，并将其持久化存储至系统中。
ApiResult<EntityVO>	initial(Map<String,Object> paramMap) 初始化开发环境配置 清除与数据库实体相关的表单、网格以及Java模型定义文件，并删除现有配置文件， 实现重置开发环境的目的。
ApiResult<EntityVO>	save(Map<String,Object> paramMap) 保存当前开发相关配置信息 将传入的配置参数以JSON格式保存至指定路径下。

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CodeConfigController

public CodeConfigController()

方法详细资料

exportResource

@GetMapping(value="/exportResource")
 @Permission(value="ADMIN")
public ApiResult<?> exportResource()
                                                                                               throws SQLException,
                                                                                                      IOException

导出系统资源配置文件并打包成ZIP格式进行下载

此方法会将指定路径下的所有资源配置文件导出到临时目录，并压缩为ZIP文件后提供下载， 下载完成后自动清理生成的临时文件和压缩包。

返回:

返回空结果对象（ApiResult），实际通过响应流输出ZIP文件内容

抛出:

SQLException - 数据库访问异常时抛出

IOException - 文件读写异常时抛出

importResource

@PostMapping(value="/importResource")
 @Permission(value="ADMIN")
public ApiResult<EntityVO> importResource(@RequestBody
                                                                                                              Map<String,Object> paramMap)
                                                                                                       throws SQLException

导入外部资源配置信息

接收客户端上传的资源数据，并将其持久化存储至系统中。

参数:

paramMap - 包含待导入资源配置的数据映射

返回:

成功提示信息封装在ApiResult中返回

抛出:

SQLException - 数据库访问异常时抛出

save

@PostMapping(value="/saveConfig")
 @Permission(value="ADMIN")
public ApiResult<EntityVO> save(@RequestBody
                                                                                                Map<String,Object> paramMap)
                                                                                         throws SQLException,
                                                                                                BusiException

保存当前开发相关配置信息

将传入的配置参数以JSON格式保存至指定路径下。

参数:

paramMap - 配置参数键值对集合

返回:

操作成功的提示信息

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务逻辑错误时抛出

getConfig

@GetMapping(value="/getConfig")
 @Permission(value="ADMIN")
public ApiResult<com.alibaba.fastjson.JSONObject> getConfig()
                                                                                                                   throws BusiException

获取已保存的开发配置信息

从指定路径加载配置文件并解析为JSON对象返回给前端使用。

返回:

当前系统的开发配置信息

抛出:

BusiException - 业务逻辑错误或文件不存在时抛出

initial

@PostMapping(value="/initial")
 @Permission(value="ADMIN")
public ApiResult<EntityVO> initial(@RequestBody
                                                                                                Map<String,Object> paramMap)
                                                                                         throws SQLException,
                                                                                                BusiException

初始化开发环境配置

清除与数据库实体相关的表单、网格以及Java模型定义文件，并删除现有配置文件， 实现重置开发环境的目的。

参数:

paramMap - 请求参数映射（预留扩展用途）

返回:

初始化完成的成功提示信息

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务处理过程中发生错误时抛出