net.sohelp.boot.dev.web.code

类 CodeSchemeController

java.lang.Object

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

net.sohelp.boot.dev.web.code.CodeSchemeController

@RestController(value="dev-code-scheme")
 @RequestMapping(value="/dev/code/scheme")
public class CodeSchemeController
extends BaseController

方案管理控制器，提供代码方案的增删改查功能。

从以下版本开始:

2024/5/29 10:41

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
CodeSchemeController()

方法概要

限定符和类型	方法和说明
ApiResult<?>	delete(Map<String,Object> dataMap) 删除指定名称的代码方案文件。
ApiResult<?>	detail(String path) 根据指定路径获取单个代码方案详细信息。
ApiResult<?>	list(Map<String,Object> paramMap) 获取所有启用状态下的代码方案列表。
ApiResult<Pager<com.alibaba.fastjson.JSONObject>>	page(Map<String,Object> paramMap) 分页查询所有代码方案，并统计每个方案中的模板数量。
ApiResult<?>	save(Map<String,Object> paramMap) 保存模板配置信息。

从类继承的方法 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

构造器详细资料

CodeSchemeController

public CodeSchemeController()

方法详细资料

save

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

保存模板配置信息。如果该路径下不存在文件则新增，否则更新已有数据。

参数:

paramMap - 包含方案名称等参数的映射表

返回:

返回操作结果提示信息（创建或更新成功）

抛出:

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

BusiException - 业务逻辑异常时抛出

list

@GetMapping(value="/list")
 @Permission(value="ADMIN")
public ApiResult<?> list(@RequestParam
                                                                                  Map<String,Object> paramMap)
                                                                           throws SQLException

获取所有启用状态下的代码方案列表。

参数:

paramMap - 请求参数映射表（未使用）

返回:

返回符合条件的所有代码方案对象集合

抛出:

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

detail

@GetMapping(value="/detail")
 @Permission(value="ADMIN")
public ApiResult<?> detail(@RequestParam
                                                                                      String path)
                                                                               throws SQLException,
                                                                                      BusiException

根据指定路径获取单个代码方案详细信息。

参数:

path - 文件路径

返回:

返回对应的方案详情数据

抛出:

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

BusiException - 业务逻辑异常时抛出

page

@GetMapping(value="/page")
 @Permission(value="ADMIN")
public ApiResult<Pager<com.alibaba.fastjson.JSONObject>> page(@RequestParam
                                                                                                                       Map<String,Object> paramMap)
                                                                                                                throws SQLException

分页查询所有代码方案，并统计每个方案中的模板数量。

参数:

paramMap - 请求参数，包括分页信息(page, limit)

返回:

返回分页后的代码方案数据及总记录数

抛出:

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

delete

@PostMapping(value="/delete")
 @Permission(value="ADMIN")
public ApiResult<?> delete(@RequestBody
                                                                                       Map<String,Object> dataMap)
                                                                                throws SQLException,
                                                                                       BusiException

删除指定名称的代码方案文件。

参数:

dataMap - 请求体参数，包含要删除的方案名称

返回:

操作成功的响应消息

抛出:

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

BusiException - 业务逻辑异常时抛出